跳到主要内容

查询自动签署

此端点用于查询发行人当前有效的自动签署 — 当前状态、加入协议数据以及事件历史。

每位签署人的签署链接通过单独的端点提供：查询签署链接。

如需了解启用如何创建以及可能的状态，请参阅自动签署流程。

查询自动签署 (GET)​

Request​

ENDPOINT
/issuer_management/issuer/ISSUER-KEY/auto_signature
MÉTODO
GET

Path Params​

字段类型描述字符数
ISSUER-KEYstring发行人的唯一键（UUID v4）。36

Response​

STATUS
200
Response Body — 等待协议签署
{
    "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 — 协议已签署（已启用）
{
    "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​

字段类型描述
issuer_auto_signature_keystring自动签署的唯一键。
statusstring当前状态：pending_term_generation、pending_signature、enabled、reproved 或 canceled。
signed_atstring协议签署的日期与时间。协议签署之前为 null。
enabled_atstring启用的日期与时间。状态不为 enabled 时为 null。
issuer_keystring发行人的唯一键。
term_document_keystring所生成加入协议的文件路径。
envelope_keystring协议签署信封的唯一键。
created_atstring自动签署的创建日期与时间。
event_listarray自动签署的事件历史，按时间顺序排列。

event_list 字段：

字段类型描述
event_typestring事件类型：auto_signature_creation、adhesion_term_generation、adhesion_term_generation_failure、envelope_creation、envelope_creation_failure、signature_webhook_received 或 auto_signature_status_change。
statusstring事件发生时自动签署的状态。
event_dataobject事件数据。内容随 event_type 而不同。
created_atstring事件的日期与时间。

错误​

HTTP代码触发条件
403ISS000011 (TenantForbidden)客户对所指定发行人的登记信息不具备完整访问权限。
404ISS000009 (IssuerNotFound)不存在与所给键对应的发行人。
404ISS0000028 (AutoSignatureNotFound)发行人没有有效的自动签署。
已结束的自动签署

该查询仅返回有效的自动签署 — 即处于 pending_term_generation、pending_signature 或 enabled 的自动签署。自动签署转为 reproved 或 canceled 之后，此端点将返回 ISS0000028，直至创建新的启用。最近一次已知状态仍可在发行人查询的 auto_signature 字段中查看。