# User Object {% tabs %} {% tab title="Details" %} | **Field** | **Required** | **Type** | **Description** | | ----------------------------------------- | --------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | mobile\_phone | Yes | Numeric | 10-15 digits phone number | | email | Yes | String | Email address | | first\_name | Yes | String | First name or name of the business. | | middle\_name | No | String | Middle name | | last\_name | Yes, if individual | String | Family name | | gender | Yes, if individual | String | Male, female, other. *Not mandatory for user registration but needed before user KYC is initiated.* | | date\_of\_birth | Yes | String | Birth date of individual or Day of formation for business in yyyy-MM-dd format. *Not mandatory for user registration but needs to be collected before user KYC/KYB is initiated.* | | business | Yes | Boolean | By default false. Required to send True if user is a business. | | business\_type | Yes, if Business | Category |

Example : LLC, PARTNERSHIP, SOLE-PROPRIETORSHIP, etc.

Note : Details provided below.

| | user\_scope | Yes, if Business | Category |

Nature of business. Not mandatory for registration but needed before user KYC/KYB is initiated.

Note : Details below

| | address\_line1 | Yes | String | Address of individual/business. *Not mandatory for registration but needed before user KYC/KYB is initiated.* | | address\_line2 | No | String | Street address of the individual/business | | city | Yes | String | City of residence of the individual or registered city of the business. | | state | Yes | String | 2-letter ISO code of the user's state. | | country | Yes | String | 2-letter ISO code of user's country. | | zipcode | Yes | String | Zip code of the user's address. | | mailing\_address | Yes, if business | String | Company's mailing address. Address\_line1, address\_line2, city, state, country & zipcode. *Not mandatory for registration but needed before user KYC/KYB is initiated.* | | status | In response | Category |

KYC/KYB Status of the user. For unverified user, KYC/KYB is not done.

Enumerated value: UNVERIFIED, VERIFIED, REVIEW\_PENDING, SUSPENDED, IN\_PROGRESS, RETRY.

| | ip\_address | Yes | String | IP of the user. | | occupation | Conditional | String | User’s occupation. *This field may be required for KYC/KYB based on your spec sheet.* | | type | Yes | Category | Enumerated Value : ‘SEND’ , ‘RECEIVE’ | | created\_at | In Response | String | Date and time of user’s registration | | company\_website | Yes, if business with `deposit_enabled`: true | String |

Company's offical website. This field is not mandatory for user registration but needs to be collected before user KYB is initiated.

For other business users, this field may be required for KYB based on your spec sheet.

| | number\_of\_employee | Yes, if business | Category | Enum Values: ‘LESS\_THAN\_25’, ‘BETWEEN\_25\_TO\_50’, ‘MORE\_THAN\_50’. *This field is not mandatory for user registration but needs to be collected before user KYB is initiated.* | | **physical\_documents** | Yes, if business with `deposit_enabled`: true | **Object** | **Copy of a document. *****This field may be required for KYC/KYB based on your spec sheet.*** | | physical\_documents.document\_type | Yes, if physical\_document is required | String | Enumerated value. Note: Details provided below. | | physical\_documents.document\_value | Yes, if physical\_document is required | String | Value of the document. Documents must be encoded Base64 before being uploaded to our system. | | physical\_documents.document\_value\_back | Conditional | String | Value of the rear side of the document. Documents must be encoded Base64 before being uploaded to our system. | | physical\_documents.country | Conditional | String | 2-letter ISO code of the user’s country. | | physical\_documents.state | Conditional | String | 2-letter ISO code of the user’s state. | | physical\_documents.expiry\_date | Conditional | String | Date of expiry of the document. | | **virtual\_documents** | Yes, if business with `deposit_enabled`: true | **Object** | **Identification document's information. *****This field may be required for KYC/KYB based on your spec sheet.*** | | virtual\_documents.document\_type | Yes, if virtual\_document is required | String | Enumerated value. Note: Details provided below. | | virtual\_documents.document\_value | Yes, if virtual\_document is required | String | Value of the ID number. Example : Passport Number. | | virtual\_documents.issue\_date | Conditional | String | Date of issue of the document. | | virtual\_documents.expiry\_date | Conditional | String | Date of expiry of the document. | | virtual\_documents.id\_issuing\_authority | Conditional | String | ID issuing authority of the document. Please provide State if ID is DRIVING LICENSE or STATE ID and country if PASSPORT. | | virtual\_documents.country | Conditional | String | 2-letter ISO code of the document issued country. | | virtual\_documents.state | Conditional | String | 2-letter ISO code of the document issued state. | | **company\_details** | Conditional | **Object** | **Details of the company. *****This may be required for KYC based on your spec sheet.*** | | company\_details.company\_name | Yes, if company details is required | String | Name of the company where the individual user is employed. | | company\_details.address | Yes, if company details is required | String | Address of the company where the individual user is employed. | | company\_details.phone\_number | Yes, if company details is required | String | Phone number of the company where the individual user is employed. | | number\_of\_transaction\_per\_month | Conditional | Numeric | Estimate value of user's transactions per month. *This field may be required for KYB based on your spec sheet.* | | transaction\_frequency | Conditional | Category | Enum Values: DAILY, WEEKLY, BI\_WEEKLY, MONTHLY. *This field may be required for KYB based on your spec sheet.* | {% hint style="info" %} Please note that although fields may be optional during registration, certain fields may be mandatory for KYC/KYB. The mandatory fields for KYC/KYB will be outlined in your specification sheet. {% endhint %}

User Scope Enumerated Values

NOT_KNOWN("Not Known"),
AIRPORT("Airport"),
ARTS_ENTERTAINMENT("Arts & Entertainment"),
AUTOMOTIVE("Automotive"),
BANK("Bank & Financial Services"),
BAR("Bar"),
BOOK_STORE("Book Store"),
BUSINESS_SERVICE("Business Services"),
RELIGIOUS_ORGANIZATION("Religious Organization"),
CLUB("Club"),
COMMUNITY_GOVERNMENT("Community/Government"),
CONCERT_VENUE("Concert Venue"),
DOCTOR("Doctor"),
EVENT_PLANNING("Event Planning/Event Services"),
FOOD_GROCERY("Food/Grocery"),
HEALTH_MEDICAL("Health/Medical/Pharmacy"),
HOME_IMPROVEMENT("Home Improvement"),
HOSPITAL_CLINIC("Hospital/Clinic"),
HOTEL("Hotel"),
LANDMARK("Landmark"),
LAWYER("Lawyer"),
LIBRARY("Library"),
LOCAL_BUSINESS("Local Business"),
MUSEUM_ART_GALLERY("Museum/Art Gallery"),
OUTDOOR_SPORTING_GOODS("Outdoor Gear/Sporting Goods"),
PET_SERVICES("Pet Services"),
PROFESSIONAL_SERVICES("Professional Services"),
REAL_ESTATE("Real Estate"),
RESTAURANT_CAFE("Restaurant/Cafe"),
SCHOOL("School"),
SHOPPING_RETAIL("Shopping/Retail"),
SPORTS_VENUE("Sports Venue"),
TOURS("Tours/Sightseeing"),
TRANSPORTATION("Transportation"),
UNIVERSITY("University"),
AEROSPACE_DEFENCE("Aerospace/Defense"),
AUTOMOBILE_PARTS("Automobiles and Parts"),
FINANCIAL_INSTITUTION("Bank/Financial Institution"),
BIOTECHNOLOGY("Biotechnology"),
COMPUTER_TECHNOLOGY("Computers/Technology"),
EDUCATION("Elementary School"),
CONSTRUCTION("Engineering/Construction"),
AGRICULTURE("Farming/Agriculture"),
FOOD_BEVERAGES("Food/Beverages"),
GOVERNMENT_ORGANIZATION("Government Organization"),
INDUSTRIALS("Industrials"),
INSURANCE_COMPANY("Insurance Company"),
MEDIA("Media/News/Publishing"),
MINING("Mining/Materials"),
NON_GOVERNMENTAL_ORGANIZATION("Non-Governmental Organization (NGO)"),
ORGANIZATION("Organization"),
POLITICAL_ORGANIZATION("Political Organization"),
POLITICAL_PARTY("Political Party"),
TELECOMMUNICATION("Telecommunication"),
TRANSPORT("Transport/Freight"),
TRAVEL_LEISURE("Travel/Leisure")

Business Type Enumerated Values 

    NOT_KNOWN("Not Known"),
    LLC("LLC"),
    ASSOCIATION("ASSOCIATION"),
    CORP("CORP"),
    PARTNERSHIP("PARTNERSHIP"),
    SOLE_PROPRIETORSHIP("SOLE-PROPRIETORSHIP"),
    TRUST("TRUST"),
    VENDOR("VENDOR"),
    ESTATE("ESTATE"),
    IRA("IRA")

Physical Document Type Enumerated Values

Note: File size must not exceed 2 MB.

Virtual Document Type Enumerated Values

PASSPORT
DRIVING_LICENCE
STATE_ID
SSN
EIN_NUMBER
{% hint style="info" %} If your specification sheet requires you to submit source of funds for a user, the document will have to be submitted as a physical document with the specific type outlined in the 'document\_type' field. {% endhint %} {% endtab %} {% endtabs %}