Pular para o conteúdo principal

Emitir Carta de Circularização

A carta de circularização é um documento de auditoria assinado digitalmente pela QI SCD que confirma os saldos das contas mantidas pelo titular em uma data-base de referência. Listará todas as contas da CNPJ/CPF do titular vinculadas ao requester da conta informada no path. Após a emissão, o PDF assinado é enviado por e-mail para os destinatários informados (tipicamente o auditor).

Request

ENDPOINT
/account/ACCOUNT_KEY/circularization_letter
MÉTODO
POST

Path parameters

CampoTipoDescrição
ACCOUNT_KEYUUIDChave de uma conta do titular. Serve apenas para identificar o documento e o requester; a carta lista todas as contas do mesmo documento dentro do requester.

Body parameters

CampoTipoDescriçãoMax. Caracteres
emails *array de stringsLista de e-mails que receberão o PDF assinado. Mínimo 1 endereço. Tipicamente o e-mail do auditor solicitante.-
reference_date *string (YYYY-MM-DD)Data-base para o cálculo dos saldos. A carta declara o saldo de cada conta na posição de fechamento desta data.10
recipient_namestringNome da empresa/instituição destinatária, usado na saudação do documento ("Prezados senhores da {recipient_name}"). Se omitido, usa "A quem possa interessar,".-
Request Body
{
"emails": ["auditoria@empresa-de-auditoria.com.br"],
"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": ["auditoria@empresa-de-auditoria.com.br"],
"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

CampoTipoDescriçãoMax. Caracteres
document_keyUUIDIdentificador interno do documento na QI.36
account_keyUUIDChave da conta de origem.36
document_typestringTipo do documento. Sempre circularization_letter nesta rota.-
document_statusstringStatus atual do documento. Ver Enumeradores document_status.-
external_identifier_keystringIdentificador externo do lote de assinatura.300
file_urlstringURL atual do documento. Durante pending, aponta para o acompanhamento da assinatura; após sent, aponta para o PDF assinado.-
payloadobjectEco do corpo enviado na requisição.-
created_atdatetime ZuluData de criação do documento.20
updated_atdatetime ZuluÚltima atualização do documento.20

Enumeradores document_status

EnumeradorDescrição
pendingDocumento criado, aguardando finalização da assinatura.
sentDocumento assinado e e-mails despachados aos destinatários.