Pular para o conteúdo principal

Cancelamento da Auto-assinatura

Este endpoint cancela a auto-assinatura ativa de um emissor. A partir do cancelamento, a integração deve enviar as emissões seguintes do emissor pelo fluxo de assinatura manual (QI SIGN).

Consulte o fluxo da auto-assinatura para o encadeamento completo e o significado de cada status.

Assinatura automática até a revogação

Quando a auto-assinatura já chegou a pending_certificate ou enabled, o certificado privado do emissor pode já estar instalado na CertifiQI. Nesse caso, o cancelamento leva a auto-assinatura para pending_revocation, e ela só vai para canceled depois que a QI Tech revoga o certificado.

A assinatura automática é feita pela CertifiQI com esse certificado e só deixa de ser possível com a revogação. Até lá, uma operação do emissor enviada para assinatura pela CertifiQI ainda pode ser assinada automaticamente. Por isso, envie as operações do emissor pelo fluxo de assinatura manual (QI SIGN) assim que solicitar o cancelamento.


Cancelamento da Auto-assinatura (PUT)​

Request​

ENDPOINT
/issuer_management/issuer/ISSUER-KEY/auto_signature/cancel
MÉTODO
PUT

Path Params​

CampoTipoDescriçãoCaracteres
ISSUER-KEYstringChave única do emissor (UUID v4).36
Request Body
{
"reason": "Emissor solicitou o encerramento da auto-assinatura"
}

Request Body Params​

CampoTipoDescriçãoCaracteres
reason *stringMotivo do cancelamento. Fica registrado no histórico de eventos da auto-assinatura.1023

Quando o cancelamento é aceito​

O cancelamento atua sobre a auto-assinatura ativa do emissor. Não é preciso informar a issuer_auto_signature_key.

Status atualCancelávelStatus após o cancelamento
pending_term_generationSimcanceled
pending_signatureSimcanceled
pending_certificateSimpending_revocation
enabledSimpending_revocation
pending_revocationNãoO cancelamento já está em andamento.

Uma auto-assinatura em reproved ou canceled não é mais a auto-assinatura ativa do emissor, e o cancelamento responde ISS0000028.

Efeitos do cancelamento​

  • Cancela o envelope do termo de adesão, se a auto-assinatura estiver em pending_signature. Os links de assinatura já distribuídos deixam de funcionar.
  • Bloqueia uma nova habilitação durante a revogação. Enquanto a auto-assinatura estiver em pending_revocation, a solicitação da auto-assinatura responde ISS0000029. Depois do canceled, uma nova habilitação pode ser solicitada.
  • Dispara o webhook issuer_management.auto_signature_status_change com o status resultante. Quando o cancelamento passa por pending_revocation, um segundo webhook é enviado com canceled ao fim da revogação.

Response​

STATUS
200

A resposta é o mesmo objeto da consulta da auto-assinatura, já com o status resultante do cancelamento.

Response Body
{
"issuer_auto_signature_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34",
"status": "pending_revocation",
"signed_at": "2026-02-11T14:02:31",
"enabled_at": "2026-02-12T10:40:12",
"issuer_key": "07b1ac01-5fc4-475f-930b-19595f24bc1e",
"term_document_key": "07b1ac01-5fc4-475f-930b-19595f24bc1e/adhesion_auto_signature_term/5d1c8b30-2f44-4a9e-8c7b-1e0a6f2d9b55",
"envelope_key": "5b930d3d-3713-4c42-85d5-f8e9e44e30ce",
"created_at": "2026-02-10T09:15:44",
"event_list": [
{
"event_type": "auto_signature_status_change",
"status": "enabled",
"event_data": {
"status": "enabled"
},
"created_at": "2026-02-12T10:40:12"
},
{
"event_type": "auto_signature_status_change",
"status": "pending_revocation",
"event_data": {
"status": "pending_revocation",
"reason": "Emissor solicitou o encerramento da auto-assinatura"
},
"created_at": "2026-03-02T16:21:08"
}
]
}

Erros​

HTTPCódigoQuando ocorre
400QIT000001O corpo não traz reason, ou traz um campo desconhecido.
400ISS0000030 (AutoSignatureInWrongStatus)A auto-assinatura já está em pending_revocation.
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.