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 condition

AccountConditionType field of the account webhook. The meaning of each condition is in Account Status.

ValueName in the systemCondition
0CreatedUnder review
1LimitedLimited
2VerifiedVerified
3BlockedBlocked

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.

ValueName in the systemStatus
0DisabledDisabled
1EnabledActive

Document status

DocumentStatus field of the documents webhook. What to do in each status is in Pending Documents.

ValueStatus
0AwaitingValidation
1Validated
2Invalid
3Expired
4Sent
5Resubmitted
6Disapproved
7Error
8Inexistent
9Suspended
10TypificationResult

Document type

DocumentType field. The documents required for each account type are in Required Documents.

ValueDocument
0ID (RG), front
1Taxpayer ID (CPF)
2Proof of address
3Driver's license (CNH), front
4Company taxpayer ID (CNPJ)
5Articles of association (Contrato Social)
6Power of attorney
7ID (RG), back
8Internal use (Error); do not use at account opening
9Does not exist
10ID (RG) (not accepted at account opening; use 0 and 7)
11Constitutive act (also valid for the condominium convention)
12KYC report
13Other
14Selfie
15Election minutes
16Driver's license (CNH), back
17Annual revenue (in Limit Management, for CNPJ)
18Term of office of the head of the municipal executive branch
19Term of office of the head of the municipal legislature
20Act appointing the highest representative
21Monthly income (in Limit Management, for CPF)
22Digital certificate (not the same as a certidão)
23Trade union statute
24Minutes of the election and inauguration assembly
25Religious organization statute
26Minutes of appointment of the officer
27Minutes of incorporation
28Statement of responsibility
29Business requirement document (Requerimento Empresarial)
30CCMEI
31Bylaws (Estatuto Social)
32Financial statements
33Proof of revenue and transfers
34Annual budget
35Fund 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.

ValueFormat
0PDF
1JPG
2JPEG
3TXT
4PNG
5HEIC
6DNG

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.

ValueStatus
0DivergentInformation
1Disapproved
2InternalDisapproved
3ExpiredDocument
4ClientApproved

Contract type

ContractType field of the UpdatePersonContract webhook. The digital contract and the notice of each status are in Webhooks.

ValueName in the systemNote
0ClientRegisterClient registration. Does not follow the signature flow
1BrandDoes not follow the signature flow
2CloseLoopDoes not follow the signature flow
3CustodyAccountThe 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.

ValueName in the systemMeaningGenerates a webhook notice
0CreatedContract created after the KYC approval, still without a documentNo
1GeneratedContract document generatedNo
2SentDocument sent to the buyer to be signedYes
3SignedThe buyer signedYes
4IgnoredContract of a type that does not follow the signature flowNo
5ErrorFailure in generating or sending the contractNo
6NotSignedThe buyer refused the documentYes
7WaitingKYCContract registered, waiting for the KYC approvalNo
8ExpiredThe signature period ended without the signatureYes
9CanceledContract canceled by FitsNo

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.

ValueStatus
0Created
1Processing
2Error
3Pending
4Disapproved: closing request disapproved
5Approved: account closed
6AutomaticClosingRequest

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.

ValueReason
0Suspected fraud
1Suspicious or irregular transaction
2Non-compliance with policies or regulations
3Customer request
4Operational or financial risk management
5Court order or legal proceeding
6Other 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.

ValueName in the systemDescription
0Operational ErrorBlock made due to an operational error
1Analysis CompletedAnalysis completed: the reasons for the block no longer apply
2Customer RequestCustomer request
3Judicial Order ComplianceCompliance with a court order
4Risk Management AdjustmentChange in risk assessment or strategy
5OtherOther reasons
6Protege+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):

ValueRole
1Attorney (Procurador)
2Portador
3Associate (Associado)
4Manager (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.

StatusWebhookGetRequestSigner
GeradaYesYes
Sob análise internaNoYes
AprovadoYesYes
ReprovadoYesYes
Pendente de DocumentosNoYes
ErroNoYes

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.

ValueData
0Phone number (PhoneNumber)
1Email (Email)
2Nickname (NickName)
3Father's name (FatherName)
4Country of origin (Country)
5State of birth (BirthState)
6Gender (Gender)
7Marital status (MaritalStatus)
8Spouse's name (SpouseName)
9Occupation (Occupation)
10Politically exposed person (PubliclyExposedPerson)
11Full name (FullName)
12Date of birth (BirthDate)
13Mother's name (MotherName)
14Trade name (TradingName)
15Constitution date (ConstitutionDate)
16Monthly income or revenue (MonthlyIncome)
17Company type (CompanyType)
18Legal name (LegalName)
19Main address line (AddressLine)
20House number (AddressLine2)
21Postal code (ZipCode)
22City (CityName)
23State (State)
24Address type (AddressType)
25Country of residence (CountryOfResidence)
26Complement (Complement)
27Reference (Reference)
28Neighborhood (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.

StatusMeaning
CreatedRequest item created
ApprovedItem approved
RejectedItem rejected

Limit type

Type field of ChangeAccountOperationLimit (in OperationLimitRequests) and of GetAccountOperationLimit. The fields of each method are in Limit Management.

ValueName in the systemLimit type
0DailyDaily
1WeeklyWeekly
2MonthlyMonthly
3OvernightNighttime
4SingleTransactionPer transaction
5DailySameTaxNumberDaily for the same ownership
6FavoriteFor a favorited account

Limit subtype

SubType field of ChangeAccountOperationLimit. Any other value generates an error; see the Error Catalogue, in the section ChangeAccountOperationLimit.

ValueName in the systemSubtype
0QuantityQuantity
1AmountAmount

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.

ValueName in the systemJustificationWhen to use
0BusinessBusinessTo expand the business and buy additional equipment
1IncomeIncomeThe current limit does not match the income or the transactions
2EmergencyEmergencySituations of force majeure
3EducationEducationTo cover education expenses
4HealthHealthUnexpected and emergency medical expenses
5TravelTravelTo finance an important trip
6RenovationRenovationTo cover maintenance or construction costs
7OthersOthersOther 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.

ValueName in the systemOperation
0PurchaseBoletoBilling with boleto
1PurchaseCardPurchase with prepaid card
2PaymentBoletoBoleto payment
3AccountDischargeTransfer
4MoneyTransferInTransfer to a Fits account (TED In)
5PaymentDarfDARF payment
6InternalTransferInternal transfer
7AccountDischargeOtherBanksTransfer to other banks
8PaymentGAREGARE payment
9PaymentGPSGPS payment
10PaymentTributeTax payment
11PaymentFGTSFGTS payment
12PaymentDARJDARJ payment
13TransferBySMSTransfer via SMS
16DischargePrepaidCardDebit from the prepaid card
17RechargePrepaidCardCredit to the prepaid card
18CreatePrepaidCardTaxAmount charged in the prepaid card creation fee
19FuturePostingFuture posting
20TransferOverhangTransfer between agreements
21LinkPrepaidCardFee to link prepaid cards
22ChargeAccountMonthly fee charge
23DigitalWithdrawalDigital withdrawal
30WithdrawCardWithdrawal with prepaid card
32ChargebackCardChargeback with prepaid card
33PurchaseP2P purchase
35RequestCardCard request
36ActivateCardCard activation
37PurchaseTopUpTopUp recharge
38PaymentGRUGRU payment
39HashTransactionTransfer via QR Code
40PixOutPix payment
41PixInPix receipt
42RefundPixInRefund of a Pix receipt
43RefundPixOutRefund of a Pix payment
44QRCodeQR Code
45PurchaseCloseLoopPurchases with cashback
46JudicialOrderCourt order
47ReissueCardCard reissue
48MultiBenefitTransferMulti-benefit transfer
49AccountCreationAndEditingAccount creation and editing
50ChargebackCloseLoopCashback chargeback
51PersonDocumentSendingAndResendingDocument sending
52PaymentOrderFee per payment order
53CardTrackingCard tracking
54CreateFraudNotificationFraud notification registration
55CancelFraudNotificationFraud notification cancellation
56AllOperationsAll operations
57UpdateCardContactlessUpdate of the contactless use of the card
58OpenBankingOpen Banking
59CourtOrder
60CollectionOrderFee per collection order
61UpdatePersonConditionPerson status
62SLCCard Settlement Service
65CashbackCardCashback with prepaid card
66BinSponsor
67ClosedLoopBonusRateMDR transfer (Closed Loop)
68CloseAccountAccount closing
69UpdatePersonInfoRegistration data change
70FuturePostingConciliation
71ResponseDisputeDispute response
72TransferCardFee to deactivate and transfer a card
73WireTransferWire Transfer
74WireTransferIn
75SendCredentialByWebhookSending of credentials by webhook
76UpdateCloseAccountAccount closing update webhook
77BillingFuturePosting
78SendMedLockResourceByWebhookAutomatic sending of a resource lock by webhook
79UpdatePersonDocumentDocument update
80NotificationPaymentDelayPayment delay notification
81CreationP2PReceipt of a recurring Pix scheduling
82UpdateAccountAccount update webhook
85PixRecurrenceRecurring scheduled Pix
86EntryOrder
87UnlockCourtOrderCourt order unlock
88CancelCourtOrderCourt order cancellation
89PaymentDVVehicle debit
90AccountOperationLimitChangeAccount operation limit change webhook
91DepositClosedLoop
92WithdrawalClosedLoop
93CreateCardAccountCard account creation
94AccountContractDigitalDigital contract account
95SendMedUnlockResourceByWebhookAutomatic sending of a resource unlock by webhook
96CopyAndPurge
97ClosedBusinessUnit
98RefundWireTransferIn
99CardStatusCard status
100KYC
101PixAutomaticPix Automático
102CollectionOrderPayer
103CardActionCard action
104PixKey
105PixKeyAction
106BillingKYC
107VirtualCardActionVirtual card action
108FuturePostingBillingPending
109RechargeCardCard recharge
110DischargeCardCard discharge
111PurchaseCardErrorCard purchase error
112UpdateSignerSolicitationSigner request
113GenerateUpdateHistory
114UpdatePaymentOrderFilePayment order files
115UpdateBeneficiaryStatusBeneficiary status update
116UpdateElectronicPayerElectronic payer update
117UpdateUser
118UpdatePersonContractDigital contract
119NewAccountV3
120StatementAsyncInformationAsynchronous statement webhook
121ElectronicPayerAlertAlerts for the electronic payer
122PixFundsRecoveryRecovery of funds
123PixRecoveryPix recovery
124PixAutomaticToPayerPix Automático for the payer
125PixAutomaticToReceiverPix Automático for the receiver

Did this page help you?