Pular para o conteúdo principal

Consulta do Termo de Adesão Assinado

Este endpoint retorna o link para download do termo de adesão assinado da auto-assinatura, com o relatório de assinaturas do QI SIGN.

O termo assinado fica disponível quando a auto-assinatura chega a enabled, ou seja, depois que todos os assinantes concluem a assinatura pelos links de assinatura. Em qualquer outro status, este endpoint responde ISS0000030.

Link temporário

O signed_url é um link temporário, válido por 24 horas. Para obter um link novo, consulte o endpoint novamente.


Consulta do Termo Assinado (GET)​

Request​

ENDPOINT
/issuer_management/issuer/ISSUER-KEY/auto_signature/report
MÉTODO
GET

Path Params​

CampoTipoDescriçãoCaracteres
ISSUER-KEYstringChave única do emissor (UUID v4).36

Response​

STATUS
200
Response Body
{
"envelope_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34",
"status": "signed",
"signed_file_url": null,
"documents": [
{
"document_type": "adhesion_auto_signature_term",
"signed_url": "https://qisign-dossiers.s3.amazonaws.com/7bcf5868-784a-4356-85fb-dd72fd53cd4a.pdf?X-Amz-Expires=86400&X-Amz-Signature=...",
"signers": []
}
],
"issuer_key": "07b1ac01-5fc4-475f-930b-19595f24bc1e",
"issuer_auto_signature_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34"
}

Response Body Params​

CampoTipoDescrição
envelope_keystringChave única do envelope de assinatura do termo de adesão.
statusstringStatus do envelope no QI SIGN. Sempre signed.
signed_file_urlnullNão utilizado na auto-assinatura. O link do termo assinado vem em documents[].signed_url.
documentsarrayDocumentos do envelope. O termo de adesão é o único documento.
issuer_keystringChave única do emissor.
issuer_auto_signature_keystringChave única da auto-assinatura.

Campos de documents:

CampoTipoDescrição
document_typestringSempre adhesion_auto_signature_term.
signed_urlstringLink temporário (24 horas) para download do PDF do termo assinado, com o relatório de assinaturas.
signersarraySempre vazio nesta consulta. Para os assinantes, use a consulta dos links de assinatura.

Erros​

HTTPCódigoQuando ocorre
400ISS0000030 (AutoSignatureInWrongStatus)A auto-assinatura não está em enabled — o termo de adesão ainda não foi assinado.
403ISS000011 (TenantForbidden)O cliente não possui acesso completo ao cadastro do emissor informado.
404ISS000009 (IssuerNotFound)Não existe emissor para a chave informada.
404ISS0000028 (AutoSignatureNotFound)O emissor não possui auto-assinatura ativa.