Skip to main content

Auto-signature Query

This endpoint allows querying an issuer's active auto-signature — current status, adoption agreement data and event history.

The signature links of each signer are in a dedicated endpoint: signature links query.

See the auto-signature flow to understand how the enablement is created and what the possible statuses are.


Auto-signature Query (GET)​

Request​

ENDPOINT
/issuer_management/issuer/ISSUER-KEY/auto_signature
METHOD
GET

Path Params​

FieldTypeDescriptionCharacters
ISSUER-KEYstringUnique issuer key (UUID v4).36

Response​

STATUS
200
Response Body — awaiting agreement signature
{
"issuer_auto_signature_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34",
"status": "pending_signature",
"signed_at": null,
"enabled_at": null,
"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": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34",
"created_at": "2026-02-10T09:15:44",
"event_list": [
{
"event_type": "auto_signature_creation",
"status": "pending_term_generation",
"event_data": {
"tenant_key": "5e3045af-8be8-4cbd-9aab-9e15c4e92154"
},
"created_at": "2026-02-10T09:15:44"
},
{
"event_type": "adhesion_term_generation",
"status": "pending_term_generation",
"event_data": {
"term_document_key": "07b1ac01-5fc4-475f-930b-19595f24bc1e/adhesion_auto_signature_term/5d1c8b30-2f44-4a9e-8c7b-1e0a6f2d9b55",
"template_key": "b71f1a2c-9e44-4c1d-8f3a-6d2c0b5e7a19"
},
"created_at": "2026-02-10T09:16:02"
},
{
"event_type": "envelope_creation",
"status": "pending_signature",
"event_data": {
"envelope_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34"
},
"created_at": "2026-02-10T09:16:03"
}
]
}
Response Body — agreement signed (enabled)
{
"issuer_auto_signature_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34",
"status": "enabled",
"signed_at": "2026-02-11T14:02:31",
"enabled_at": "2026-02-11T14:02:31",
"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": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34",
"created_at": "2026-02-10T09:15:44",
"event_list": [
{
"event_type": "signature_webhook_received",
"status": "pending_signature",
"event_data": {
"envelope_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34",
"envelope_status": "signed"
},
"created_at": "2026-02-11T14:02:31"
},
{
"event_type": "auto_signature_status_change",
"status": "enabled",
"event_data": {
"status": "enabled"
},
"created_at": "2026-02-11T14:02:31"
}
]
}

Response Body Params​

FieldTypeDescription
issuer_auto_signature_keystringUnique auto-signature key.
statusstringCurrent status: pending_term_generation, pending_signature, enabled, reproved or canceled.
signed_atstringDate and time the agreement was signed. null while the agreement is not signed.
enabled_atstringDate and time of the enablement. null while the status is not enabled.
issuer_keystringUnique issuer key.
term_document_keystringPath of the generated adoption agreement document.
envelope_keystringUnique key of the agreement signature envelope.
created_atstringDate and time the auto-signature was created.
event_listarrayAuto-signature event history, in chronological order.

Fields of event_list:

FieldTypeDescription
event_typestringEvent type: auto_signature_creation, adhesion_term_generation, adhesion_term_generation_failure, envelope_creation, envelope_creation_failure, signature_webhook_received or auto_signature_status_change.
statusstringAuto-signature status at the time of the event.
event_dataobjectEvent data. The content varies according to the event_type.
created_atstringDate and time of the event.

Errors​

HTTPCodeWhen it occurs
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.
Closed auto-signatures

The query only returns the active auto-signature — the one in pending_term_generation, pending_signature or enabled. Once an auto-signature moves to reproved or canceled, this endpoint responds with ISS0000028 until a new enablement is created. The last known state remains visible in the auto_signature field of the issuer query.