Pular para conteúdo

📘 Criando um signatário

Esta seção descreve como adicionar um signatário à uma Processo de Assinatura existente.

Importante

Está ação só é permitida caso nenhum signatário tenha assinado o documento.

POST /api/v1/signer/

Headers

Name Type Descrição
Authorization *        String Você deve enviar seu Token API no Header, a frente da palavra Token.

Atenção

Caso tenha dúvidas sobre como enviar seu Token de API através do Header, consulte a sessão Primeiros Passos.

Parameters

Name Type Descrição
full_name *        String Identificação do Processo. Ex.: CONTRATO DE LOCAÇÃO nº. 0001
email *        String Data Limite de Assinatura YYYY-MM-DD hh:mm:ss. Ex.: 2025-05-30 10:00:00
cpf *        String Documento que será assinado. URL Pública do arquivo PDF (Max. 10MB)
phone_number *        String Identificação do Processo na SUA aplicação. Valor Padrão: None.
auth_type *        Array Pessoas que assinarão do documento. Uma lista de objetos do tipo Signer.
signer_type *        Array Pessoas que assinarão do documento. Uma lista de objetos do tipo Signer.
send_type *        Array Pessoas que assinarão do documento. Uma lista de objetos do tipo Signer.
country_code *        Array Pessoas que assinarão do documento. Uma lista de objetos do tipo Signer.
external_id *        String Identificação do Processo na SUA aplicação. Valor Padrão: None.

📥 HTTP 201 Signatário criado com sucesso!

{
    "uid": "ebf42454-473b-4a4a-9cb6-163a9886737e",
    "external_id": "",
    "signature_process": "7728e370-43ca-4c0f-80fb-1598d6d17679",
    "full_name": "JOÃO DE SOUZA",
    "email": "joaosouza@email.com",
    "cpf": "111.456.789-10",
    "phone_number": "(33) 90000-0000",
    "country_code": "+55",
    "auth_type": "EMAIL",
    "signer_type": "Contratante",
    "signature_status": "PENDING",
    "send_type": "EMAIL",
    "created_at": "2025-05-20T06:29:51.276328-03:00",
    "updated_at": "2025-05-20T06:29:51.276369-03:00"
}