Emitir Carta Bancária

A carta bancária ("Declaração de Relacionamento") é um documento PDF assinado digitalmente pela QI SCD que comprova o vínculo ativo entre o cliente e a instituição, incluindo dados da conta. Após a emissão, o documento assinado é enviado por e-mail para os destinatários informados.

Request

ENDPOINT

/account/ACCOUNT_KEY/ownership_letter

MÉTODO

POST

Path parameters

Campo	Tipo	Descrição
ACCOUNT_KEY	UUID	Chave da conta da qual a carta será emitida

Body parameters

Campo	Tipo	Descrição	Max. Caracteres
emails *	array de strings	Lista de e-mails que receberão o PDF assinado. Mínimo 1 endereço.	-

Request Body

{
  "emails": ["contato@cliente.com.br", "financeiro@cliente.com.br"]
}

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": ["contato@cliente.com.br", "financeiro@cliente.com.br"]
  },
  "created_at": "2026-05-28T19:50:47",
  "updated_at": "2026-05-28T19:50:47"
}

Response Body parameters

Campo	Tipo	Descrição	Max. Caracteres
document_key	UUID	Identificador interno do documento na QI.	36
account_key	UUID	Chave da conta de origem.	36
document_type	string	Tipo do documento. Sempre ownership_letter nesta rota.	-
document_status	string	Status atual do documento. Ver Enumeradores document_status.	-
external_identifier_key	string	Identificador externo do lote de assinatura.	300
file_url	string	URL atual do documento. Durante pending, aponta para o acompanhamento da assinatura; após sent, aponta para o PDF assinado.	-
payload	object	Eco do corpo enviado na requisição.	-
created_at	datetime Zulu	Data de criação do documento.	20
updated_at	datetime Zulu	Última atualização do documento.	20

Enumeradores document_status

Enumerador	Descrição
pending	Documento criado, aguardando finalização da assinatura.
sent	Documento assinado e e-mails despachados aos destinatários.