Overview
When importing company details into the Nuvei KYC system as part of the shop onboarding process, you will notice that number of company (shop) detail fields contain values that reference preset lookup lists.
You can use the following GET requests to retrieve the relevant lookup list of possible values, and select the required preset value:
Company Lookups
Business Sector
Endpoint: GET {{ONBOARDING_URL}}/api/v1/companies/business_sectors/
Do the following:
- Send this GET request to retrieve the list of possible values.
- Select the relevant preset value from the response that is returned.
- Include that value when POSTing the
/companies/shop/onboarding request.
Example /companies/business_sectors Response
{
"response": {
"total_count": 21,
"items_per_page": 21,
"list": {
"1": {
"id": 1,
"title": "Advisory services",
"cdate": "2018-07-24 10:29:01"
},
"2": {
"id": 2,
"title": "Digital games",
"cdate": "2018-07-24 10:29:21"
},
"3": {
"id": 3,
"title": "Education",
"cdate": "2018-07-24 10:29:33"
},
"4": {
"id": 4,
"title": "Entertainment",
"cdate": "2018-07-24 10:29:42"
},
"5": {
"id": 5,
"title": "Finance",
"cdate": "2018-07-24 10:29:50"
},
"6": {
"id": 6,
"title": "Forex",
"cdate": "2018-07-24 10:29:58"
},
"7": {
"id": 7,
"title": "Gambling",
"cdate": "2018-07-24 13:22:01"
},
"8": {
"id": 8,
"title": "Mass media",
"cdate": "2018-07-24 13:22:13"
},
"9": {
"id": 9,
"title": "Money transfer",
"cdate": "2018-07-24 13:22:27"
},
"10": {
"id": 10,
"title": "Retail - fashion",
"cdate": "2018-07-24 13:22:38"
},
"11": {
"id": 11,
"title": "Retail - other",
"cdate": "2018-07-24 13:22:48"
},
"12": {
"id": 12,
"title": "Software",
"cdate": "2018-07-24 13:22:56"
},
"13": {
"id": 13,
"title": "Telecommunication",
"cdate": "2018-07-24 13:23:05"
},
"14": {
"id": 14,
"title": "Transportation",
"cdate": "2018-07-24 13:23:14"
},
"15": {
"id": 15,
"title": "Travel",
"cdate": "2018-07-24 13:23:25"
},
"16": {
"id": 16,
"title": "Social networks",
"cdate": "2020-02-21 14:35:39"
},
"17": {
"id": 17,
"title": "Virtual Goods",
"cdate": "2020-02-25 11:46:32"
},
"18": {
"id": 18,
"title": "Internet Media",
"cdate": "2020-02-25 11:46:44"
},
"19": {
"id": 19,
"title": "E-commerce Services",
"cdate": "2020-02-25 11:46:57"
},
"20": {
"id": 20,
"title": "PSP/Aggregator",
"cdate": "2020-02-25 11:47:31"
},
"21": {
"id": 21,
"title": "Precious Metals Trading",
"cdate": "2020-02-25 11:48:02"
}
}
},
"error": {
"code": 0,
"message": ""
},
"response_status": {
"success_messages": [],
"warning_messages": [],
"error_messages": []
}
}
Organization Structure
Endpoint: GET {{ONBOARDING_URL}}/api/v1/companies/organization_structures/
Do the following:
- Send this GET request to retrieve the list of possible values.
- Select the relevant preset value from the response that is returned.
- Include that value when POSTing the
/companies/shop/onboarding request.
Example /companies/organization_structures Response
{
"response": {
"total_count": 6,
"items_per_page": 6,
"list": {
"1": {
"id": 1,
"name": "Simple structure - 3 layers or less, excluding the seller and the UBO(s)",
"description": null,
"cdate": "2021-07-26 16:53:23"
},
"2": {
"id": 2,
"name": "Complex structure - >3 layers with all companies in the group in low-risk countries",
"description": null,
"cdate": "2021-08-02 08:12:59"
},
"3": {
"id": 3,
"name": "Complex structure with companies in the group located in Medium or High Risk countries",
"description": null,
"cdate": "2021-08-02 08:12:59"
},
"4": {
"id": 4,
"name": "Structures which include: trusts, PO box, shell companies, nominee shareholders, nominee directors, personal asset holdings",
"description": null,
"cdate": "2021-08-02 08:12:59"
},
"5": {
"id": 5,
"name": "Organizational Structure including at least one intermediate company registered in an Unacceptable Country",
"description": null,
"cdate": "2021-08-02 08:12:59"
},
"6": {
"id": 6,
"name": "Bearer Shares",
"description": null,
"cdate": "2021-08-02 08:12:59"
}
}
},
"error": {
"code": 0,
"message": ""
},
"response_status": {
"success_messages": [],
"warning_messages": [],
"error_messages": []
}
}
Payment Category
Endpoint: GET {{ONBOARDING_URL}}/api/v1/companies/payment_categories/
Do the following:
- Send this GET request to retrieve the list of possible values.
- Select the relevant preset value from the response that is returned.
- Include that value when POSTing the
/companies/shop/onboarding request.
Example /companies/payment_categories Response
{
"response": {
"total_count": 14,
"items_per_page": 14,
"list": {
"1": {
"id": 1,
"name": "Credit cards",
"methods_example": "Visa, Mastercard, Amex, Diners, Discover",
"cdate": "2021-07-14 09:37:10"
},
"2": {
"id": 2,
"name": "Debit Cards",
"methods_example": "Maestro",
"cdate": "2021-07-14 09:37:10"
},
"3": {
"id": 3,
"name": "Bank Transfers",
"methods_example": "Bank Transfers",
"cdate": "2021-07-14 09:37:10"
},
"4": {
"id": 4,
"name": "Online Banking",
"methods_example": "Online Bank Transfers",
"cdate": "2021-07-14 09:37:10"
},
"5": {
"id": 5,
"name": "Direct Debit",
"methods_example": "SEPA DD, ACH",
"cdate": "2021-07-14 09:37:10"
},
"6": {
"id": 6,
"name": "Cash",
"methods_example": "Cash-in, Pago Facil, RapiPago",
"cdate": "2021-07-14 09:37:10"
},
"7": {
"id": 7,
"name": "Carrier Payments",
"methods_example": "Fortumo",
"cdate": "2021-07-14 09:37:10"
},
"8": {
"id": 8,
"name": "ATM Payments",
"methods_example": "Multibanco, PayEasy",
"cdate": "2021-07-14 09:37:10"
},
"9": {
"id": 9,
"name": "Mobile Payments",
"methods_example": "Airtel Money, Equitel, M-Pesa",
"cdate": "2021-07-14 09:37:10"
},
"10": {
"id": 10,
"name": "Prepaid Cards",
"methods_example": "Paysafecard, Todito Cash",
"cdate": "2021-07-14 09:37:10"
},
"11": {
"id": 11,
"name": "Wallet",
"methods_example": "WebMoney, VogueOay, MTCPay, OneCard",
"cdate": "2021-07-14 09:37:10"
},
"12": {
"id": 12,
"name": "Wallet",
"methods_example": "WeChat, Alipay",
"cdate": "2021-07-14 09:37:10"
},
"13": {
"id": 13,
"name": "Payment via a 3rd party",
"methods_example": "Pay4Me Malaysia",
"cdate": "2021-07-14 09:37:10"
},
"14": {
"id": 14,
"name": "Delayed payments",
"methods_example": "Klarna",
"cdate": "2021-07-14 09:37:10"
}
}
},
"error": {
"code": 0,
"message": ""
},
"response_status": {
"success_messages": [],
"warning_messages": [],
"error_messages": []
}
}
Company Type
Endpoint: GET {{ONBOARDING_URL}}/api/v1/companies/company_types/
Do the following:
- Send this GET request to retrieve the list of possible values.
- Select the relevant preset value from the response that is returned.
- Include that value when POSTing the
/companies/shop/onboarding request.
Example /companies/company_types Response
{
"response": {
"total_count": 12,
"items_per_page": 12,
"list": {
"1": {
"id": 1,
"title": "Corporation",
"country": "AA",
"cdate": "2016-12-08 16:28:00"
},
"2": {
"id": 2,
"title": "LLC",
"country": "AA",
"cdate": "2016-12-08 16:29:41"
},
"3": {
"id": 3,
"title": "LLP",
"country": "AA",
"cdate": "2016-12-08 16:29:47"
},
"4": {
"id": 4,
"title": "Non-Profit",
"country": "AA",
"cdate": "2016-12-08 16:29:58"
},
"5": {
"id": 5,
"title": "Partnership",
"country": "AA",
"cdate": "2016-12-08 16:30:05"
},
"6": {
"id": 6,
"title": "S.a.s (Società in accomandita semplice)",
"country": "IT",
"cdate": "2016-12-09 14:08:19"
},
"7": {
"id": 7,
"title": "S.s. (Società semplice)",
"country": "IT",
"cdate": "2016-12-09 14:08:29"
},
"8": {
"id": 8,
"title": "S.n.c. (Società in nome collettivo)",
"country": "IT",
"cdate": "2016-12-12 12:58:19"
},
"9": {
"id": 9,
"title": "S.p.a. (Società per azioni)",
"country": "IT",
"cdate": "2016-12-12 12:58:31"
},
"10": {
"id": 10,
"title": "S.a.p.a (Società in accomandita per azioni)",
"country": "IT",
"cdate": "2016-12-12 12:58:43"
},
"11": {
"id": 11,
"title": "S.r.l. (Società a responsabilità limitata)",
"country": "IT",
"cdate": "2016-12-12 12:58:53"
},
"-1": {
"id": -1,
"title": "Other",
"country": "AA",
"cdate": "2022-02-26 09:52:35"
}
}
},
"error": {
"code": 0,
"message": ""
},
"response_status": {
"success_messages": [],
"warning_messages": [],
"error_messages": []
}
}
Last modified August 2024