Skip to main content

Consultar Signatários

Devolve o envelope de assinatura do termo aditivo: quem precisa assinar, quem já assinou e o link de assinatura de cada signatário.

Use este endpoint enquanto o aditamento está em pending_signature_confirmation para saber quem falta e reenviar o link a quem precisa.

Request​

ENDPOINT
/security_amendment/amendment/AMENDMENT-KEY/signers
MÉTODO
GET

Path Params​

CampoTipoDescriçãoCaracteres
AMENDMENT-KEYstringChave única do aditamento (UUID v4).36

Response​

STATUS
200
Response Body
{
  "envelope_key": "5b930d3d-3713-4c42-85d5-f8e9e44e30ce",
  "status": "pending_signature",
  "documents": [
    {
      "document_type": "amendment_term",
      "signers": [
        {
          "name": "Emissor Exemplo S.A.",
          "document_number": "145.736.070-56",
          "email": "financeiro@emissor-exemplo.com.br",
          "signature_url": "https://sign.qitech.com.br/s/s2S33dD",
          "status": "on_signature"
        },
        {
          "name": "Maria Oliveira",
          "document_number": "969.698.790-03",
          "email": "maria.oliveira@exemplo.com.br",
          "signature_url": "https://sign.qitech.com.br/s/k9Xp1Qa",
          "status": "signed"
        }
      ]
    }
  ]
}
CampoTipoDescrição
envelope_keystring (UUID)Chave do envelope de assinatura.
statusstringEstado do envelope.
documentsarrayDocumentos do envelope e seus signatários.
documents[].signers[].namestringNome do signatário.
documents[].signers[].document_numberstringCPF do signatário.
documents[].signers[].emailstringE-mail para onde o convite foi enviado.
documents[].signers[].signature_urlstringLink de assinatura individual.
documents[].signers[].statusstringEstado da assinatura daquele signatário.
Só depois do envelope existir

O envelope é criado quando a taxa do aditamento é paga e o termo segue para assinatura. Antes disso, este endpoint retorna AMD000039.

Erros​

StatusCódigoDescrição
404AMD000017Aditamento não encontrado.
403AMD000018O aditamento não pertence ao seu tenant.
422AMD000039O aditamento ainda não tem envelope de assinatura.
500AMD000019Falha ao consultar o provedor de assinatura.

Veja também​