Consultar as Assinaturas de uma Solicitação

Retorna todas as assinaturas associadas a uma solicitação específica.

Este endpoint permite recuperar informações completas sobre cada assinatura coletada, incluindo:

  • Status da assinatura

  • Dados do assinante

  • Informações técnicas da coleta (IP, user agent)

  • Datas de criação, atualização e conclusão

  • Link de coleta da assinatura


Descrição

Este endpoint permite consultar todas as assinaturas vinculadas a uma solicitação específica, identificada pelo application_id.

A operação é exclusivamente de consulta (GET) e não altera o estado das assinaturas ou da solicitação.


Método HTTP

GET


URL

https://sandbox.api.seudominio.com/applications/{application_id}/signatures

Path Parameters

NomeTipoObrigatórioDescrição
application_idstring (UUID v4)SimIdentificador único da solicitação para a qual as assinaturas foram coletadas. Utilizado para localizar todas as assinaturas vinculadas à solicitação informada.

Headers

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação no formato Bearer {token}. Responsável por autenticar e autorizar o acesso ao endpoint.
Content-TypestringSimDeve ser informado como application/json.

Body Parameters

Este endpoint não possui corpo de requisição, pois se trata de uma operação de consulta (GET).


Exemplo de Requisição

GET /applications/c47ea1c9-0f67-429f-a1b7-ace6f6bea704/signatures
Authorization: Bearer {token}
Content-Type: application/json

Resposta de Sucesso

Status: 200 OK

Retorna um array contendo todas as assinaturas associadas à solicitação informada.

Cada item do array representa uma assinatura coletada.


Estrutura do Objeto de Resposta

Assinatura (Signature)

CampoTipoDescrição
idstring (UUID v4)Identificador único da assinatura.
ip_addressstringEndereço IP do cliente no momento da assinatura.
user_agentstringInformações do navegador, dispositivo e versão utilizados no momento da assinatura. Pode não estar disponível dependendo do fluxo de coleta.
signed_atdatetimeData e hora em que a assinatura foi efetivamente realizada. Permanece nulo enquanto a assinatura não for concluída.
collect_sign_linkstringLink utilizado para a coleta da assinatura.
created_atdatetimeData e hora de criação do registro da assinatura.
updated_atdatetimeData e hora da última atualização da assinatura.
versionintegerNúmero da versão da assinatura, incrementado sempre que há alterações.
personobjectDados da pessoa que realizou a assinatura.

Pessoa (person)

CampoTipoDescrição
idstring (UUID v4)Identificador único da pessoa.
full_namestringNome completo da pessoa.
taxpayer_idstringCPF ou CNPJ da pessoa.

Exemplo de Resposta (Modelo)

[
  {
    "id": "<uuid>",
    "ip_address": "<string>",
    "user_agent": "<string>",
    "signed_at": "<dateTime>",
    "person": {
      "id": "<uuid>",
      "full_name": "<string>",
      "taxpayer_id": "<string>"
    },
    "collect_sign_link": "<string>",
    "created_at": "<dateTime>",
    "updated_at": "<dateTime>",
    "version": "<integer>"
  }
]

Exemplo de Resposta (Real)

[
  {
    "id": "373f0c92-802d-45b2-897d-a7e079985d71",
    "ip_address": "18.229.22.249",
    "user_agent": null,
    "signed_at": null,
    "person": {
      "id": "e42a304d-6640-42e6-8634-27414f48258d",
      "full_name": "Carlos Eduardo Moreira Silva",
      "taxpayer_id": "11144477735"
    },
    "collect_sign_link": "https://sandbox.clicksign.com/notarial/widget/signatures/7a518b1e-150c-4b05-bd13-02291485ec8b/redirect",
    "created_at": "2026-01-20T00:46:36.09563Z",
    "updated_at": "2026-01-20T00:46:46.48309Z",
    "version": 1,
    "external_id": "7a518b1e-150c-4b05-bd13-02291485ec8b"
  }
]

Códigos de Erro Possíveis

HTTP StatusCódigoDescrição
400Bad RequestParâmetro application_id inválido.
401UnauthorizedCredenciais inválidas ou não informadas.
403ForbiddenAcesso não permitido ao recurso.
404Not FoundSolicitação não encontrada.
500Internal Server ErrorErro inesperado no servidor.
Language
URL
Click Try It! to start a request and see the response here!