Issue Bank Relationship Letter

The bank relationship letter ("Declaração de Relacionamento") is a PDF document digitally signed by QI SCD that confirms the active relationship between the customer and the institution, including account details. Once issued, the signed document is emailed to the recipients informed in the request.

Request

ENDPOINT

/account/ACCOUNT_KEY/ownership_letter

METHOD

POST

Path parameters

Field	Type	Description
ACCOUNT_KEY	UUID	Key of the account the letter will be issued for

Body parameters

Field	Type	Description	Max. Characters
emails *	array of strings	List of e-mails that will receive the signed PDF. Minimum 1 address.	-

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

Field	Type	Description	Max. Characters
document_key	UUID	Internal QI identifier of the document.	36
account_key	UUID	Key of the source account.	36
document_type	string	Document type. Always ownership_letter on this route.	-
document_status	string	Current document status. See Enumerators document_status.	-
external_identifier_key	string	External identifier of the signature batch.	300
file_url	string	Current document URL. While pending, points to signature tracking; once sent, points to the signed PDF.	-
payload	object	Echo of the request body.	-
created_at	datetime Zulu	Document creation date.	20
updated_at	datetime Zulu	Last document update.	20

Enumerators document_status

Enumerator	Description
pending	Document created, awaiting signature finalization.
sent	Document signed and e-mails dispatched to recipients.