Primeiros Passos
Onboarding
Background Check
Liveness
API
Criar novo processo
Cria um processo de assinatura com arquivos e signatários.
POST
/
api
/
signature-processes
Criar novo processo
Copy
Ask AI
curl --request POST \
--url https://api-hml.valid.com/api/signature-processes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"code": "<string>",
"process_files": [
{
"code": "<string>",
"filename": "<string>",
"extension": "<string>",
"mime": "<string>",
"type": 123,
"content": "<string>",
"hash": "<string>",
"size": 123
}
],
"signers": [
{
"code": "<string>",
"name": "<string>",
"email": "<string>",
"identifier": "<string>",
"restrict": true,
"phone_country_code": "<string>",
"phone_number": "<string>",
"birth_date": "<string>",
"qualification": "<string>",
"token_type": 123,
"files": [
{}
]
}
],
"options": {
"auto_init": true,
"send_init_emails": true,
"url_origin": "<string>",
"url_notification": "<string>",
"period_renotify": 123,
"max_renotify": 123,
"due_date": "<string>"
},
"settings": [
{}
]
}
'Copy
Ask AI
{
"message": "Processo de assinatura inserido com sucesso.",
"uuid": "8e3b2e50-8b9a-4d7a-9b8c-1e2f3a4b5c6d",
"code": "PRC-2023-001",
"signers": [
{
"code": "SIG-001",
"uuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"url": "https://validsigner.com.br/signature/Token/uuid"
}
],
"files": [
{
"code": "DOC-001",
"uuid": "5e6f7a8b-9c0d-1a2b-3c4d-1e2f3a4b5c6d",
"filename": "documento.pdf",
"type": 1
}
]
}
Body
Título do processo de assinatura. Exemplo:
Contrato de prestação de serviçosCódigo único do processo. Exemplo:
PRC-001Lista de arquivos a serem assinados.
Show Propriedades do Arquivo
Show Propriedades do Arquivo
Código do arquivo. Exemplo:
ARQ001Nome do arquivo (com extensão). Exemplo:
documento.pdfExtensão do arquivo (ex: pdf). Exemplo:
pdfTipo MIME (ex: application/pdf). Exemplo:
application/pdfTipo do arquivo. Exemplo:
1Conteúdo do arquivo em Base64. Exemplo:
base64_pdf_aquiHash do arquivo. Exemplo:
a1b2c3Tamanho em bytes. Exemplo:
204800Lista de signatários do processo.
Show Propriedades do Signatário
Show Propriedades do Signatário
Código do signatário. Exemplo:
SIG001Nome completo. Exemplo:
Maria SilvaEndereço de e-mail. Exemplo:
[email protected]CPF ou CNPJ. Exemplo:
12345678900Se verdadeiro, restringe o acesso. Exemplo:
trueCódigo do país do telefone. Exemplo:
55Número de telefone. Exemplo:
11999999999Data de nascimento (AAAA-MM-DD). Exemplo:
1980-01-01Qualificação (ex: Diretor). Exemplo:
DiretoraTipo de token. Exemplo:
1Lista de códigos (code) dos arquivos que este signatário deve assinar.
Exemplo:
["ARQ001"]Opções adicionais de configuração.
Show Opções
Show Opções
Se true, inicia o processo automaticamente após criar. Exemplo:
trueSe true, envia e-mails iniciais aos signatários. Exemplo:
trueURL de origem. Exemplo:
https://cliente.com.brWebhook para notificações de status. Exemplo:
https://cliente.com.br/webhookPeríodo para notificar novamente. Exemplo:
3Número de vezes a notificar. Exemplo:
5Data de vencimento do processo. Exemplo:
2025-06-01Lista de configurações (strings). Exemplo:
["process-validate-token-sign"]Resposta
Mensagem de sucesso.
UUID do processo criado.
Código do processo.
Copy
Ask AI
{
"message": "Processo de assinatura inserido com sucesso.",
"uuid": "8e3b2e50-8b9a-4d7a-9b8c-1e2f3a4b5c6d",
"code": "PRC-2023-001",
"signers": [
{
"code": "SIG-001",
"uuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"url": "https://validsigner.com.br/signature/Token/uuid"
}
],
"files": [
{
"code": "DOC-001",
"uuid": "5e6f7a8b-9c0d-1a2b-3c4d-1e2f3a4b5c6d",
"filename": "documento.pdf",
"type": 1
}
]
}
Previous
Obter detalhes do processoRetorna os detalhes de um processo de assinatura incluindo signatários e arquivos relacionados.
Next
⌘I
Criar novo processo
Copy
Ask AI
curl --request POST \
--url https://api-hml.valid.com/api/signature-processes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"code": "<string>",
"process_files": [
{
"code": "<string>",
"filename": "<string>",
"extension": "<string>",
"mime": "<string>",
"type": 123,
"content": "<string>",
"hash": "<string>",
"size": 123
}
],
"signers": [
{
"code": "<string>",
"name": "<string>",
"email": "<string>",
"identifier": "<string>",
"restrict": true,
"phone_country_code": "<string>",
"phone_number": "<string>",
"birth_date": "<string>",
"qualification": "<string>",
"token_type": 123,
"files": [
{}
]
}
],
"options": {
"auto_init": true,
"send_init_emails": true,
"url_origin": "<string>",
"url_notification": "<string>",
"period_renotify": 123,
"max_renotify": 123,
"due_date": "<string>"
},
"settings": [
{}
]
}
'Copy
Ask AI
{
"message": "Processo de assinatura inserido com sucesso.",
"uuid": "8e3b2e50-8b9a-4d7a-9b8c-1e2f3a4b5c6d",
"code": "PRC-2023-001",
"signers": [
{
"code": "SIG-001",
"uuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"url": "https://validsigner.com.br/signature/Token/uuid"
}
],
"files": [
{
"code": "DOC-001",
"uuid": "5e6f7a8b-9c0d-1a2b-3c4d-1e2f3a4b5c6d",
"filename": "documento.pdf",
"type": 1
}
]
}