Skip to main content

Auto-signature Cancellation

This endpoint cancels the active auto-signature of an issuer. From the cancellation onwards, the integration must send the issuer's subsequent issuances through the manual signature flow (QI SIGN).

See the auto-signature flow for the complete sequence and the meaning of each status.

Automatic signature until the revocation

When the auto-signature has already reached pending_certificate or enabled, the issuer's private certificate may already be installed in CertifiQI. In this case, the cancellation moves the auto-signature to pending_revocation, and it only moves to canceled after QI Tech revokes the certificate.

The automatic signature is performed by CertifiQI with that certificate and only stops being possible with the revocation. Until then, an operation of the issuer sent for signature through CertifiQI can still be signed automatically. For this reason, send the issuer's operations through the manual signature flow (QI SIGN) as soon as you request the cancellation.


Auto-signature Cancellation (PUT)​

Request​

ENDPOINT
/issuer_management/issuer/ISSUER-KEY/auto_signature/cancel
METHOD
PUT

Path Params​

FieldTypeDescriptionCharacters
ISSUER-KEYstringUnique issuer key (UUID v4).36
Request Body
{
"reason": "Issuer requested to end the auto-signature"
}

Request Body Params​

FieldTypeDescriptionCharacters
reason *stringReason for the cancellation. It is recorded in the auto-signature event history.1023

When the cancellation is accepted​

The cancellation acts on the issuer's active auto-signature. There is no need to inform the issuer_auto_signature_key.

Current statusCancelableStatus after the cancellation
pending_term_generationYescanceled
pending_signatureYescanceled
pending_certificateYespending_revocation
enabledYespending_revocation
pending_revocationNoThe cancellation is already in progress.

An auto-signature in reproved or canceled is no longer the issuer's active auto-signature, and the cancellation responds with ISS0000028.

Effects of the cancellation​

  • Cancels the adoption agreement envelope, if the auto-signature is in pending_signature. Signature links already distributed stop working.
  • Blocks a new enablement during the revocation. While the auto-signature is in pending_revocation, the auto-signature request responds with ISS0000029. After canceled, a new enablement can be requested.
  • Triggers the webhook issuer_management.auto_signature_status_change with the resulting status. When the cancellation goes through pending_revocation, a second webhook is sent with canceled at the end of the revocation.

Response​

STATUS
200

The response is the same object as the auto-signature query, already with the status resulting from the cancellation.

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": "Issuer requested to end the auto-signature"
},
"created_at": "2026-03-02T16:21:08"
}
]
}

Errors​

HTTPCodeWhen it occurs
400QIT000001The body has no reason, or has an unknown field.
400ISS0000030 (AutoSignatureInWrongStatus)The auto-signature is already in pending_revocation.
403ISS000011 (TenantForbidden)The client does not have full access to the registration of the given issuer.
404ISS000009 (IssuerNotFound)There is no issuer for the given key.
404ISS0000028 (AutoSignatureNotFound)The issuer has no active auto-signature.