Listing Accounts

This page lists the account query methods. Use them to check the data of an account, to list the BU accounts, and to reconcile what the BU has in its system with what Fits has registered. The parameters and the response examples of each method are in the API Reference.

Query methods

MethodWhat it is for
GetAccountReturns the data of one account in real time, such as balance, condition, type and holder. The account is located by the fields sent: with the AccountKey, it queries one account; without it, it returns the person and their accounts.
GetAccountListLists the BU accounts, with pagination (PageSize and PageIndex) and a date filter (DateFilterGE). It returns registration data, bank data, balance and date, but not the condition (status) of the account, which is in GetAccount. It does not accept AccountKey or HolderTaxNumber as a filter.
CheckAccountPersonChecks whether a person has a valid account (ExistsAccountValid), and returns the links and information of the person.
GetAccountAddressReturns the address registered in the account.
GetDocumentReturns the document of a person.

In addition to the fields described below, the request of each method carries Method (the method name), PartnerId and BusinessUnitId, which identify the BU.

In the Requirement column, Mandatory means the field must be sent; Optional, that it can be omitted; Conditional, that it depends on another field, and the condition is in the description.

GetAccount

With the AccountKey, the query returns one account; without it, it returns the person and their accounts.

Request fields

FieldRequirementDescription
IdentifierOptionalAccount identifier.
AccountKeyOptionalAccount key. With it, the query returns one account.
TaxNumberOptionalCPF or CNPJ of the holder. Without the AccountKey, it returns the person and their accounts.
BankConditionalBank of the account. If any of the four bank data fields is sent, all four must be sent together.
BankBranchConditionalBranch of the account. Send together with the other bank data fields.
BankAccountConditionalAccount number. Send together with the other bank data fields.
BankAccountDigitConditionalAccount check digit. Send together with the other bank data fields.

Response fields

The fields below are inside AccountData, and the format changes depending on whether the request carries the AccountKey. The values of AccountStatus and AccountConditionType are in the Code Mapping, in the sections Account status and Account condition.

FieldDescription
Success"true" or "false".
AccountDataData of the holder and of the account.
PersonIdPerson identifier. Only in the query with AccountKey.
IdentifierAccount identifier. Only in the query without AccountKey.
AccountKeyAccount key. Only in the query with AccountKey; without it, it is in each item of Accounts.
TaxNumberCPF or CNPJ of the holder.
NameName or company name of the holder.
TradingNameTrade name. Only filled for legal entities.
NicknameNickname.
MailEmail.
PhonePhone.
FatherNameFather's name.
MotherNameMother's name.
NationalityNationality.
BirthCityCity of birth.
BirthStateState of birth.
BirthDateDate of birth, in the format yyyy-MM-dd.
GenderGender: 0 Male, 1 Female, 2 Other.
MaritalStatusMarital status.
SpouseNameSpouse's name.
OcuppationOccupation. In this method the field is named Ocuppation.
PubliclyExposedPersonIndicates whether the person is publicly exposed.
CompanyTypeCompany type. Only for legal entities.
CompanyActivityCompany activity. Only for legal entities.
ConstitutionDateConstitution date, in the format yyyy-MM-dd. Only for legal entities.
AccountsAccounts of the holder. Only in the query without AccountKey.
Accounts.BankBank of the account.
Accounts.BankBranchBranch of the account.
Accounts.BankAccountAccount number.
Accounts.BankAccountDigitAccount check digit.
Accounts.AccountKeyAccount key.
Accounts.SpbAccountSPB bank data of the account.
Accounts.SpbAccount.BankSPB bank.
Accounts.SpbAccount.BankBranchSPB branch.
Accounts.SpbAccount.BankAccountSPB account number.
Accounts.SpbAccount.BankAccountDigitSPB account check digit.
AccountStatusIndicates whether the account is active: 0 Disabled, 1 Enabled. In the query without AccountKey, it is in each item of Accounts.
AccountConditionTypeAccount condition. In the query without AccountKey, it is in each item of Accounts.
CreationDateAccount creation date, in the format dd/MM/yyyy. In the query without AccountKey, it is in each item of Accounts.
UpdateDateDate of the last account update, in the format dd/MM/yyyy. In the query without AccountKey, it is in each item of Accounts.

GetAccountList

Request fields

FieldRequirementDescription
PageSizeOptionalNumber of accounts per page.
PageIndexOptionalIndex of the page queried.
DateFilterGEOptionalDate filter: returns the records with a date greater than or equal to the one informed.

Response fields

FieldDescription
Success"true" or "false".
AccountListDataBU accounts in the page queried.
AccountListData.NameName or company name of the holder.
AccountListData.NickNameNickname.
AccountListData.MailEmail.
AccountListData.PhonePhone.
AccountListData.IdentifierAccount identifier.
AccountListData.AccountKeyAccount key.
AccountListData.TradingNameTrade name. Only filled for legal entities.
AccountListData.TaxNumberCPF or CNPJ of the holder.
AccountListData.BankBank of the account.
AccountListData.BankAccountAccount number.
AccountListData.BankBranchBranch of the account.
AccountListData.BankAccountDigitAccount check digit.
AccountListData.AccountValueAccount balance.
AccountListData.AccountSpbSPB bank data. Only returned when the account has all four SPB bank data fields.
AccountListData.AccountSpb.BankSPB bank.
AccountListData.AccountSpb.BankBranchSPB branch.
AccountListData.AccountSpb.BankAccountSPB account number.
AccountListData.AccountSpb.BankAccountDigitSPB account check digit.
AccountListData.LastTransactionDateDate and time of the last transaction, in the format yyyy-MM-dd HH:mm:ss.
TotalAccountsValueTotal value of the accounts returned.

CheckAccountPerson

Request fields

FieldRequirementDescription
TaxNumberMandatoryValid CPF or CNPJ of the person.
FilterByMandatoryCriterion of the check.
PhoneNumberOptionalPhone of the person.

Response fields

FieldDescription
Success"true" or "false".
ExistsAccountValidIndicates whether the person has a valid account (true or false, without quotes).
PersonNameName of the person.

GetAccountAddress

Request fields

FieldRequirementDescription
TaxNumberMandatoryCPF or CNPJ of the person whose address will be queried.

Response fields

FieldDescription
Success"true" or "false".
MessageSuccess message, listed in the Success Catalogue.
AddressesRegistered addresses.
Addresses.AddressLineStreet and number.
Addresses.AddressLine2Second address line.
Addresses.ZipCodePostal code (CEP).
Addresses.NeighborhoodNeighborhood.
Addresses.CityNameCity.
Addresses.StateState (UF).
Addresses.CountryCountry.
Addresses.ComplementComplement.
Addresses.ReferenceLandmark.

GetDocument

Request fields

FieldRequirementDescription
TaxNumberMandatoryCPF or CNPJ of the person.
DocumentTypeMandatoryDocument type. The values are in the Code Mapping, in the section Document type.

The response fields of GetDocument are not detailed on this page yet.

To understand what each account condition means, see Account Status. To query the signers of an account, see Signers.

Good practices

Use webhooks to know when something changes, and queries to check a specific account, identified by its internal bank data (which are not the SPB data), or to reconcile accounts with no final result. Avoid querying at short intervals to follow the processing, because the webhook already notifies the BU.

The errors returned by these methods are listed in the Error Catalogue, in the sections "GetAccount", "GetAccountAddress" and "GetDocument".

The success messages of each method are listed in the Success Catalogue.


Did this page help you?