User Object

Read about user object details

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.

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.

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. PASSPORT jpg, jpeg, and png DRIVING_LICENCE jpg, jpeg, and png STATE_ID jpg, jpeg, and png BANK_STATEMENT jpg, jpeg, png and pdf PAY_SLIP jpg, jpeg, png and pdf TAX_RETURN_FILES jpg, jpeg, png and pdf AUDITED_FINANCIALS jpg, jpeg, png and pdf EIN jpg, jpeg, png and pdf CERTIFICATE_OF_INCORPORATION jpg, jpeg, png and pdf

Virtual Document Type Enumerated Values PASSPORT DRIVING_LICENCE STATE_ID SSN EIN_NUMBER

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.