Skip to main content
GET
/
api
/
signature-processes
Listar processos
curl --request GET \
  --url https://api-hml.valid.com/api/signature-processes \
  --header 'x-api-key: <api-key>'
{
  "signature_processes": [
    {
      "uuid": "8e3b2e50-8b9a-4d7a-9b8c-1e2f3a4b5c6d",
      "code": "PRC-2023-001",
      "title": "Contrato de Prestação de Serviços",
      "type": 1,
      "state": 1,
      "created_at": "2023-10-15T14:30:00Z",
      "updated_at": "2023-10-15T14:35:00Z"
    }
  ]
}

Parâmetros de Query

title
string
Nome do envelope (processo). Exemplo: Contrato
code
string
Código do processo. Exemplo: PRC-2023-001
type
integer
Tipo do processo. Exemplo: 1
signer_code
string
Código do signatário. Exemplo: SIG001
signer_name
string
Nome do signatário. Exemplo: Maria Silva
signer_email
string
Email do signatário. Exemplo: [email protected]
signer_identifier
string
CPF/CNPJ do signatário. Exemplo: 12345678900

Resposta

signature_processes
array
{
  "signature_processes": [
    {
      "uuid": "8e3b2e50-8b9a-4d7a-9b8c-1e2f3a4b5c6d",
      "code": "PRC-2023-001",
      "title": "Contrato de Prestação de Serviços",
      "type": 1,
      "state": 1,
      "created_at": "2023-10-15T14:30:00Z",
      "updated_at": "2023-10-15T14:35:00Z"
    }
  ]
}