跳到主要内容

查询加入协议签署链接

此端点为自动签署加入协议的每位签署人返回一个签署链接，并附带每人各自的签署状态。发行人的每位签署人均通过其专属链接签署。

启用申请一经响应，链接即可使用 — 正是该申请开启了信封并使自动签署进入 pending_signature。如果协议生成失败，自动签署将停留在 pending_term_generation、没有信封，此端点将返回 ISS0000030，直至重新提交申请。

查询签署链接 (GET)​

Request​

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

Path Params​

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

Query Params​

字段类型描述必填
exclude_qi_signersboolean为 true 时，在响应中隐藏属于 QI 的签署人。默认值：false。否

Response​

STATUS
200
Response Body
{
  "envelope_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34",
  "status": "pending_signature",
  "documents": [
    {
      "document_type": "adhesion_auto_signature_term",
      "signers": [
        {
          "document_number": "123.456.789-01",
          "signature_url": "https://sign.qitech.com.br/s/s2S33dD",
          "name": "Joao da Silva",
          "email": "joao.silva@example.com",
          "status": "on_signature"
        },
        {
          "document_number": "987.654.321-00",
          "signature_url": "https://sign.qitech.com.br/s/f7Kd91P",
          "name": "Maria de Souza",
          "email": "maria.souza@example.com",
          "status": "signed"
        },
        {
          "document_number": "421.820.518-30",
          "signature_url": "https://sign.qitech.com.br/s/q1W2e3R",
          "name": "Assinante QI CTVM",
          "email": "assinaturas.estruturadas@qitech.com.br",
          "status": "on_signature"
        }
      ]
    }
  ],
  "issuer_key": "07b1ac01-5fc4-475f-930b-19595f24bc1e",
  "issuer_auto_signature_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34"
}

Response Body Params​

字段类型描述
envelope_keystring加入协议签署信封的唯一键。
statusstring信封在 QI SIGN 中的状态。
documentsarray信封中的文件。加入协议是唯一的文件。
issuer_keystring发行人的唯一键。
issuer_auto_signature_keystring自动签署的唯一键。

documents 字段：

字段类型描述
document_typestring始终为 adhesion_auto_signature_term。
signersarray文件的签署人，每位签署人一项。

signers 字段：

字段类型描述
document_numberstring签署人的 CPF。
signature_urlstring该签署人的专属签署链接。
namestring签署人姓名。
emailstring签署人电子邮箱。
statusstring个人签署状态 — 例如 on_signature 或 signed。

错误​

HTTP代码触发条件
400ISS0000030 (AutoSignatureInWrongStatus)加入协议尚未送签 — 自动签署处于 pending_term_generation。
403ISS000011 (TenantForbidden)客户对所指定发行人的登记信息不具备完整访问权限。
404ISS000009 (IssuerNotFound)不存在与所给键对应的发行人。
404ISS0000028 (AutoSignatureNotFound)发行人没有有效的自动签署。