Reference

Customer Data

View as Markdown

Data Types

Data types currently supported by BRIJ:

ValueDescription
EMAILCustomer’s email address
PHONECustomer’s phone number
NAMECustomer’s full name
ID_DOCUMENTIdentity document (passport, driver’s license)
OCCUPATIONCurrent occupation
BANK_ACCOUNTBank account details
SELFIEPhoto of the customer
BIRTH_DATEDate of birth
NATIONALITYCustomer’s nationality
TAX_IDTax identification number
CRYPTO_WALLETCryptocurrency wallet address
RESIDENTIAL_ADDRESSCurrent residential address
INTERMEDIARYIntermediary or representative information
EMPLOYMENT_STATUSCurrent employment status
ACCOUNT_PURPOSEIntended purpose for the account
EXPECTED_MONTHLY_PAYMENTSExpected monthly transaction volume
SOURCE_OF_FUNDSSource of funds for transactions
LAST_OCCUPATIONPrevious occupation

Data Schemas

Each data type has a specific schema. The field name in the response matches the camelCase version of the data type.

Email

Field name: email

FieldTypeDescription
valuestringThe email address

Phone

Field name: phone

FieldTypeDescription
countryCodestringCountry calling code (e.g., “1”)
numberstringPhone number without country code

Name

Field name: name

FieldTypeDescription
firstNamestringCustomer’s first name
lastNamestringCustomer’s last name

Nationality

Field name: nationality

FieldTypeDescription
countrystringISO 3166-1 alpha-3 country code

BirthDate

Field name: birthDate

FieldTypeDescription
datestringDate in ISO 8601 format (YYYY-MM-DD)

IdDocument

Field name: idDocument

FieldTypeDescription
documentTypestringType of document (see below)
documentNumberstringDocument identification number
issuingCountrystringISO 3166-1 alpha-3 country code
expiryDatestringExpiration date in ISO 8601 format
frontSideImagebytesFront side image data
frontSideImageHashstringHash of the front side image
backSideImagebytesBack side image data
backSideImageHashstringHash of the back side image

Document Types:

ValueDescription
PASSPORTPassport
DRIVERS_LICENSEDriver’s license
ID_CARDNational ID card
RESIDENCE_PERMITResidence permit

Occupation

Field name: occupation

FieldTypeDescription
jobTitlestringJob title
companyNamestringName of the employer
industrystringIndustry sector
employmentStatusstringEmployment status (e.g., “EMPLOYED”, “STUDENT”)

BankAccount

Field name: bankAccount

FieldTypeDescription
addressobjectAddress associated with the account (see Address)
accountOwnerNamestringName of the account owner
currencystringCurrency code
bankNamestringName of the bank
ownerTypestringINDIVIDUAL or BUSINESS
firstNamestringAccount holder’s first name
lastNamestringAccount holder’s last name
businessNamestringBusiness name (if business account)

One of the following account type objects will be present:

ACH (US): ach

FieldTypeDescription
accountNumberstringAccount number
routingNumberstringABA routing number

IBAN (International): iban

FieldTypeDescription
accountNumberstringIBAN account number
countrystringCountry code
bicstringBIC/SWIFT code

CLABE (Mexico): clabe

FieldTypeDescription
accountNumberstringCLABE account number

PIX (Brazil): pix

FieldTypeDescription
pixKeystringPIX key (if using key)
brCodestringBR Code (if using QR code)
documentNumberstringCPF/CNPJ document number

NUBAN (Nigeria): nuban

FieldTypeDescription
accountNumberstringAccount number
bankCodestringBank code

Selfie

Field name: selfie

FieldTypeDescription
imagebytesSelfie image data
imageHashstringHash of the image

TaxId

Field name: taxId

FieldTypeDescription
countrystringISO 3166-1 alpha-3 country code
typestringTax ID type (e.g., “SSN”, “EIN”, “VAT”)
numberstringTax identification number
customTypestringCustom type description (if type is custom)

CryptoWallet

Field name: cryptoWallet

FieldTypeDescription
addressstringWallet address
typestringBlockchain type (see below)

Wallet Types:

ValueDescription
SOLANASolana
BITCOINBitcoin
ETHEREUMEthereum
BSCBNB Chain
POLYGONPolygon
ARBITRUMArbitrum
BASEBase
OPTIMISMOptimism
AVALANCHEAvalanche
TRONTron
TONTON

Address (Residential Address)

Field name: residentialAddress

FieldTypeDescription
streetLine1stringStreet address line 1
streetLine2stringStreet address line 2
citystringCity
postalCodestringPostal/ZIP code
countrystringISO 3166-1 alpha-3 country code
subdivisionstringState/province/region (ISO 3166-2 format)

Intermediary

Field name: intermediary

FieldTypeDescription
isIntermediarybooleanWhether the customer is acting as intermediary

EmploymentStatus

Field name: employmentStatus

One of the following will be present:

FieldTypeDescription
typestringEmployment type (see below)
otherstringCustom employment status if “other”

Employment Types:

ValueDescription
EMPLOYEDEmployed
SELF_EMPLOYEDSelf-employed
BUSINESS_OWNERBusiness owner
RETIREDRetired
UNEMPLOYEDUnemployed
HOMEMAKERHomemaker
STUDENTStudent

AccountPurpose

Field name: accountPurpose

One of the following will be present:

FieldTypeDescription
typestringAccount purpose type (see below)
otherstringCustom purpose if “other”

Account Purpose Types:

ValueDescription
INVESTMENTInvestment
SAVINGSSavings
PAYMENTSPayments
REMITTANCESRemittances
EXPENSESExpenses
FREELANCINGFreelancing
SALARYSalary

ExpectedMonthlyPayments

Field name: expectedMonthlyPayments

FieldTypeDescription
categorystringPayment volume category (see below)

Categories:

ValueDescription
USD_0K_1K0−0 - 1,000
USD_1K_10K1,000−1,000 - 10,000
USD_10K_50K10,000−10,000 - 50,000
USD_50K_200K50,000−50,000 - 200,000
USD_200K_PLUS$200,000+

SourceOfFunds

Field name: sourceOfFunds

FieldTypeDescription
typestringSource of funds type (see below)

Source of Funds Types:

ValueDescription
EMPLOYMENT_SALARYSalary, bonuses, incentives
EMPLOYMENT_FREELANCINGFreelancing / self-employment
EMPLOYMENT_PROFESSIONAL_FEESProfessional fees (consultants, contractors)
BUSINESS_PROFITSProfits from a company owned by the client
BUSINESS_DIVIDENDSDividends, distributions
BUSINESS_PROCEEDSGeneral business proceeds
SAVINGS_BANK_ACCOUNTSBank savings accounts
SAVINGS_FINANCIAL_INVESTMENTSFinancial investments (stocks, bonds, funds)
SAVINGS_INTEREST_GAINSInterest, coupons, capital gains on securities
SALE_OF_ASSETSSale of tangible assets (real estate, vehicles)
FAMILY_INHERITANCEInheritance, succession, legacy
FAMILY_DONATIONSDonations / one-time gifts
FAMILY_ALLOWANCEAllowance / regular family support
COMPENSATION_SEVERANCESeverance payments
COMPENSATION_INSURANCEInsurance compensation
COMPENSATION_LEGAL_SETTLEMENTSLegal settlements / damages
LOANS_BANKBank loans (personal, consumer, mortgage)
LOANS_PRIVATE_FAMILYPrivate / family loans
LOANS_P2P_MICROFINANCEP2P or microfinance loans
PENSIONS_RETIREMENTRetirement pensions
PENSIONS_SOCIAL_BENEFITSSocial benefits (unemployment, disability, welfare)
CRYPTO_TRADING_PROFITSTrading profits (fiat-to-crypto or crypto-to-crypto)
CRYPTO_NFT_SALESSale of NFTs
CRYPTO_STAKING_INCOMEStaking, farming, lending, mining income
CRYPTO_EXTERNAL_WALLETSDeposits from external crypto wallets
CRYPTO_EXCHANGESDeposits from other centralized exchanges
CRYPTO_ICO_DEFIICO/IDO/DeFi gains

LastOccupation

Field name: lastOccupation

FieldTypeDescription
codestring6-digit occupation code (e.g., “111011” for CEO)