On this page:

Overview

Import your company details into the Nuvei KYC system to begin the company approval process.

This can be done in two ways:

Nuvei Hosted Shop Onboarding
Marketplace Shop Onboarding

Nuvei Hosted Shop Onboarding

Send the following minimal set of company details, which allows us to create a new company record with a company_id in the Nuvei KYC system.

You can only import the minimal set of company details once.

Request

Endpoint: POST {{ONBOARDING_URL}}/api/v1/companies/shop/

Parameters

These are the minimum parameters required:

company_acts_on_its_behalf
shop_id
shop_name
contact_information:
- title
- firstname
- lastname
- email

Example `/companies/shop` Request

{
  "company_acts_on_its_behalf": true,
  "shop_id": "API56577",
  "shop_name": "TEST shop",
  "contact_information": {
    "title": "Mr",
    "firstname": "john",
    "lastname": "smith",
    "email": "[email protected]"
  }
}

If you would like to include any additional information, it will simply be less for the seller representative to enter later.
To see all the field descriptions, see the Parameters table below.

H3 Response

Example `/companies/shop` Response

{
  "shop_id": "API56577",
  "company_id": 166,
  "company": {
    "id": 166,
    "company_legal_name": "TEST Brics LTD",
    "company_number": "125547445",
    "country": "GB",
    "organization_structure": 1,
    "vat": "1233123",
    "vat_na": false,
    "company_type": 5,
    "company_type_text": "",
    "business_sector": 4,
    "business_model": "selling shoes 1",
    "main_activity": "Something else here 1",
    "date_of_establishment": "2018-12-31",
    "company_website": "https://www.google.com",
    "invoicing_email": "[email protected]",
    "invoicing_email_na": true,
    "mcc": 3001,
    "ecommerce_sites": [
      "http://www.site1.com",
      "http://www.site2.com",
      "http://www.site3.com"
    ],
    "main_markets": [
      "RO",
      "GB",
      "IT"
    ],
    "payment_categories": [
      1,
      2,
      3
    ],
    "annual_volume": 562000,
    "atv": 100,
    "contact_information": {
      "title": "",
      "firstname": "",
      "lastname": "",
      "email": "[email protected]",
      "country": ""
    },
    "headquarters_address": {
      "street": "The Street",
      "zip_code": "6600",
      "city": "The City",
      "state": "The State",
      "phone": "123234234234",
      "country": "GB"
    },
    "banking_details": {
      "bank_name": "My Bank",
      "country": "GB",
      "account_holder": "TEST Brics LTD",
      "currency": "EUR",
      "iban": "",
      "swift": "",
      "account_number": "122124354634",
      "sort_code": "122222"
    },
    "ubos": [
      {
        "id": 535,
        "title": "MR",
        "firstname": "FIRST",
        "lastname": "LAST",
        "percentage": 25.3,
        "email": "[email protected]",
        "date_of_birth": "1979-12-31",
        "street": "Street 12",
        "zip_code": "12345",
        "city": "Iasi",
        "state": "IS",
        "country": "RO"
      },
      {
        "id": 536,
        "title": "Mr.",
        "firstname": "UBOFIRST",
        "lastname": "UBOLAST",
        "percentage": 45.3,
        "email": "[email protected]",
        "date_of_birth": "2001-12-31",
        "street": "Street 12",
        "zip_code": "12345",
        "city": "London",
        "state": "London",
        "country": "GB"
      }
    ],
    "directors": [
      {
        "id": 537,
        "title": "MR",
        "firstname": "DIRECTOROPTIONAL",
        "lastname": "LASTDIRECTOR",
        "date_of_birth": "2001-12-31",
        "country": "GB"
      }
    ],
    "representatives": [
      {
        "id": 538,
        "signing_right": true,
        "title": "Mr.",
        "firstname": "REPF",
        "lastname": "REPL",
        "email": "[email protected]",
        "date_of_birth": "2001-12-31",
        "nationality": "RO",
        "street": "Street 12",
        "zip_code": "12345",
        "city": "Iasi",
        "state": "IS",
        "phone": "1234345344",
        "country": "GB"
      }
    ],
    "shareholders": [
      {
        "id": 539,
        "shareholder_company": "SHARE HOLDER 5",
        "date_establishment": "1981-01-01"
      }
    ],
    "terms_and_conditions": {
      "accept_terms_and_conditions": true,
      "representative_email": "[email protected]",
      "date_of_acceptance": "2022-01-01 23:59:59"
    },
    "date_created": "2022-05-10 09:52:09",
    "last_updated_date": "2022-05-10 09:52:10"
  },
  "error": {
    "code": 0,
    "message": ""
  },
  "response_status": {
    "success_messages": [],
    "warning_messages": [],
    "error_messages": []
  }
}

Marketplace Shop Onboarding

Send the full set of company details, which allows us to create a new company record with a company_id in the Nuvei KYC system.

You can only import the full set of company details once. (However, documents can still be uploaded at any point.)
After the initial import you can still contact your Nuvei Onboarding Specialist to update any details for you.

Request

Endpoint: POST {{ONBOARDING_URL}}/api/v1/companies/shop/

Parameters

Parameter	Description	Type	Mandatory
company_acts_on_its_behalf	Indicates if the company is acting on its own behalf	boolean	yes
shop_id	Marketplace unique identifier for shop	string(255)	yes
shop_name	Marketplace name for shop	string	yes
company_legal_name	Company name as stated in legal documents	string	yes
company_number	The registration number of the company according to official documents.	string	yes
country	The 2-letter ISO country code where a shop is based.	string	yes
organization_structure	Identifier of the organization structure of the shop. Choose one of the organization structures, as described in the Organization Structure topic.	integer	yes
vat	The VAT number of the company. REQUIRED if the company is located in Europe.	string	conditional
vat_na	If VAT is not applicable, should be set to "true". If VAT must be provided, should be set to "false".	boolean	conditional
company_type	Identifier of the company type of the shop. Choose one of the company types, as described in the Company Type topic.	integer	yes
company_type_text	Sent only when company_type=-1 - Other	string(255)	yes
business_sector	Identifier of the business sector of the shop. Choose one of the business sectors, as described in the Business Sector topic.	integer	yes
business_model	Displays information about products or services.	string	yes
main_activity	Displays what the Seller is selling.	string(255)	yes
date_of_establishment	Date when the shop was founded according to legal documents	date (yyyy-mm-dd)	yes
company_website	The seller presentation website.	string(255)	yes
invoicing_email	Email to which Seller settlement invoices/reports are sent in Excel format if provided by the Seller.	string(255)	optional
invoicing_email_na	If true, invoicing_email is optional. If false, invoicing_email is mandatory.	boolean	conditional
mcc	The MCC code (seller category code).	Integer	yes
ecommerce_sites	An array of ecommerce site address(es) for the shop, which should also be on the Marketplace website	array(text)	yes
main_markets	An array of countries in which the methods are offered.	array(varchar(2))	yes
payment_categories	An array of the identifiers of the payment categories of the shop. Choose the of the payment categories, as described in the Payment Category topic.	array(int)	yes
annual_volume	Expected annual Volume generated by shop sales (EUR)	integer	yes
atv	Average Transaction value generated by shop sales (EUR)	integer	yes
contact_information	A node containing the following contact details of the Onboarding Account Administrator: title – string(255) firstname – string(255) lastname – string(255) email – string(255) – Mandatory	node
headquarters_address	A node containing the following address details of the sellers as stated in official documents: street – string(255) zip_code – string(30) city – string(255) state – string(255) phone – string(50) country – string(2)	node
banking_details	A node containing the following bank details: bank_name – string(255) – Mandatory country – string(2) – Mandatory account_holder – string(255) – Mandatory currency – string(50) – Mandatory iban – string(50) – Conditional swift – string(50) sort_code – string(50) account_number – string(50)	node
ubos	A node containing the following contact details for all Ultimate Beneficial Owners (UBOs), who are defined as all natural persons that own or control, directly or indirectly, more than 25% of the Company: title – string(255) firstname – string(255) lastname – string(255) percentage – Percentage of ownership – decimal(5,2) email – Email used for initiation of identity verification – string(255) date_of_birth – date(yyyy-mm-dd) is_not_pep – PEP declaration – boolean (should be true) street – string(255) zip_code – string(30) city – string(255) state – string(255) country of residence – string(2)	node
directors	A node containing the following contact details for Directors (only needed when the Company has multiple directors): title – string(255) – Mandatory firstname – string(255) – Mandatory lastname – string(255) – Mandatory date_of_birth – date(yyyy-mm-dd) – Mandatory country of residence – string(2) – Mandatory	node
representatives	A node containing the following contact details for legal representatives (who will sign the Seller Application Form and the Seller Agreement): signing_right – boolean – Mandatory title – string(255) – Mandatory firstname – string(255) – Mandatory lastname – string(255) – Mandatory email – string(255) – Mandatory date_of_birth – date(yyyy-mm-dd) – Mandatory nationality – string(2) – Mandatory is_not_pep – PEP declaration – boolean (should be true) – Mandatory street – string(255) – Mandatory zip_code – string(30) – Mandatory city – string(255) – Mandatory state – string(255) – Mandatory phone – string(50) – Mandatory country – string(2) phone – string(50) – Mandatory	node
shareholders	A node containing the following contact details for Shareholder Companies (only needed if in the Company structure there is another Company with significant control): shareholder_company – string(255) – Mandatory date_establishment – date(yyyy-mm-dd) – Mandatory	node	optional
terms_and_conditions	A node containing the following details for Terms and Conditions: accept_terms_and_conditions – boolean representative_email – string(255) date_of_acceptance – datetime(yyyy-mm-dd hh:mm:ss)
date_created	Date when this shop was created.	datetime(yyyy-mm-dd hh:mm:ss)
last_updated_date	Date when details of shop were last updated.	datetime(yyyy-mm-dd hh:mm:ss)

Example `/companies/shop` Request

{
  "company_acts_on_its_behalf": true,
  "shop_id": "API56577",
  "shop_name": "TEST shop",
  "company_legal_name": "TEST shop Inc.",
  "company_number": "122121",
  "country": "GB",
  "organization_structure": 1,
  "vat": "1233123",
  "vat_na": false,
  "company_type": 5,
  "company_type_text1": "",
  "business_sector": 4,
  "business_model": "fashion",
  "main_activity": "selling shoes",
  "date_of_establishment": "2018-12-31",
  "company_website": "https://www.testshop.com",
  "invoicing_email": "[email protected]",
  "invoicing_email_na": false,
  "mcc": 3001,
  "ecommerce_sites": [
    "http://www.site1.com",
    "http://www.site2.com",
    "http://www.site3.com"
  ],
  "main_markets": [
    "RO",
    "GB",
    "IT"
  ],
  "payment_categories": [
    1,
    2,
    3
  ],
  "annual_volume": 1000,
  "atv": 100,
  "contact_information": {
    "title": "Mr",
    "firstname": "john",
    "lastname": "smith",
    "email": "[email protected]"
  },
  "headquarters_address": {
    "street": "22 main street",
    "zip_code": "12345",
    "city": "london",
    "state": "",
    "phone": "123234234234",
    "country": "GB"
  },
  "banking_details": {
    "bank_name": "First National Bank",
    "country": "GB",
    "account_holder": "Robert Smith",
    "currency": "EUR",
    "iban": "RO1213231212312123",
    "swift": "124343",
    "sort_code": "122222",
    "account_number": "122124354634"
  },
  "ubos": [
    {
      "title": "Mr.",
      "firstname": "Scott",
      "lastname": "Williams",
      "percentage": 50,
      "email": "[email protected]",
      "date_of_birth": "2000-12-31",
      "is_not_pep": 1,
      "street": "4 Centre Street",
      "zip_code": "12345",
      "city": "Manchester",
      "state": "",
      "country": "GB"
    },
    {
      "title": "Mrs.",
      "firstname": "Jane",
      "lastname": "Williams",
      "percentage": 50,
      "email": "[email protected]",
      "date_of_birth": "1971-10-15",
      "is_not_pep": 1,
      "street": "4 Centre Street",
      "zip_code": "12345",
      "city": "Manchester",
      "state": "",
      "country": "GB"
    }
  ],
  "directors": [
    {
      "title": "Mr.D",
      "firstname": "BigD",
      "lastname": "BossD",
      "date_of_birth": "1965-08-16",
      "country": "GB"
    }
  ],
  "representatives": [
    {
      "signing_right": 1,
      "title": "Ms.",
      "firstname": "Susan",
      "lastname": "Johnson",
      "email": "[email protected]",
      "date_of_birth": "1980-02-06",
      "nationality": "US",
      "is_not_pep": 1,
      "street": "22 Mill Road",
      "zip_code": "02460",
      "city": "Newton",
      "state": "MA",
      "phone": "6179691111",
      "country": "US"
    }
  ],
  "shareholders": [
    {
      "shareholder_company": "SHARE HOLDER 1",
      "date_establishment": "1981-01-01"
    }
  ],
  "terms_and_conditions": {
    "accept_terms_and_conditions": true,
    "representative_email": "[email protected]",
    "date_of_acceptance": "2022-01-01 23:59:59"
  },
  "date_created": "2021-01-20 23:59:59",
  "last_updated_date": "2021-01-20 23:59:59"
}

Response

Example `/companies/shop` Response

{
  "shop_id": "API56577",
  "company_id": 166,
  "company": {
    "id": 166,
    "company_legal_name": "TEST Brics LTD",
    "company_number": "125547445",
    "country": "GB",
    "organization_structure": 1,
    "vat": "1233123",
    "vat_na": false,
    "company_type": 5,
    "company_type_text": "",
    "business_sector": 4,
    "business_model": "selling shoes 1",
    "main_activity": "Something else here 1",
    "date_of_establishment": "2018-12-31",
    "company_website": "https://www.google.com",
    "invoicing_email": "[email protected]",
    "invoicing_email_na": true,
    "mcc": 3001,
    "ecommerce_sites": [
      "http://www.site1.com",
      "http://www.site2.com",
      "http://www.site3.com"
    ],
    "main_markets": [
      "RO",
      "GB",
      "IT"
    ],
    "payment_categories": [
      1,
      2,
      3
    ],
    "annual_volume": 562000,
    "atv": 100,
    "contact_information": {
      "title": "",
      "firstname": "",
      "lastname": "",
      "email": "[email protected]",
      "country": ""
    },
    "headquarters_address": {
      "street": "The Street",
      "zip_code": "6600",
      "city": "The City",
      "state": "The State",
      "phone": "123234234234",
      "country": "GB"
    },
    "banking_details": {
      "bank_name": "My Bank",
      "country": "GB",
      "account_holder": "TEST Brics LTD",
      "currency": "EUR",
      "iban": "",
      "swift": "",
      "account_number": "122124354634",
      "sort_code": "122222"
    },
    "ubos": [
      {
        "id": 535,
        "title": "MR",
        "firstname": "FIRST",
        "lastname": "LAST",
        "percentage": 25.3,
        "email": "[email protected]",
        "date_of_birth": "1979-12-31",
        "street": "Street 12",
        "zip_code": "12345",
        "city": "Iasi",
        "state": "IS",
        "country": "RO"
      },
      {
        "id": 536,
        "title": "Mr.",
        "firstname": "UBOFIRST",
        "lastname": "UBOLAST",
        "percentage": 45.3,
        "email": "[email protected]",
        "date_of_birth": "2001-12-31",
        "street": "Street 12",
        "zip_code": "12345",
        "city": "London",
        "state": "London",
        "country": "GB"
      }
    ],
    "directors": [
      {
        "id": 537,
        "title": "MR",
        "firstname": "DIRECTOROPTIONAL",
        "lastname": "LASTDIRECTOR",
        "date_of_birth": "2001-12-31",
        "country": "GB"
      }
    ],
    "representatives": [
      {
        "id": 538,
        "signing_right": true,
        "title": "Mr.",
        "firstname": "REPF",
        "lastname": "REPL",
        "email": "[email protected]",
        "date_of_birth": "2001-12-31",
        "nationality": "RO",
        "street": "Street 12",
        "zip_code": "12345",
        "city": "Iasi",
        "state": "IS",
        "phone": "1234345344",
        "country": "GB"
      }
    ],
    "shareholders": [
      {
        "id": 539,
        "shareholder_company": "SHARE HOLDER 5",
        "date_establishment": "1981-01-01"
      }
    ],
    "terms_and_conditions": {
      "accept_terms_and_conditions": true,
      "representative_email": "[email protected]",
      "date_of_acceptance": "2022-01-01 23:59:59"
    },
    "date_created": "2022-05-10 09:52:09",
    "last_updated_date": "2022-05-10 09:52:10"
  },
  "error": {
    "code": 0,
    "message": ""
  },
  "response_status": {
    "success_messages": [],
    "warning_messages": [],
    "error_messages": []
  }
}

Onboarding Lookups

Press here.

Importing a Company Seller

Overview

Nuvei Hosted Shop Onboarding

Request

Parameters

Example /companies/shop Request

Example /companies/shop Response

Marketplace Shop Onboarding

Request

Parameters

Example /companies/shop Request

Response

Example /companies/shop Response

Onboarding Lookups

Example `/companies/shop` Request

Example `/companies/shop` Response

Example `/companies/shop` Request

Example `/companies/shop` Response