Skip to main content
POST
/
api
/
signature-processes
/
{signature_process}
/
signers
Adicionar signatário
curl --request POST \
  --url https://api-hml.valid.com/api/signature-processes/{signature_process}/signers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "code": "<string>",
  "identifier": "<string>",
  "qualification": "<string>",
  "signature_process_type_id": 123,
  "phone_country_code": "<string>",
  "phone_number": "<string>",
  "birth_date": "<string>",
  "token_type": 123,
  "files_uuids": [
    {}
  ],
  "options": {}
}
'
{
  "message": "Signatário inserido com sucesso.",
  "code": "SIGN001",
  "uuid": "d7d3ac84-1234-4bbb-bbbb-abcdefabcdef"
}

​
Path Parameters

​
signature_process
string
required
UUID do processo de assinatura. Exemplo: e7d4f2aa-34bc-4321-ae11-123456789abc

​
Body Parameters

​
name
string
required
Nome do signatário. Exemplo: João da Silva
​
email
string
required
E-mail do signatário. Exemplo: joao@example.com
​
code
string
Código interno do signatário. Exemplo: SIGN001
​
identifier
string
CPF do signatário. Exemplo: 12345678909
​
qualification
string
Qualificação (ex: Cargo). Exemplo: Advogado
​
signature_process_type_id
integer
Tipo de assinatura: 1 (Digital), 2 (Eletrônico), 3 (Híbrido). Exemplo: 1
​
phone_country_code
string
DDI do telefone. Exemplo: 55
​
phone_number
string
Número do telefone. Exemplo: 11999999999
​
birth_date
string
Data de nascimento (YYYY-MM-DD). Exemplo: 1990-01-01
​
token_type
integer
Tipo de token. Exemplo: 1
​
files_uuids
array
Lista de UUIDs dos arquivos que o signatário deve assinar.
​
options
object
Opções adicionais.

​
Response

​
message
string
Mensagem de sucesso. Exemplo: Signatário inserido com sucesso.
​
code
string
Código do signatário. Exemplo: SIGN001
​
uuid
string
UUID do signatário criado. Exemplo: d7d3ac84-1234-4bbb-bbbb-abcdefabcdef
{
  "message": "Signatário inserido com sucesso.",
  "code": "SIGN001",
  "uuid": "d7d3ac84-1234-4bbb-bbbb-abcdefabcdef"
}