Pular para conteúdo

📘 Consultando Processos de Assinatura


Esta seção descreve duas maneiras de consultar as informações de sum processo existente, sendo elas: listando todos os processos ou consultando os detalhes através do uid.

Importante

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


GET /api/v1/process/

Headers

Name Type Descrição
Authorization *        String Token API a frente da palavra Token.

Path Parameters

Name Type Descrição
uid *        String UID do Processo que deseja consultar

📥 HTTP 200 Consulta realizada com sucesso!

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "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"
        }
    ]
}

GET /api/v1/process/{{uid}}

Headers

Name Type Descrição
Authorization *        String Token API a frente da palavra Token.

Path Parameters

Name Type Descrição
uid *        String UID do Processo que deseja consultar

📥 HTTP 200 Consulta realizada com sucesso!

{
    "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": "ID-001",
    "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"
}

Utilização de Filtros

Atualmente é possível utilizar 03 (três) filtros: process_status, deadline e per_page. Basta passá-los diretamente na URL, como o exemplo a seguir: /v1/process/?per_page=2&process_status=FINISHED.