Pular para o conteúdo principal

Detalhar Signatario

Retorna as informacoes completas de um signatario e do documento associado. Este e um endpoint publico -- nao requer autenticacao, pois e acessado diretamente pelo signatario atraves do link de assinatura.

Endpoint

GET /v1/signing/{token}
Endpoint publico

Este endpoint nao exige o header Authorization. O token na URL ja identifica o signatario de forma segura.

Parametros de URL

ParametroTipoObrigatorioDescricao
tokenstringSimToken unico do signatario (recebido por email ou WhatsApp)

Exemplo de Requisicao

curl -X GET https://api.tapsign.com.br/v1/signing/abc123def456

Resposta de Sucesso

Status: 200 OK

{
"signer": {
"id": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
"name": "Joao da Silva",
"email": "joao@empresa.com.br",
"role": "SIGNER",
"status": "PENDING",
"viewedAt": null,
"signedAt": null,
"declinedAt": null
},
"envelope": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Contrato de Prestacao de Servicos",
"status": "SENT",
"createdAt": "2026-03-29T14:30:00Z",
"expiresAt": "2026-04-28T23:59:59Z"
},
"documents": [
{
"id": "d1e2f3a4-b5c6-7890-1234-567890abcdef",
"name": "contrato-servicos.pdf",
"pages": 5,
"downloadUrl": "https://api.tapsign.com.br/v1/signing/abc123def456/documents/d1e2f3a4-b5c6-7890-1234-567890abcdef"
}
],
"otherSigners": [
{
"name": "Maria Souza",
"role": "WITNESS",
"status": "SIGNED",
"signedAt": "2026-03-29T16:00:00Z"
}
]
}

Campos da Resposta

Objeto signer

CampoTipoDescricao
idstring (UUID)ID unico do signatario
namestringNome do signatario
emailstringEmail do signatario
rolestringPapel: SIGNER, WITNESS, APPROVER, CARBON_COPY
statusstringStatus atual: PENDING, VIEWED, SIGNED, DECLINED
viewedAtstring ou nullData em que o signatario visualizou o documento
signedAtstring ou nullData em que o signatario assinou
declinedAtstring ou nullData em que o signatario recusou

Objeto envelope

CampoTipoDescricao
idstring (UUID)ID do envelope
namestringNome do envelope
statusstringStatus do envelope
createdAtstring (ISO 8601)Data de criacao
expiresAtstring ou nullData de expiracao

Array documents

CampoTipoDescricao
idstring (UUID)ID do documento
namestringNome do arquivo
pagesnumberNumero de paginas
downloadUrlstringURL para download do documento

Array otherSigners

CampoTipoDescricao
namestringNome do outro signatario
rolestringPapel atribuido
statusstringStatus da assinatura
signedAtstring ou nullData da assinatura
Status do signatario

O campo status progride da seguinte forma:

  1. PENDING -- Convite enviado, aguardando acao
  2. VIEWED -- O signatario abriu o documento
  3. SIGNED -- O signatario assinou com sucesso
  4. DECLINED -- O signatario recusou assinar

Erros

CodigoDescricao
404Token invalido ou signatario nao encontrado
410Envelope expirado ou cancelado