Pular para conteúdo

📘 Criando um Processo de Assinatura


Esta seção descreve como criar um Processo de Assinatura utilizando nossa API. As informações necessárias no POST estarão descritas em Headers e Parameters, além disso, é fornecida uma resposta de exemplo para ser usadas em testes.

Importante

Todas as informações deverão ser enviadas no formato JSON e as respostas serão retornadas nesse mesmo formato.


POST /api/v1/process

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
name *        String Identificação do Processo. Ex.: CONTRATO DE LOCAÇÃO nº. 0001
deadline *        String Data Limite de Assinatura YYYY-MM-DD hh:mm:ss. Ex.: 2025-05-30 10:00:00
file *        String Documento que será assinado. URL Pública do arquivo PDF (Max. 10MB)
external_id *        String Identificação do Processo na SUA aplicação. Valor Padrão: None.
signers *        Array Pessoas que assinarão do documento. Uma lista de objetos do tipo Signer.

📥 HTTP 201 Processo criado com sucesso!

{
    "message": "Signing process successfully created!",
    "signature_process": {
        "uid": "c7adf5ed-dc70-4216-bbd8-8cbad209bf63",
        "name": "CONTRATO N.º 001/2025",
        "file": "autosign.local:8000/uploads/2025/08300251626/c7adf5ed-dc70-4216-bbd8-8cbad209bf63/ARQUIVO_TESTE.pdf",
        "final_file": null,
        "deadline": "2025-05-20T14:47:27.753250-03:00",
        "process_status": "PENDING",
        "external_id": null,
        "signers": [
            {
                "uid": "0c58afe7-fa3b-46b5-b8e7-1a8520f9b784",
                "external_id": "123.456.789.10",
                "signature_process": "c7adf5ed-dc70-4216-bbd8-8cbad209bf63",
                "full_name": "João da Silva",
                "email": "joao@email.com",
                "cpf": "123.456.789.10",
                "phone_number": "(33) 91234-5678",
                "country_code": "+55",
                "auth_type": "EMAIL",
                "signer_type": "Contratante",
                "signature_status": "PENDING",
                "send_type": "EMAIL",
                "created_at": "2025-05-17T14:47:27.794275-03:00",
                "updated_at": "2025-05-17T14:47:27.794305-03:00"
            }
        ],
        "created_at": "2025-05-17T14:47:27.756323-03:00",
        "updated_at": "2025-05-17T14:47:27.756344-03:00"
    }
}