跳到主要内容

开具审计询证函

审计询证函("circularização")是由 QI SCD 数字签名的审计文件,用于在指定基准日确认客户名下账户的余额。文件列出与路径中账户属于同一证件号码且在同一 requester 下的全部账户。开具完成后,已签名的 PDF 会通过电子邮件发送至请求中指定的收件人(通常是审计师)。

Request

ENDPOINT
/account/ACCOUNT_KEY/circularization_letter
MÉTODO
POST

Path parameters

字段类型描述
ACCOUNT_KEYUUID客户名下任一账户的密钥。仅用于识别证件号码和 requester;询证函会列出该证件号码在同一 requester 下的全部账户。

Body parameters

字段类型描述最大字符数
emails *string 数组接收已签名 PDF 的电子邮件列表。至少 1 个地址。通常为申请询证的审计师邮箱。-
reference_date *string (YYYY-MM-DD)余额计算的基准日。询证函将以该日的期末余额为准声明每个账户的余额。10
recipient_namestring收件公司/机构名称,用于文档的称谓行("致 {recipient_name} 全体" )。如未填写,默认为"敬启者,"。-
Request Body
{
"emails": ["audit@audit-firm.com"],
"reference_date": "2026-04-30",
"recipient_name": "BDO RCS Auditores Independentes"
}

Response

STATUS
200
Response Body
{
"document_key": "f1b8e3a2-c5d4-4e9f-a1b2-3c4d5e6f7a8b",
"account_key": "3e4b8746-da58-4799-bcd0-063326428d3f",
"document_type": "circularization_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": ["audit@audit-firm.com"],
"reference_date": "2026-04-30",
"recipient_name": "BDO RCS Auditores Independentes"
},
"created_at": "2026-05-28T19:50:47",
"updated_at": "2026-05-28T19:50:47"
}

Response Body parameters

字段类型描述最大字符数
document_keyUUID文档在 QI 内部的唯一标识符。36
account_keyUUID来源账户的密钥。36
document_typestring文档类型。此接口固定为 circularization_letter-
document_statusstring文档当前状态。参见 document_status 枚举值-
external_identifier_keystring签名批次的外部标识符。300
file_urlstring文档当前 URL。处于 pending 时指向签名跟踪页面;变为 sent 后指向已签名 PDF。-
payloadobject请求体的回显。-
created_atdatetime Zulu文档创建时间。20
updated_atdatetime Zulu文档最后更新时间。20

document_status 枚举值

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