Necessary parameters per user type
You can create a user with the following user types:
"INDIVIDUAL"
"BUSINESS"
"DIRECTOR"
"SIGNATURE"
"SHAREHOLDER"
"SHAREHOLDER_BUSINESS"
Individual user type
To create an individual user, you should indicate at least 'first_name' parameter.
Below you can find an example of user creation with 'user_type'="INDIVIDUAL":
Sample
curl --location --request POST 'https://api.dev.platform.nm-1.nymcard.com/v1/users' \
--header 'Content-Type: application/json' \
--header 'apikey: tenant1-key' \
--data-raw '{
"title": "MRS",
"first_name": "Sara",
"middle_name": "Anthony",
"last_name": "pass",
"native_name": "John Smith",
"date_of_birth": "1989-11-07",
"email": "bob@example.com",
"mobile": "+551185249635",
"address": {
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "UKR"
},
"gender": "MALE",
"preferred_language": "EN",
"place_of_birth": "USA",
"nationality": "USA",
"country_residence": "USA",
"country_tax_residence": "USA",
"employment_type": "SALARIED",
"employment_title": "string",
"monthly_salary": 0,
"company_name": "string",
"company_address": {
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "UKR"
},
"company_country": "USA",
"industry_type": "I01",
"expected_monthly_balance": 0,
// "relationship_with_parent": "SON",
// "parent_user_id": "71204e77-73ce-4671-b997-baf610ff8532",
"user_type": "INDIVIDUAL",
"phone_number": "+551185249635"
}'
Response
{
"id": "95e7ffbe-0d8a-4c8d-ab84-4476c16a1494",
"title": "MRS",
"first_name": "Sara",
"middle_name": "Anthony",
"last_name": "pass",
"native_name": "John Smith",
"date_of_birth": "1989-11-07",
"email": "bob@example.com",
"mobile": "+551185249635",
"address": {
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "UKR"
},
"gender": "MALE",
"preferred_language": "EN",
"place_of_birth": "USA",
"nationality": "USA",
"created": "2022-09-23T13:30:31.780Z",
"modified": "2022-09-23T13:30:31.780Z",
"country_residence": "USA",
"country_tax_residence": "USA",
"employment_type": "SALARIED",
"employment_title": "string",
"monthly_salary": 0,
"company_name": "string",
"company_address": {
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "UKR"
},
"company_country": "USA",
"industry_type": "I01",
"expected_monthly_balance": 0,
"user_type": "INDIVIDUAL",
"phone_number": "+551185249635",
"status": "PENDINGIDVERIFICATION",
"status_reason_code": "I0",
"director_list": [],
"signature_list": [],
"shareholder_list": [],
"default_user": false
}
Business user type
To create a business user, you should indicate at least 'business_legal_name' and "business_dba_name" parameters.
Below you can find an example of user creation with 'user_type'="BUSINESS":
Sample
curl --location --request POST 'https://api.dev.platform.nm-1.nymcard.com/v1/users' \
--header 'Content-Type: application/json' \
--header 'apikey: tenant1-key' \
--data-raw '{
// "title": "MR",
"first_name": "John",
"user_type": "BUSINESS",
"middle_name": "Anthony",
"last_name": "pass",
"native_name": "John Smith",
"date_of_birth": "2000-09-28",
"email": "bob@example.com",
"mobile": "+551185249635",
"address": {
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "UKR"
},
"gender": "MALE",
"preferred_language": "EN",
"place_of_birth": "USA",
"nationality": "USA",
//"parent_user_id": "cf2de83b441b-bc54-21de60014d57",
"country_residence": "USA",
"country_tax_residence": "USA",
"employment_type": "SALARIED",
"employment_title": "string",
"monthly_salary": 0,
"company_name": "string",
"company_address": {
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "UKR"
},
"company_country": "USA",
"industry_type": "I01",
"expected_monthly_balance": 0,
"user_type": "BUSINESS",
"business_legal_name": "string",
"business_dba_name": "string",
"date_established": "2021-09-28",
"phone_number": "+551185249635",
"website": "string",
"incorporation_type": "LLC",
"entity_registered_no": "22334455",
"old_entity_name": "",
"old_entity_ops_start_date": "2021-09-28T00:00:00.000Z",
"old_entity_ops_end_date": "2021-09-28T00:00:00.000Z",
"regulated_entity": true,
"regulator_name": "XYZ",
"business_activities": "Consultancy",
"other_operated_countries": "UAE, US",
"tax_residence_country": "UAE",
"tin": "1122334455",
"external_auditor_name": "",
"group_additional_info": {
"group_entity": true,
"independent_entity": true,
"special_investment": true,
"entity_details": "name"
},
"pep_check_info": {
"pri_pep_check": true,
"pri_pep_check_name": "ABC",
"sec_pep_check":true,
"sec_pep_check_name":"XYZ"
},
// "no_of_employees":"25",
"accept_cash_check": true,
"annual_turnover":"120000",
"source_of_funds":"IT services",
"source_fund_uae":true,
"due_diligence_declaration": {
"bankruptcy_declaration": false,
"disciplinary_declaration": false,
"fraud_aml_declaration": false,
"disqualification_declaration": false,
"conviction_accusition_declaration": false,
"breach_of_law_declaration": false
}
}'
Response
{
"id": "65eb57bd-6290-431d-bf23-1cb287d7d7a8",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "pass",
"native_name": "John Smith",
"date_of_birth": "2000-09-28",
"email": "bob@example.com",
"mobile": "+551185249635",
"address": {
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "UKR"
},
"gender": "MALE",
"preferred_language": "EN",
"place_of_birth": "USA",
"nationality": "USA",
"created": "2022-09-23T13:34:30.295Z",
"modified": "2022-09-23T13:34:30.295Z",
"country_residence": "USA",
"country_tax_residence": "USA",
"employment_type": "SALARIED",
"employment_title": "string",
"monthly_salary": 0,
"company_name": "string",
"company_address": {
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "UKR"
},
"company_country": "USA",
"industry_type": "I01",
"expected_monthly_balance": 0,
"user_type": "BUSINESS",
"business_legal_name": "string",
"business_dba_name": "string",
"date_established": "2021-09-28T00:00:00.000Z",
"phone_number": "+551185249635",
"website": "string",
"status": "PENDINGKYB",
"status_reason_code": "I0",
"incorporation_type": "LLC",
"entity_registered_no": "22334455",
"old_entity_ops_start_date": "2021-09-28T00:00:00.000Z",
"old_entity_ops_end_date": "2021-09-28T00:00:00.000Z",
"regulated_entity": true,
"regulator_name": "XYZ",
"business_activities": "Consultancy",
"other_operated_countries": "UAE, US",
"tax_residence_country": "UAE",
"tin": "1122334455",
"director_list": [],
"signature_list": [],
"shareholder_list": [],
"group_additional_info": {
"group_entity": true,
"independent_entity": true,
"special_investment": true,
"entity_details": "name"
},
"pep_check_info": {
"pri_pep_check": true,
"pri_pep_check_name": "ABC",
"sec_pep_check": true,
"sec_pep_check_name": "XYZ"
},
"accept_cash_check": true,
"annual_turnover": 120000,
"source_of_funds": "IT services",
"source_fund_uae": true,
"due_diligence_declaration": {
"bankruptcy_declaration": false,
"disciplinary_declaration": false,
"fraud_aml_declaration": false,
"disqualification_declaration": false,
"conviction_accusition_declaration": false,
"breach_of_law_declaration": false
},
"default_user": false
}
Parameters for each user type
Description of the "Create user" API in API catalog includes all parameters which are used in that API. For your convenience, below you can find a set of API parameters (both in pdf and excel formats), which are necessary for each user type creation:
Last updated