开具银行关系证明函

银行关系证明函（"Declaração de Relacionamento"）是由 QI SCD 数字签名的 PDF 文件，用于证明客户与本机构之间有效的银行关系，并包含账户信息。开具完成后，已签名的文件会通过电子邮件发送至请求中指定的收件人。

Request

ENDPOINT

/account/ACCOUNT_KEY/ownership_letter

MÉTODO

POST

Path parameters

字段	类型	描述
`ACCOUNT_KEY`	UUID	需要开具证明函的账户密钥

Body parameters

字段	类型	描述	最大字符数
`emails` *	string 数组	接收已签名 PDF 的电子邮件列表。至少 1 个地址。	-

Request Body

{
  "emails": ["contact@customer.com", "finance@customer.com"]
}

Response

STATUS

200

Response Body

{
  "document_key": "f1b8e3a2-c5d4-4e9f-a1b2-3c4d5e6f7a8b",
  "account_key": "3e4b8746-da58-4799-bcd0-063326428d3f",
  "document_type": "ownership_letter",
  "document_status": "pending",
  "external_identifier_key": "certifiqi-batch-group-key",
  "file_url": "https://api.certifiqi.com.br/events/certifiqi-batch-group-key",
  "payload": {
    "emails": ["contact@customer.com", "finance@customer.com"]
  },
  "created_at": "2026-05-28T19:50:47",
  "updated_at": "2026-05-28T19:50:47"
}

Response Body parameters

字段	类型	描述	最大字符数
`document_key`	UUID	文档在 QI 内部的唯一标识符。	36
`account_key`	UUID	来源账户的密钥。	36
`document_type`	string	文档类型。此接口固定为 `ownership_letter`。	-
`document_status`	string	文档当前状态。参见 document_status 枚举值。	-
`external_identifier_key`	string	签名批次的外部标识符。	300
`file_url`	string	文档当前 URL。处于 `pending` 时指向签名跟踪页面；变为 `sent` 后指向已签名 PDF。	-
`payload`	object	请求体的回显。	-
`created_at`	datetime Zulu	文档创建时间。	20
`updated_at`	datetime Zulu	文档最后更新时间。	20

document_status 枚举值

枚举值	描述
pending	文档已创建，正在等待签名完成。
sent	文档已签名，电子邮件已发送给收件人。

Request​

Path parameters​

Body parameters​

Response​

Response Body parameters​

document_status 枚举值​