# Customer Data

## Data Types

Data types currently supported by BRIJ:

| Value                       | Description                                    |
| --------------------------- | ---------------------------------------------- |
| `EMAIL`                     | Customer's email address                       |
| `PHONE`                     | Customer's phone number                        |
| `NAME`                      | Customer's full name                           |
| `ID_DOCUMENT`               | Identity document (passport, driver's license) |
| `OCCUPATION`                | Current occupation                             |
| `BANK_ACCOUNT`              | Bank account details                           |
| `SELFIE`                    | Photo of the customer                          |
| `BIRTH_DATE`                | Date of birth                                  |
| `NATIONALITY`               | Customer's nationality                         |
| `TAX_ID`                    | Tax identification number                      |
| `CRYPTO_WALLET`             | Cryptocurrency wallet address                  |
| `RESIDENTIAL_ADDRESS`       | Current residential address                    |
| `INTERMEDIARY`              | Intermediary or representative information     |
| `EMPLOYMENT_STATUS`         | Current employment status                      |
| `ACCOUNT_PURPOSE`           | Intended purpose for the account               |
| `EXPECTED_MONTHLY_PAYMENTS` | Expected monthly transaction volume            |
| `SOURCE_OF_FUNDS`           | Source of funds for transactions               |
| `LAST_OCCUPATION`           | Previous 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`

| Field   | Type   | Description       |
| ------- | ------ | ----------------- |
| `value` | string | The email address |

### Phone

Field name: `phone`

| Field         | Type   | Description                       |
| ------------- | ------ | --------------------------------- |
| `countryCode` | string | Country calling code (e.g., "1")  |
| `number`      | string | Phone number without country code |

### Name

Field name: `name`

| Field       | Type   | Description           |
| ----------- | ------ | --------------------- |
| `firstName` | string | Customer's first name |
| `lastName`  | string | Customer's last name  |

### Nationality

Field name: `nationality`

| Field     | Type   | Description                     |
| --------- | ------ | ------------------------------- |
| `country` | string | ISO 3166-1 alpha-3 country code |

### BirthDate

Field name: `birthDate`

| Field  | Type   | Description                          |
| ------ | ------ | ------------------------------------ |
| `date` | string | Date in ISO 8601 format (YYYY-MM-DD) |

### IdDocument

Field name: `idDocument`

| Field                | Type   | Description                        |
| -------------------- | ------ | ---------------------------------- |
| `documentType`       | string | Type of document (see below)       |
| `documentNumber`     | string | Document identification number     |
| `issuingCountry`     | string | ISO 3166-1 alpha-3 country code    |
| `expiryDate`         | string | Expiration date in ISO 8601 format |
| `frontSideImage`     | bytes  | Front side image data              |
| `frontSideImageHash` | string | Hash of the front side image       |
| `backSideImage`      | bytes  | Back side image data               |
| `backSideImageHash`  | string | Hash of the back side image        |

**Document Types:**

| Value              | Description      |
| ------------------ | ---------------- |
| `PASSPORT`         | Passport         |
| `DRIVERS_LICENSE`  | Driver's license |
| `ID_CARD`          | National ID card |
| `RESIDENCE_PERMIT` | Residence permit |

### Occupation

Field name: `occupation`

| Field              | Type   | Description                                     |
| ------------------ | ------ | ----------------------------------------------- |
| `jobTitle`         | string | Job title                                       |
| `companyName`      | string | Name of the employer                            |
| `industry`         | string | Industry sector                                 |
| `employmentStatus` | string | Employment status (e.g., "EMPLOYED", "STUDENT") |

### BankAccount

Field name: `bankAccount`

| Field              | Type   | Description                                       |
| ------------------ | ------ | ------------------------------------------------- |
| `address`          | object | Address associated with the account (see Address) |
| `accountOwnerName` | string | Name of the account owner                         |
| `currency`         | string | Currency code                                     |
| `bankName`         | string | Name of the bank                                  |
| `ownerType`        | string | `INDIVIDUAL` or `BUSINESS`                        |
| `firstName`        | string | Account holder's first name                       |
| `lastName`         | string | Account holder's last name                        |
| `businessName`     | string | Business name (if business account)               |

One of the following account type objects will be present:

**ACH (US):** `ach`

| Field           | Type   | Description        |
| --------------- | ------ | ------------------ |
| `accountNumber` | string | Account number     |
| `routingNumber` | string | ABA routing number |

**IBAN (International):** `iban`

| Field           | Type   | Description         |
| --------------- | ------ | ------------------- |
| `accountNumber` | string | IBAN account number |
| `country`       | string | Country code        |
| `bic`           | string | BIC/SWIFT code      |

**CLABE (Mexico):** `clabe`

| Field           | Type   | Description          |
| --------------- | ------ | -------------------- |
| `accountNumber` | string | CLABE account number |

**PIX (Brazil):** `pix`

| Field            | Type   | Description                |
| ---------------- | ------ | -------------------------- |
| `pixKey`         | string | PIX key (if using key)     |
| `brCode`         | string | BR Code (if using QR code) |
| `documentNumber` | string | CPF/CNPJ document number   |

**NUBAN (Nigeria):** `nuban`

| Field           | Type   | Description    |
| --------------- | ------ | -------------- |
| `accountNumber` | string | Account number |
| `bankCode`      | string | Bank code      |

### Selfie

Field name: `selfie`

| Field       | Type   | Description       |
| ----------- | ------ | ----------------- |
| `image`     | bytes  | Selfie image data |
| `imageHash` | string | Hash of the image |

### TaxId

Field name: `taxId`

| Field        | Type   | Description                                 |
| ------------ | ------ | ------------------------------------------- |
| `country`    | string | ISO 3166-1 alpha-3 country code             |
| `type`       | string | Tax ID type (e.g., "SSN", "EIN", "VAT")     |
| `number`     | string | Tax identification number                   |
| `customType` | string | Custom type description (if type is custom) |

### CryptoWallet

Field name: `cryptoWallet`

| Field     | Type   | Description                 |
| --------- | ------ | --------------------------- |
| `address` | string | Wallet address              |
| `type`    | string | Blockchain type (see below) |

**Wallet Types:**

| Value       | Description |
| ----------- | ----------- |
| `SOLANA`    | Solana      |
| `BITCOIN`   | Bitcoin     |
| `ETHEREUM`  | Ethereum    |
| `BSC`       | BNB Chain   |
| `POLYGON`   | Polygon     |
| `ARBITRUM`  | Arbitrum    |
| `BASE`      | Base        |
| `OPTIMISM`  | Optimism    |
| `AVALANCHE` | Avalanche   |
| `TRON`      | Tron        |
| `TON`       | TON         |

### Address (Residential Address)

Field name: `residentialAddress`

| Field         | Type   | Description                               |
| ------------- | ------ | ----------------------------------------- |
| `streetLine1` | string | Street address line 1                     |
| `streetLine2` | string | Street address line 2                     |
| `city`        | string | City                                      |
| `postalCode`  | string | Postal/ZIP code                           |
| `country`     | string | ISO 3166-1 alpha-3 country code           |
| `subdivision` | string | State/province/region (ISO 3166-2 format) |

### Intermediary

Field name: `intermediary`

| Field            | Type    | Description                                    |
| ---------------- | ------- | ---------------------------------------------- |
| `isIntermediary` | boolean | Whether the customer is acting as intermediary |

### EmploymentStatus

Field name: `employmentStatus`

One of the following will be present:

| Field   | Type   | Description                         |
| ------- | ------ | ----------------------------------- |
| `type`  | string | Employment type (see below)         |
| `other` | string | Custom employment status if "other" |

**Employment Types:**

| Value            | Description    |
| ---------------- | -------------- |
| `EMPLOYED`       | Employed       |
| `SELF_EMPLOYED`  | Self-employed  |
| `BUSINESS_OWNER` | Business owner |
| `RETIRED`        | Retired        |
| `UNEMPLOYED`     | Unemployed     |
| `HOMEMAKER`      | Homemaker      |
| `STUDENT`        | Student        |

### AccountPurpose

Field name: `accountPurpose`

One of the following will be present:

| Field   | Type   | Description                      |
| ------- | ------ | -------------------------------- |
| `type`  | string | Account purpose type (see below) |
| `other` | string | Custom purpose if "other"        |

**Account Purpose Types:**

| Value         | Description |
| ------------- | ----------- |
| `INVESTMENT`  | Investment  |
| `SAVINGS`     | Savings     |
| `PAYMENTS`    | Payments    |
| `REMITTANCES` | Remittances |
| `EXPENSES`    | Expenses    |
| `FREELANCING` | Freelancing |
| `SALARY`      | Salary      |

### ExpectedMonthlyPayments

Field name: `expectedMonthlyPayments`

| Field      | Type   | Description                         |
| ---------- | ------ | ----------------------------------- |
| `category` | string | Payment volume category (see below) |

**Categories:**

| Value           | Description        |
| --------------- | ------------------ |
| `USD_0K_1K`     | $0 - $1,000        |
| `USD_1K_10K`    | $1,000 - $10,000   |
| `USD_10K_50K`   | $10,000 - $50,000  |
| `USD_50K_200K`  | $50,000 - $200,000 |
| `USD_200K_PLUS` | \$200,000+         |

### SourceOfFunds

Field name: `sourceOfFunds`

| Field  | Type   | Description                      |
| ------ | ------ | -------------------------------- |
| `type` | string | Source of funds type (see below) |

**Source of Funds Types:**

| Value                            | Description                                          |
| -------------------------------- | ---------------------------------------------------- |
| `EMPLOYMENT_SALARY`              | Salary, bonuses, incentives                          |
| `EMPLOYMENT_FREELANCING`         | Freelancing / self-employment                        |
| `EMPLOYMENT_PROFESSIONAL_FEES`   | Professional fees (consultants, contractors)         |
| `BUSINESS_PROFITS`               | Profits from a company owned by the client           |
| `BUSINESS_DIVIDENDS`             | Dividends, distributions                             |
| `BUSINESS_PROCEEDS`              | General business proceeds                            |
| `SAVINGS_BANK_ACCOUNTS`          | Bank savings accounts                                |
| `SAVINGS_FINANCIAL_INVESTMENTS`  | Financial investments (stocks, bonds, funds)         |
| `SAVINGS_INTEREST_GAINS`         | Interest, coupons, capital gains on securities       |
| `SALE_OF_ASSETS`                 | Sale of tangible assets (real estate, vehicles)      |
| `FAMILY_INHERITANCE`             | Inheritance, succession, legacy                      |
| `FAMILY_DONATIONS`               | Donations / one-time gifts                           |
| `FAMILY_ALLOWANCE`               | Allowance / regular family support                   |
| `COMPENSATION_SEVERANCE`         | Severance payments                                   |
| `COMPENSATION_INSURANCE`         | Insurance compensation                               |
| `COMPENSATION_LEGAL_SETTLEMENTS` | Legal settlements / damages                          |
| `LOANS_BANK`                     | Bank loans (personal, consumer, mortgage)            |
| `LOANS_PRIVATE_FAMILY`           | Private / family loans                               |
| `LOANS_P2P_MICROFINANCE`         | P2P or microfinance loans                            |
| `PENSIONS_RETIREMENT`            | Retirement pensions                                  |
| `PENSIONS_SOCIAL_BENEFITS`       | Social benefits (unemployment, disability, welfare)  |
| `CRYPTO_TRADING_PROFITS`         | Trading profits (fiat-to-crypto or crypto-to-crypto) |
| `CRYPTO_NFT_SALES`               | Sale of NFTs                                         |
| `CRYPTO_STAKING_INCOME`          | Staking, farming, lending, mining income             |
| `CRYPTO_EXTERNAL_WALLETS`        | Deposits from external crypto wallets                |
| `CRYPTO_EXCHANGES`               | Deposits from other centralized exchanges            |
| `CRYPTO_ICO_DEFI`                | ICO/IDO/DeFi gains                                   |

### LastOccupation

Field name: `lastOccupation`

| Field  | Type   | Description                                      |
| ------ | ------ | ------------------------------------------------ |
| `code` | string | 6-digit occupation code (e.g., "111011" for CEO) |