Register a user
Read on how to create SEND users in our system
This endpoint creates a new user account with the user's basic information. If you want to enable sending capabilities to a user, you need to specify it with "type": "SEND" in the request. Only users in originating corridors enabled for you can be created with send capabilities.
A unique ID will be generated as a response.

POST /users

Details
Request Sample
Response Sample
Field
Required
Type
Description
mobile_phone
Yes
numeric
10 digits mobile number of the user
phone_number
Yes
numeric
10 digits phone number of the user.
This field is not mandatory for user registration but needs to be collected before user KYC is initiated.
email
Yes
String
Email address of the user
first_name
Yes
String
First name of the individual or name of the business
middle_name
No
String
Middle name of the user
last_name
Yes, if individual
String
Family name of the user
gender
Yes
String
Male, female, other. This field is not mandatory for user registration but needs to be collected 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. This field is not mandatory for user registration but needs to be collected before user KYC is initiated.
business
No
boolean
By default false
business_type
Yes, if Business
String
Type of business. Example : LLC, PARTNERSHIP, SOLE-PROPRIETORSHIP, etc.
Note : Details provided below
user_scope
Yes, if Business
String
Industry or profession of the business or an individual.
Note : Details provided below
address_line1
Yes
String
Street address of the user. This field is not mandatory for user registration but needs to be collected before user KYC is initiated.
address_line2
No
String
Street address of the user.
city
Yes
String
City of the user. This field is not mandatory for user registration but needs to be collected before user KYC is initiated.
state
Yes
String
2-letter ISO code of the user’s state. This field is not mandatory for user registration but needs to be collected before user KYC is initiated.
country
Yes
String
2-letter ISO code of the user’s state. This field is not mandatory for user registration but needs to be collected before user KYC is initiated.
zipcode
Yes
String
Zip code of the user’s address. This field is not mandatory for user registration but needs to be collected before user KYC is initiated.
status
No
Boolean
Kyc Status of the user. Unverified User. KYC not done.
ip_address
Yes
String
IP of the user.
Please note that although fields may be optional during registration, certain fields may be mandatory for KYC. The mandatory fields for KYC will be outlined in your specification sheet.
User Scope Enumerated Values
1
NOT_KNOWN("Not Known"),
2
AIRPORT("Airport"),
3
ARTS_ENTERTAINMENT("Arts & Entertainment"),
4
AUTOMOTIVE("Automotive"),
5
BANK("Bank & Financial Services"),
6
BAR("Bar"),
7
BOOK_STORE("Book Store"),
8
BUSINESS_SERVICE("Business Services"),
9
RELIGIOUS_ORGANIZATION("Religious Organization"),
10
CLUB("Club"),
11
COMMUNITY_GOVERNMENT("Community/Government"),
12
CONCERT_VENUE("Concert Venue"),
13
DOCTOR("Doctor"),
14
EVENT_PLANNING("Event Planning/Event Services"),
15
FOOD_GROCERY("Food/Grocery"),
16
HEALTH_MEDICAL("Health/Medical/Pharmacy"),
17
HOME_IMPROVEMENT("Home Improvement"),
18
HOSPITAL_CLINIC("Hospital/Clinic"),
19
HOTEL("Hotel"),
20
LANDMARK("Landmark"),
21
LAWYER("Lawyer"),
22
LIBRARY("Library"),
23
LOCAL_BUSINESS("Local Business"),
24
MUSEUM_ART_GALLERY("Museum/Art Gallery"),
25
OUTDOOR_SPORTING_GOODS("Outdoor Gear/Sporting Goods"),
26
PET_SERVICES("Pet Services"),
27
PROFESSIONAL_SERVICES("Professional Services"),
28
REAL_ESTATE("Real Estate"),
29
RESTAURANT_CAFE("Restaurant/Cafe"),
30
SCHOOL("School"),
31
SHOPPING_RETAIL("Shopping/Retail"),
32
SPORTS_VENUE("Sports Venue"),
33
TOURS("Tours/Sightseeing"),
34
TRANSPORTATION("Transportation"),
35
UNIVERSITY("University"),
36
AEROSPACE_DEFENCE("Aerospace/Defense"),
37
AUTOMOBILE_PARTS("Automobiles and Parts"),
38
FINANCIAL_INSTITUTION("Bank/Financial Institution"),
39
BIOTECHNOLOGY("Biotechnology"),
40
COMPUTER_TECHNOLOGY("Computers/Technology"),
41
EDUCATION("Elementary School"),
42
CONSTRUCTION("Engineering/Construction"),
43
AGRICULTURE("Farming/Agriculture"),
44
FOOD_BEVERAGES("Food/Beverages"),
45
GOVERNMENT_ORGANIZATION("Government Organization"),
46
INDUSTRIALS("Industrials"),
47
INSURANCE_COMPANY("Insurance Company"),
48
MEDIA("Media/News/Publishing"),
49
MINING("Mining/Materials"),
50
NON_GOVERNMENTAL_ORGANIZATION("Non-Governmental Organization (NGO)"),
51
ORGANIZATION("Organization"),
52
POLITICAL_ORGANIZATION("Political Organization"),
53
POLITICAL_PARTY("Political Party"),
54
TELECOMMUNICATION("Telecommunication"),
55
TRANSPORT("Transport/Freight"),
56
TRAVEL_LEISURE("Travel/Leisure")
Copied!
Business Type Enumerated Values
1
NOT_KNOWN("Not Known"),
2
LLC("LLC"),
3
ASSOCIATION("ASSOCIATION"),
4
CORP("CORP"),
5
PARTNERSHIP("PARTNERSHIP"),
6
SOLE_PROPRIETORSHIP("SOLE-PROPRIETORSHIP"),
7
TRUST("TRUST"),
8
VENDOR("VENDOR"),
9
ESTATE("ESTATE"),
10
IRA("IRA")
Copied!
Physical Document Type Enumerated Values
1
PASSPORT
2
DRIVING_LICENCE
3
STATE_ID
4
BANK_STATEMENT
5
PAY_SLIP
6
TAX_RETURN_FILES
7
AUDITED_FINANCIALS
Copied!
Virtual Document Type Enumerated Values
1
PASSPORT
2
DRIVING_LICENCE
3
STATE_ID
4
SSN
Copied!
1
curl --location -g --request POST '{{url}}/users' \
2
--header 'X-Client-Id: {{client_id}}' \
3
--header 'X-Client-Secret: {{client_secret}}' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
"first_name": "Tenzin",
7
"last_name": "Norgay",
8
"email": "[email protected]",
9
"gender": "female",
10
"date_of_birth": "2000-01-01",
11
"address_line1": "500 8 El Camino Real Santa Clara",
12
"mobile_phone": "9879879870",
13
"city": "Santa Clara",
14
"zipcode": "95053",
15
"state": "CA",
16
"country": "US",
17
"ip_address": "73.85.79.9",
18
"type": "SEND"
19
}'
Copied!
1
{
2
"address_line1": "500 8 El Camino Real Santa Clara",
3
"city": "Santa Clara",
4
"country": "US",
5
"created_at": "2022-03-11T04:32:24.48354",
6
"date_of_birth": "2000-01-01",
7
"email": "[email protected]",
8
"first_name": "Tenzin",
9
"gender": "female",
10
"id": "022ea509-a4ab-4bb9-ad98-305c08bd2b42",
11
"ip_address": "73.85.79.9",
12
"last_name": "Norgay",
13
"mobile_phone": "9879879870",
14
"state": "CA",
15
"status": "UNVERIFIED",
16
"zipcode": "95053",
17
"business": false,
18
"type": "SEND"
19
}
Copied!
Copy link
Contents