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
| Method | What it is for |
|---|---|
| GetAccount | Returns 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. |
| GetAccountList | Lists 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. |
| CheckAccountPerson | Checks whether a person has a valid account (ExistsAccountValid), and returns the links and information of the person. |
| GetAccountAddress | Returns the address registered in the account. |
| GetDocument | Returns 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
| Field | Requirement | Description |
|---|---|---|
| Identifier | Optional | Account identifier. |
| AccountKey | Optional | Account key. With it, the query returns one account. |
| TaxNumber | Optional | CPF or CNPJ of the holder. Without the AccountKey, it returns the person and their accounts. |
| Bank | Conditional | Bank of the account. If any of the four bank data fields is sent, all four must be sent together. |
| BankBranch | Conditional | Branch of the account. Send together with the other bank data fields. |
| BankAccount | Conditional | Account number. Send together with the other bank data fields. |
| BankAccountDigit | Conditional | Account 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.
| Field | Description |
|---|---|
| Success | "true" or "false". |
| AccountData | Data of the holder and of the account. |
| PersonId | Person identifier. Only in the query with AccountKey. |
| Identifier | Account identifier. Only in the query without AccountKey. |
| AccountKey | Account key. Only in the query with AccountKey; without it, it is in each item of Accounts. |
| TaxNumber | CPF or CNPJ of the holder. |
| Name | Name or company name of the holder. |
| TradingName | Trade name. Only filled for legal entities. |
| Nickname | Nickname. |
| Email. | |
| Phone | Phone. |
| FatherName | Father's name. |
| MotherName | Mother's name. |
| Nationality | Nationality. |
| BirthCity | City of birth. |
| BirthState | State of birth. |
| BirthDate | Date of birth, in the format yyyy-MM-dd. |
| Gender | Gender: 0 Male, 1 Female, 2 Other. |
| MaritalStatus | Marital status. |
| SpouseName | Spouse's name. |
| Ocuppation | Occupation. In this method the field is named Ocuppation. |
| PubliclyExposedPerson | Indicates whether the person is publicly exposed. |
| CompanyType | Company type. Only for legal entities. |
| CompanyActivity | Company activity. Only for legal entities. |
| ConstitutionDate | Constitution date, in the format yyyy-MM-dd. Only for legal entities. |
| Accounts | Accounts of the holder. Only in the query without AccountKey. |
| Accounts.Bank | Bank of the account. |
| Accounts.BankBranch | Branch of the account. |
| Accounts.BankAccount | Account number. |
| Accounts.BankAccountDigit | Account check digit. |
| Accounts.AccountKey | Account key. |
| Accounts.SpbAccount | SPB bank data of the account. |
| Accounts.SpbAccount.Bank | SPB bank. |
| Accounts.SpbAccount.BankBranch | SPB branch. |
| Accounts.SpbAccount.BankAccount | SPB account number. |
| Accounts.SpbAccount.BankAccountDigit | SPB account check digit. |
| AccountStatus | Indicates whether the account is active: 0 Disabled, 1 Enabled. In the query without AccountKey, it is in each item of Accounts. |
| AccountConditionType | Account condition. In the query without AccountKey, it is in each item of Accounts. |
| CreationDate | Account creation date, in the format dd/MM/yyyy. In the query without AccountKey, it is in each item of Accounts. |
| UpdateDate | Date 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
| Field | Requirement | Description |
|---|---|---|
| PageSize | Optional | Number of accounts per page. |
| PageIndex | Optional | Index of the page queried. |
| DateFilterGE | Optional | Date filter: returns the records with a date greater than or equal to the one informed. |
Response fields
| Field | Description |
|---|---|
| Success | "true" or "false". |
| AccountListData | BU accounts in the page queried. |
| AccountListData.Name | Name or company name of the holder. |
| AccountListData.NickName | Nickname. |
| AccountListData.Mail | Email. |
| AccountListData.Phone | Phone. |
| AccountListData.Identifier | Account identifier. |
| AccountListData.AccountKey | Account key. |
| AccountListData.TradingName | Trade name. Only filled for legal entities. |
| AccountListData.TaxNumber | CPF or CNPJ of the holder. |
| AccountListData.Bank | Bank of the account. |
| AccountListData.BankAccount | Account number. |
| AccountListData.BankBranch | Branch of the account. |
| AccountListData.BankAccountDigit | Account check digit. |
| AccountListData.AccountValue | Account balance. |
| AccountListData.AccountSpb | SPB bank data. Only returned when the account has all four SPB bank data fields. |
| AccountListData.AccountSpb.Bank | SPB bank. |
| AccountListData.AccountSpb.BankBranch | SPB branch. |
| AccountListData.AccountSpb.BankAccount | SPB account number. |
| AccountListData.AccountSpb.BankAccountDigit | SPB account check digit. |
| AccountListData.LastTransactionDate | Date and time of the last transaction, in the format yyyy-MM-dd HH:mm:ss. |
| TotalAccountsValue | Total value of the accounts returned. |
CheckAccountPerson
Request fields
| Field | Requirement | Description |
|---|---|---|
| TaxNumber | Mandatory | Valid CPF or CNPJ of the person. |
| FilterBy | Mandatory | Criterion of the check. |
| PhoneNumber | Optional | Phone of the person. |
Response fields
| Field | Description |
|---|---|
| Success | "true" or "false". |
| ExistsAccountValid | Indicates whether the person has a valid account (true or false, without quotes). |
| PersonName | Name of the person. |
GetAccountAddress
Request fields
| Field | Requirement | Description |
|---|---|---|
| TaxNumber | Mandatory | CPF or CNPJ of the person whose address will be queried. |
Response fields
| Field | Description |
|---|---|
| Success | "true" or "false". |
| Message | Success message, listed in the Success Catalogue. |
| Addresses | Registered addresses. |
| Addresses.AddressLine | Street and number. |
| Addresses.AddressLine2 | Second address line. |
| Addresses.ZipCode | Postal code (CEP). |
| Addresses.Neighborhood | Neighborhood. |
| Addresses.CityName | City. |
| Addresses.State | State (UF). |
| Addresses.Country | Country. |
| Addresses.Complement | Complement. |
| Addresses.Reference | Landmark. |
GetDocument
Request fields
| Field | Requirement | Description |
|---|---|---|
| TaxNumber | Mandatory | CPF or CNPJ of the person. |
| DocumentType | Mandatory | Document 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.
Updated 11 days ago

