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 individual seller details, which allows us to create a new company record with a company_id in the Nuvei KYC system.

Request

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

Parameters

These are the minimum parameters required:

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

Example `/companies/individual` Request

{
  "shop_id":"API56577",
  "shop_name":"TEST individual",
  " identification_details": {
    "firstname": "john",
    "lastname": "smith",
    "email": "[email protected]"
  }
}

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

Marketplace Shop Onboarding

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

Request

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

Parameters

Parameter	Description	Type	Mandatory
shop_id	Marketplace unique identifier for shop	string(255)	yes
shop_name	Marketplace name for shop	string	yes
identification_details	A node containing the following identification details of the individual: `firstname` – string(255) `lastname` – string(255) `nationality` - The 2-letter ISO country code where the individual resides. `date_of_birth` - date(yyyy-mm-dd) `email` – string(255)	node	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
unique_tax_ref	For UK: Unique Taxpayer Reference, often referred to as a UTR or a UTR number – A code used by HMRC to identify self-employed people and their companies for tax purposes. For EU: Taxpayer Identification Number (TIN) – Most EU countries use the TIN to identify taxpayers and facilitate the administration of their national tax affairs. TINs are also useful for identifying taxpayers who invest in other EU countries and are more reliable than other identifiers such as name and address For US: Taxpayer Identification Number (TIN) – An identification number used by the Internal Revenue Service (IRS) in the administration of tax laws. It is issued either by the Social Security Administration (SSA) or by the IRS. A Social Security number (SSN) is issued by the SSA whereas all other TINs are issued by the IRS.	string	conditional
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
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
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
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
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/individual` Request

{
  "shop_id":"REW12435",
  "shop_name":"New Individual Seller",
  "identification_details":{
    "firstname":"Joe",
    "lastname":"Ashcroft",
    "nationality":"GB",
    "date_of_birth":"1981-01-02",
    "email":"[email protected]"
  },
  "business_sector":4,
  "unique_tax_ref":1111,
  "invoicing_email":"",
  "invoicing_email_na":false,
  "ecommerce_sites":[
    "http://www.site1.com"
  ],
  "main_markets":[
    "ES",
    "GB",
    "IT"
  ],
  "annual_volume":25000,
  "atv":100,
  "address":{
    "street":"15-19 Bloomsbury Way",
    "zip_code":"WC1A 2TH",
    "city":"London",
    "state":"London",
    "phone":"123234234234",
    "country":"GB",
    "building_number":""
  },
  "banking_details":{
    "bank_name":"Lloyds Bank",
    "country":"GB",
    "account_holder":"Joe Ashcroft",
    "currency":"GBP",
    "iban":"",
    "swift":"",
    "sort_code":"122222",
    "account_number":"122124354634"
  },
  "terms_and_conditions":{
    "accept_terms_and_conditions":true,
    "representative_email":"",
    "date_of_acceptance":"2022-01-01 23:59:59"
  },
  "date_created":"2023-01-25 23:59:59",
  "last_updated_date2":"2021-01-20 23:59:59"
}

Response

Example `/companies/individual` Response

{
  "response":{
    "shop_id":"REW12435",
    "company_id":205,
    "company":{
      "id":205,
      "company_legal_name":"New Individual Seller",
      "company_number":"1111",
      "country":"GB",
      "business_sector":4,
      "invoicing_email":"",
      "invoicing_email_na":false,
      "ecommerce_sites":[
        "http://www.site1.com"
      ],
      "main_markets":[
        "ES",
        "GB",
        "IT"
      ],
      "payment_categories":[
        
      ],
      "annual_volume":25000,
      "atv":100,
      "identification_details":{
        "firstname":"JOE",
        "lastname":"ASHCROFT",
        "nationality":"GB",
        "date_of_birth":"1981-01-02 00:00:00"
      },
      "headquarters_address":{
        "street":"15-19 Bloomsbury Way",
        "zip_code":"WC1A 2TH",
        "building_number":"231 HR",
        "city":"London",
        "state":"London",
        "phone":"123234234234",
        "country":"GB"
      },
      "banking_details":{
        "bank_name":"Lloyds Bank",
        "country":"GB",
        "account_holder":"Joe Ashcroft",
        "currency":"GBP",
        "iban":"",
        "swift":"",
        "account_number":"122124354634",
        "sort_code":"122222"
      },
      "terms_and_conditions":[
        
      ],
      "date_created":"2023-05-14 08:23:57",
      "last_updated_date":"2023-05-14 08:23:58"
    }
  },
  "error":{
    "code":0,
    "message":""
  },
  "response_status":{
    "success_messages":[
      
    ],
    "warning_messages":[
      
    ],
    "error_messages":[
      
    ]
  }
}

Importing an Individual Seller

Overview

Nuvei Hosted Shop Onboarding

Request

Parameters

Example /companies/individual Request

Marketplace Shop Onboarding

Request

Parameters

Example /companies/individual Request

Response

Example /companies/individual Response

Example `/companies/individual` Request

Example `/companies/individual` Request

Example `/companies/individual` Response