Code Mapping
Many API responses and webhooks bring numeric values, such as the account condition, the status of a document or the reason for an unlock. This page shows what each number means in the values that appear in this Guide. The fields of each method, with all the accepted values, are in the API Reference.
The numbers have a different meaning in each method. For the errors of each method, see the Error Catalogue.
- Account opening: Document type, Document format
- Tracking the processing: Account condition, Account status, Document status, KYC analysis classification
- Registration correction and update: Role of the person, Signer request status, Registration data changed, Status per item of the registration change
- Digital contract: Contract type, Contract status
- Account actions: Block reason, Unlock justification, Closing status
- Account management: Limit type, Limit subtype, Limit increase justification, Operation type, Document type, Document format
Account condition
AccountConditionType field of the account webhook. The meaning of each condition is in Account Status.
| Value | Name in the system | Condition |
|---|---|---|
| 0 | Created | Under review |
| 1 | Limited | Limited |
| 2 | Verified | Verified |
| 3 | Blocked | Blocked |
The table shows the values used in the responses and webhooks of this Guide. AccountConditionType has other values, in another enumeration.
Account closing is not a condition in this table. When the closing is completed, the account type (Account.Type) changes to Closed (26), without the UpdateAccount webhook. Closing is tracked through the closing status, described further below.
Account status
The AccountStatus field indicates whether the account is active: 0 (Disabled) is disabled and 1 (Enabled) is active.
| Value | Name in the system | Status |
|---|---|---|
| 0 | Disabled | Disabled |
| 1 | Enabled | Active |
Document status
DocumentStatus field of the documents webhook. What to do in each status is in Pending Documents.
| Value | Status |
|---|---|
| 0 | AwaitingValidation |
| 1 | Validated |
| 2 | Invalid |
| 3 | Expired |
| 4 | Sent |
| 5 | Resubmitted |
| 6 | Disapproved |
| 7 | Error |
| 8 | Inexistent |
| 9 | Suspended |
| 10 | TypificationResult |
Document type
DocumentType field. The documents required for each account type are in Required Documents.
| Value | Document |
|---|---|
| 0 | ID (RG), front |
| 1 | Taxpayer ID (CPF) |
| 2 | Proof of address |
| 3 | Driver's license (CNH), front |
| 4 | Company taxpayer ID (CNPJ) |
| 5 | Articles of association (Contrato Social) |
| 6 | Power of attorney |
| 7 | ID (RG), back |
| 8 | Internal use (Error); do not use at account opening |
| 9 | Does not exist |
| 10 | ID (RG) (not accepted at account opening; use 0 and 7) |
| 11 | Constitutive act (also valid for the condominium convention) |
| 12 | KYC report |
| 13 | Other |
| 14 | Selfie |
| 15 | Election minutes |
| 16 | Driver's license (CNH), back |
| 17 | Annual revenue (in Limit Management, for CNPJ) |
| 18 | Term of office of the head of the municipal executive branch |
| 19 | Term of office of the head of the municipal legislature |
| 20 | Act appointing the highest representative |
| 21 | Monthly income (in Limit Management, for CPF) |
| 22 | Digital certificate (not the same as a certidão) |
| 23 | Trade union statute |
| 24 | Minutes of the election and inauguration assembly |
| 25 | Religious organization statute |
| 26 | Minutes of appointment of the officer |
| 27 | Minutes of incorporation |
| 28 | Statement of responsibility |
| 29 | Business requirement document (Requerimento Empresarial) |
| 30 | CCMEI |
| 31 | Bylaws (Estatuto Social) |
| 32 | Financial statements |
| 33 | Proof of revenue and transfers |
| 34 | Annual budget |
| 35 | Fund regulation |
For ID (RG), always send types 0 (front) and 7 (back): type 10 (RG) is not accepted at account opening.
Documents that do not have their own number yet, such as the certificate (certidão), are currently sent with type 13 (Other). A number of their own will be defined in the future.
The errors for DocumentType in the limit change request are in the Error Catalogue, in the section ChangeAccountOperationLimit.
Document format
DocumentFormat field of the document upload and of the limit change request. The upload errors are in the Error Catalogue, in the section SendDocument and ResendDocuments.
| Value | Format |
|---|---|
| 0 | |
| 1 | JPG |
| 2 | JPEG |
| 3 | TXT |
| 4 | PNG |
| 5 | HEIC |
| 6 | DNG |
In the limit change request, value 3 (TXT) is rejected. PNG (value 4) is valid as long as it matches the content of the file.
KYC analysis classification
MessageClassification field of the UpdatePersonCondition webhook. What to do in each value is in Webhooks.
| Value | Status |
|---|---|
| 0 | DivergentInformation |
| 1 | Disapproved |
| 2 | InternalDisapproved |
| 3 | ExpiredDocument |
| 4 | ClientApproved |
Contract type
ContractType field of the UpdatePersonContract webhook. The digital contract and the notice of each status are in Webhooks.
| Value | Name in the system | Note |
|---|---|---|
| 0 | ClientRegister | Client registration. Does not follow the signature flow |
| 1 | Brand | Does not follow the signature flow |
| 2 | CloseLoop | Does not follow the signature flow |
| 3 | CustodyAccount | The only type that reaches the webhook today |
Today the UpdatePersonContract webhook is sent only with type 3 (CustodyAccount). Contracts of types 0 to 2 do not follow the signature flow and do not generate a notice.
Contract status
ContractStatus field of the UpdatePersonContract webhook. What to do in each status is in Webhooks.
| Value | Name in the system | Meaning | Generates a webhook notice |
|---|---|---|---|
| 0 | Created | Contract created after the KYC approval, still without a document | No |
| 1 | Generated | Contract document generated | No |
| 2 | Sent | Document sent to the buyer to be signed | Yes |
| 3 | Signed | The buyer signed | Yes |
| 4 | Ignored | Contract of a type that does not follow the signature flow | No |
| 5 | Error | Failure in generating or sending the contract | No |
| 6 | NotSigned | The buyer refused the document | Yes |
| 7 | WaitingKYC | Contract registered, waiting for the KYC approval | No |
| 8 | Expired | The signature period ended without the signature | Yes |
| 9 | Canceled | Contract canceled by Fits | No |
Only statuses 2, 3, 6 and 8 generate the UpdatePersonContract webhook. The others exist but do not generate a notice. Consider the contract signed only after status 3 (Signed).
Closing status
CloseAccountInformationStatus field of the UpdateCloseAccount webhook. What to do in each status is in Closing an Account.
| Value | Status |
|---|---|
| 0 | Created |
| 1 | Processing |
| 2 | Error |
| 3 | Pending |
| 4 | Disapproved: closing request disapproved |
| 5 | Approved: account closed |
| 6 | AutomaticClosingRequest |
Not all of these values generate notifications or are recorded by the flows. Closings of Locker accounts and closings made directly by the back office do not generate the UpdateCloseAccount webhook.
The CloseAccount errors are in the Error Catalogue, in the section CloseAccount.
Block reason
Justification field of BlockAccount, from 0 to 6. See Blocking and Unlocking. The errors are in the Error Catalogue, in the section BlockAccount and UnlockAccount.
| Value | Reason |
|---|---|
| 0 | Suspected fraud |
| 1 | Suspicious or irregular transaction |
| 2 | Non-compliance with policies or regulations |
| 3 | Customer request |
| 4 | Operational or financial risk management |
| 5 | Court order or legal proceeding |
| 6 | Other reasons |
The values of BlockAccount and UnlockAccount are independent: there is no correspondence between the block reason and the unlock justification.
Unlock justification
Justification field of UnlockAccount. See Blocking and Unlocking.
The values are independent of the block reasons. The UnlockAccount errors are in the Error Catalogue, in the section BlockAccount and UnlockAccount.
| Value | Name in the system | Description |
|---|---|---|
| 0 | Operational Error | Block made due to an operational error |
| 1 | Analysis Completed | Analysis completed: the reasons for the block no longer apply |
| 2 | Customer Request | Customer request |
| 3 | Judicial Order Compliance | Compliance with a court order |
| 4 | Risk Management Adjustment | Change in risk assessment or strategy |
| 5 | Other | Other reasons |
| 6 | Protege+ | Request for a new Protege+ check |
Role of the person
PersonRoleType field. When adding a signer, use one of these values. Value 0 (Holder) identifies the account owner and must not be sent as a signer (it returns EXE0054 or ISI0291):
| Value | Role |
|---|---|
| 1 | Attorney (Procurador) |
| 2 | Portador |
| 3 | Associate (Associado) |
| 4 | Manager (Dirigente) |
The AddSigner errors are in the Error Catalogue, in the section AddSigner.
Signer request status
SignerSolicitationStatus field of the FBWebhookWorkerUpdateSignerSolicitation webhook and RequestStatus field of GetRequestSigner. The values are texts, not numbers. The Gerada notice depends on the flow and the configuration and is not sent in every case. The GetRequestSigner errors are in the Error Catalogue, in the section GetSigners and GetRequestSigner.
| Status | Webhook | GetRequestSigner |
|---|---|---|
| Gerada | Yes | Yes |
| Sob análise interna | No | Yes |
| Aprovado | Yes | Yes |
| Reprovado | Yes | Yes |
| Pendente de Documentos | No | Yes |
| Erro | No | Yes |
Registration data changed
PersonInfoType field of ChangePersonInfo. The UpdatePersonInfo webhook sends the PersonInfoType as a name in text, for example Email or PhoneNumber. See Updating Registration Data. The full list, from 0 to 28, is below.
| Value | Data |
|---|---|
| 0 | Phone number (PhoneNumber) |
| 1 | Email (Email) |
| 2 | Nickname (NickName) |
| 3 | Father's name (FatherName) |
| 4 | Country of origin (Country) |
| 5 | State of birth (BirthState) |
| 6 | Gender (Gender) |
| 7 | Marital status (MaritalStatus) |
| 8 | Spouse's name (SpouseName) |
| 9 | Occupation (Occupation) |
| 10 | Politically exposed person (PubliclyExposedPerson) |
| 11 | Full name (FullName) |
| 12 | Date of birth (BirthDate) |
| 13 | Mother's name (MotherName) |
| 14 | Trade name (TradingName) |
| 15 | Constitution date (ConstitutionDate) |
| 16 | Monthly income or revenue (MonthlyIncome) |
| 17 | Company type (CompanyType) |
| 18 | Legal name (LegalName) |
| 19 | Main address line (AddressLine) |
| 20 | House number (AddressLine2) |
| 21 | Postal code (ZipCode) |
| 22 | City (CityName) |
| 23 | State (State) |
| 24 | Address type (AddressType) |
| 25 | Country of residence (CountryOfResidence) |
| 26 | Complement (Complement) |
| 27 | Reference (Reference) |
| 28 | Neighborhood (Neighborhood) |
Status per item of the registration change
PersonInfos[].Status field of the UpdatePersonInfo webhook. The value is sent as a name in text. See Updating Registration Data.
| Status | Meaning |
|---|---|
| Created | Request item created |
| Approved | Item approved |
| Rejected | Item rejected |
Limit type
Type field of ChangeAccountOperationLimit (in OperationLimitRequests) and of GetAccountOperationLimit. The fields of each method are in Limit Management.
| Value | Name in the system | Limit type |
|---|---|---|
| 0 | Daily | Daily |
| 1 | Weekly | Weekly |
| 2 | Monthly | Monthly |
| 3 | Overnight | Nighttime |
| 4 | SingleTransaction | Per transaction |
| 5 | DailySameTaxNumber | Daily for the same ownership |
| 6 | Favorite | For a favorited account |
Limit subtype
SubType field of ChangeAccountOperationLimit. Any other value generates an error; see the Error Catalogue, in the section ChangeAccountOperationLimit.
| Value | Name in the system | Subtype |
|---|---|---|
| 0 | Quantity | Quantity |
| 1 | Amount | Amount |
Limit increase justification
Justification field of ChangeAccountOperationLimit, from 0 to 7. It is mandatory and applies to the whole request. Any other value generates an error; see the Error Catalogue, in the section ChangeAccountOperationLimit.
| Value | Name in the system | Justification | When to use |
|---|---|---|---|
| 0 | Business | Business | To expand the business and buy additional equipment |
| 1 | Income | Income | The current limit does not match the income or the transactions |
| 2 | Emergency | Emergency | Situations of force majeure |
| 3 | Education | Education | To cover education expenses |
| 4 | Health | Health | Unexpected and emergency medical expenses |
| 5 | Travel | Travel | To finance an important trip |
| 6 | Renovation | Renovation | To cover maintenance or construction costs |
| 7 | Others | Others | Other reasons |
Operation type
OperationType field of ChangeAccountOperationLimit, GetAccountOperationLimit, AccountRate and AccountRateBatch. In ChangeAccountOperationLimit and AccountRate, the value must exist in this list; a value that is not in it is rejected (see the Error Catalogue, in the sections ChangeAccountOperationLimit and AccountRate and AccountRateBatch). The details of each method are in Limit Management and Account Rates.
| Value | Name in the system | Operation |
|---|---|---|
| 0 | PurchaseBoleto | Billing with boleto |
| 1 | PurchaseCard | Purchase with prepaid card |
| 2 | PaymentBoleto | Boleto payment |
| 3 | AccountDischarge | Transfer |
| 4 | MoneyTransferIn | Transfer to a Fits account (TED In) |
| 5 | PaymentDarf | DARF payment |
| 6 | InternalTransfer | Internal transfer |
| 7 | AccountDischargeOtherBanks | Transfer to other banks |
| 8 | PaymentGARE | GARE payment |
| 9 | PaymentGPS | GPS payment |
| 10 | PaymentTribute | Tax payment |
| 11 | PaymentFGTS | FGTS payment |
| 12 | PaymentDARJ | DARJ payment |
| 13 | TransferBySMS | Transfer via SMS |
| 16 | DischargePrepaidCard | Debit from the prepaid card |
| 17 | RechargePrepaidCard | Credit to the prepaid card |
| 18 | CreatePrepaidCardTax | Amount charged in the prepaid card creation fee |
| 19 | FuturePosting | Future posting |
| 20 | TransferOverhang | Transfer between agreements |
| 21 | LinkPrepaidCard | Fee to link prepaid cards |
| 22 | ChargeAccount | Monthly fee charge |
| 23 | DigitalWithdrawal | Digital withdrawal |
| 30 | WithdrawCard | Withdrawal with prepaid card |
| 32 | ChargebackCard | Chargeback with prepaid card |
| 33 | Purchase | P2P purchase |
| 35 | RequestCard | Card request |
| 36 | ActivateCard | Card activation |
| 37 | PurchaseTopUp | TopUp recharge |
| 38 | PaymentGRU | GRU payment |
| 39 | HashTransaction | Transfer via QR Code |
| 40 | PixOut | Pix payment |
| 41 | PixIn | Pix receipt |
| 42 | RefundPixIn | Refund of a Pix receipt |
| 43 | RefundPixOut | Refund of a Pix payment |
| 44 | QRCode | QR Code |
| 45 | PurchaseCloseLoop | Purchases with cashback |
| 46 | JudicialOrder | Court order |
| 47 | ReissueCard | Card reissue |
| 48 | MultiBenefitTransfer | Multi-benefit transfer |
| 49 | AccountCreationAndEditing | Account creation and editing |
| 50 | ChargebackCloseLoop | Cashback chargeback |
| 51 | PersonDocumentSendingAndResending | Document sending |
| 52 | PaymentOrder | Fee per payment order |
| 53 | CardTracking | Card tracking |
| 54 | CreateFraudNotification | Fraud notification registration |
| 55 | CancelFraudNotification | Fraud notification cancellation |
| 56 | AllOperations | All operations |
| 57 | UpdateCardContactless | Update of the contactless use of the card |
| 58 | OpenBanking | Open Banking |
| 59 | CourtOrder | |
| 60 | CollectionOrder | Fee per collection order |
| 61 | UpdatePersonCondition | Person status |
| 62 | SLC | Card Settlement Service |
| 65 | CashbackCard | Cashback with prepaid card |
| 66 | BinSponsor | |
| 67 | ClosedLoopBonusRate | MDR transfer (Closed Loop) |
| 68 | CloseAccount | Account closing |
| 69 | UpdatePersonInfo | Registration data change |
| 70 | FuturePostingConciliation | |
| 71 | ResponseDispute | Dispute response |
| 72 | TransferCard | Fee to deactivate and transfer a card |
| 73 | WireTransfer | Wire Transfer |
| 74 | WireTransferIn | |
| 75 | SendCredentialByWebhook | Sending of credentials by webhook |
| 76 | UpdateCloseAccount | Account closing update webhook |
| 77 | BillingFuturePosting | |
| 78 | SendMedLockResourceByWebhook | Automatic sending of a resource lock by webhook |
| 79 | UpdatePersonDocument | Document update |
| 80 | NotificationPaymentDelay | Payment delay notification |
| 81 | CreationP2P | Receipt of a recurring Pix scheduling |
| 82 | UpdateAccount | Account update webhook |
| 85 | PixRecurrence | Recurring scheduled Pix |
| 86 | EntryOrder | |
| 87 | UnlockCourtOrder | Court order unlock |
| 88 | CancelCourtOrder | Court order cancellation |
| 89 | PaymentDV | Vehicle debit |
| 90 | AccountOperationLimitChange | Account operation limit change webhook |
| 91 | DepositClosedLoop | |
| 92 | WithdrawalClosedLoop | |
| 93 | CreateCardAccount | Card account creation |
| 94 | AccountContractDigital | Digital contract account |
| 95 | SendMedUnlockResourceByWebhook | Automatic sending of a resource unlock by webhook |
| 96 | CopyAndPurge | |
| 97 | ClosedBusinessUnit | |
| 98 | RefundWireTransferIn | |
| 99 | CardStatus | Card status |
| 100 | KYC | |
| 101 | PixAutomatic | Pix Automático |
| 102 | CollectionOrderPayer | |
| 103 | CardAction | Card action |
| 104 | PixKey | |
| 105 | PixKeyAction | |
| 106 | BillingKYC | |
| 107 | VirtualCardAction | Virtual card action |
| 108 | FuturePostingBillingPending | |
| 109 | RechargeCard | Card recharge |
| 110 | DischargeCard | Card discharge |
| 111 | PurchaseCardError | Card purchase error |
| 112 | UpdateSignerSolicitation | Signer request |
| 113 | GenerateUpdateHistory | |
| 114 | UpdatePaymentOrderFile | Payment order files |
| 115 | UpdateBeneficiaryStatus | Beneficiary status update |
| 116 | UpdateElectronicPayer | Electronic payer update |
| 117 | UpdateUser | |
| 118 | UpdatePersonContract | Digital contract |
| 119 | NewAccountV3 | |
| 120 | StatementAsyncInformation | Asynchronous statement webhook |
| 121 | ElectronicPayerAlert | Alerts for the electronic payer |
| 122 | PixFundsRecovery | Recovery of funds |
| 123 | PixRecovery | Pix recovery |
| 124 | PixAutomaticToPayer | Pix Automático for the payer |
| 125 | PixAutomaticToReceiver | Pix Automático for the receiver |
Updated 11 days ago

