Active Account Declaration

This page explains how to request the active account declaration (GenerateActiveAccountDeclaration), a PDF document that proves the account has been activated. The BU sends the request with the account data and Fits replies with the URL of the generated PDF, which can be accessed for download.

When to use

Use this method when the BU or the end customer needs proof that the account is active. To use it, the requesting account must have an SPB (Bacen) mirror account.

How to generate it

Use the GenerateActiveAccountDeclaration method. Request and response examples are in the API Reference. The Method, PartnerId and BusinessUnitId fields are common to all methods and are described in Getting Started.

Request fields

In the Requirement column, Mandatory means the field must be sent, Optional means it can be omitted, and Conditional means it depends on another field, as stated in the Description.

FieldRequirementDescription
MethodMandatoryFixed value: GenerateActiveAccountDeclaration.
PartnerIdMandatoryInformation provided by Fits.
BusinessUnitIdMandatoryInformation provided by Fits.
AccountKeyConditionalAccount identifier. Required if the bank details are not sent. If sent together with the bank details, it takes precedence in the search.
TaxNumberMandatoryCPF/CNPJ of the account holder.
BankConditionalBank code (example: "450"), digits only, up to 4 characters. Required, together with the other three bank details, if the AccountKey is not sent.
BankBranchConditionalBranch code (example: "0001"), digits only, up to 10 characters. Required, together with the other three bank details, if the AccountKey is not sent.
BankAccountConditionalAccount number (example: "146492"), digits only, up to 20 characters. Required, together with the other three bank details, if the AccountKey is not sent.
BankAccountDigitConditionalAccount digit (example: "1"), digits only, up to 2 characters. Required, together with the other three bank details, if the AccountKey is not sent.

The bank details are an alternative to the AccountKey: send the AccountKey or all four bank details. If any of the four fields (Bank, BankBranch, BankAccount and BankAccountDigit) is filled in, all four must be complete. The declaration Identifier is not a request field: Fits generates it, and it is part of the returned URL.

Response fields

The response returns the fields below.

FieldDescription
Success"true" or "false" (text, not a boolean). When the request is not accepted, it is "false".
MessageReturn message. When the request is not accepted, it gives the reason.
URLAddress of the declaration PDF. The link validity is defined in days by a Fits setting, with a default of one day. When the request is refused because the account already has a current declaration, the URL of that declaration is also filled in the response.

Fits does not return the PDF or the file in base64, and there is no webhook. The success message is listed in the Success Catalogue.

The errors returned by this method are listed in the Error Catalogue, in the section GenerateActiveAccountDeclaration.

Rules

  • the declaration can only be generated for an account that exists, belongs to the BU making the request, is not closed and has an SPB (Bacen) mirror account.
  • if the account already has a current declaration, the request is refused and the response brings the URL of the existing declaration.

What the declaration contains

The generated document includes the following data:

  • account holder name;
  • CPF or CNPJ;
  • address;
  • banking details (bank, branch, account and account digit);
  • account opening date;
  • current account balance;
  • report date;
  • institution data (company name, CNPJ and address).

Did this page help you?