Consulta da Auto-assinatura

Este endpoint permite consultar a auto-assinatura ativa de um emissor — status atual, dados do termo de adesão e histórico de eventos.

Os links de assinatura de cada assinante ficam em um endpoint próprio: consulta dos links de assinatura.

Consulte o fluxo da auto-assinatura para entender como a habilitação é criada e quais são os status possíveis.

Consulta da Auto-assinatura (GET)

Request

ENDPOINT

/issuer_management/issuer/ISSUER-KEY/auto_signature

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
`ISSUER-KEY`	string	Chave única do emissor (UUID v4).	36

Response

STATUS

200

Response Body — aguardando assinatura do termo

{
    "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 — termo assinado (habilitado)

{
    "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

Campo	Tipo	Descrição
`issuer_auto_signature_key`	string	Chave única da auto-assinatura.
`status`	string	Status atual: `pending_term_generation`, `pending_signature`, `enabled`, `reproved` ou `canceled`.
`signed_at`	string	Data e hora da assinatura do termo. `null` enquanto o termo não é assinado.
`enabled_at`	string	Data e hora da habilitação. `null` enquanto o status não é `enabled`.
`issuer_key`	string	Chave única do emissor.
`term_document_key`	string	Caminho do documento do termo de adesão gerado.
`envelope_key`	string	Chave única do envelope de assinatura do termo.
`created_at`	string	Data e hora de criação da auto-assinatura.
`event_list`	array	Histórico de eventos da auto-assinatura, em ordem cronológica.

Campos de event_list:

Campo	Tipo	Descrição
`event_type`	string	Tipo do evento: `auto_signature_creation`, `adhesion_term_generation`, `adhesion_term_generation_failure`, `envelope_creation`, `envelope_creation_failure`, `signature_webhook_received` ou `auto_signature_status_change`.
`status`	string	Status da auto-assinatura no momento do evento.
`event_data`	object	Dados do evento. O conteúdo varia conforme o `event_type`.
`created_at`	string	Data e hora do evento.

Erros

HTTP	Código	Quando ocorre
403	`ISS000011` (`TenantForbidden`)	O cliente não possui acesso completo ao cadastro do emissor informado.
404	`ISS000009` (`IssuerNotFound`)	Não existe emissor para a chave informada.
404	`ISS0000028` (`AutoSignatureNotFound`)	O emissor não possui auto-assinatura ativa.

Auto-assinaturas encerradas

A consulta retorna apenas a auto-assinatura ativa — aquela em pending_term_generation, pending_signature ou enabled. Depois que uma auto-assinatura vai para reproved ou canceled, este endpoint responde ISS0000028 até que uma nova habilitação seja criada. O último estado conhecido continua visível no campo auto_signature da consulta do emissor.

Consulta da Auto-assinatura (GET)​

Request​

Path Params​

Response​

Response Body Params​

Erros​