Create Vendor

The first thing you should do when integration the vendor onboarding process is implement the Create vendor call below. Vendors can be created with or without pre-populating additional onboarding fields.

Pre populating onboarding fields makes the onboarding process easier for your vendors. Send some of the onboarding fields while creating the vendor (using same API call).
In most cases, some of the information we require for the vendor onboarding is already collected by your platform.

Create vendor without pre-populating any onboarding fields

Make a POST /vendors request to create a new vendor, provide the information you have and the rest will be collected later on in the onboarding process:

curl --location --request POST 'https://sandbox.unipaas.com/platform/vendors' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <PLATFORM_SECRET_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Better Delivery",
    "type": "company",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "country": "GB",
    "createOnboardingLink": true
    }'

In the response, you'll get the created vendor object, as shown in the example below

{
  "id": "61829cf9db1fb65b94f1acf8",
  "name": "Better Delivery",
  "email": "[email protected]",
  "createdAt": "2021-11-03T14:30:17.120Z",
  "updatedAt": "2021-11-03T14:30:17.120Z",
  "merchantId": "616d3e7faba71b9e13a2f7b7",
  "acceptPayments": false,
  "receivePayouts": false,
  "onboardingLink": "https://sandbox-hosted.unipaas.com/vendors/6162aff7d7eb80d6982c18bf/I45f0ooz7CkuOsPJ7s4v"
}

Create vendor and pre-populate onboarding fields

Make a POST /vendors request to create a new vendor, provide the information you have, and the rest will be collected later on in the onboarding process:

curl --location --request POST 'https://sandbox.unipaas.com/platform/vendors' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <PLATFORM_SECRET_KEY>' \
--data-raw '{
    "name": "Better Delivery",
    "type": "company",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "country": "GB",
    "url": "http://example.com",
    "serviceDescription": "service description",
    "birthDate": "1980-01-01",
    "phone": "+447911123456",
    "category": "FOOD_DELIVERY",
    "address": {
        "country": "GB",
        "city": "London",
        "street": "New Cavendish Street",
        "houseNumber": "64",
        "postCode": "W1G 8TB"
    }, 
    "createOnboardingLink": true
}'

📘

Onboarding type

The onboarding type defines if your vendor is an individual / sole trader (individual) or a registered company (company).

In the response, you'll get the created vendor object.

{
  "id": "61829cf9db1fb65b94f1acf8",
  "name": "Better Delivery",
  "email": "[email protected]",
  "createdAt": "2021-11-03T14:30:17.120Z",
  "updatedAt": "2021-11-03T14:30:17.120Z",
  "merchantId": "616d3e7faba71b9e13a2f7b7",
  "acceptPayments": false,
  "receivePayouts": false,
  "onboardingLink": "https://sandbox-hosted.unipaas.com/vendors/6162aff7d7eb80d6982c18bf/I45f0ooz7CkuOsPJ7s4v"
}

Note that the create vendor response includes an onboarding link that you can send your vendor. This will allow your vendor to complete all remaining onboarding fields in a UNIPaaS hosted UI.

Pre populated onboarding fields

The following fields describe the onboarding data that can be, and should to be, pre filled upon vendor creation.
Please mind that we strongly recommend you provide as much data as possible. It will save your vendor time and effort, and will increase conversion rates for the payment onboarding process.

📘

Read Only fields

Some fields are 'read only': the vendor won't be able to see/edit them.

Individual onboarding fields

Field Name

Is Required

Type

Description

Read Only

name

Optional

String

Represents the name of the business (if applicable) for both individuals and companies

Yes

firstName

Required

String

For Individual onboarding this field represents the individual's first name.

For Company onboarding
This field represents the company representative first name

No

lastName

Required

String

For Individual onboarding this field represents the individual's last name.

For Company onboarding
This field represents the company representative last name

No

birthDate

Recommended

String

For Individual onboarding this field represents the individual's date of birth.

For Company onboarding
This field represents the company representative date of birth

Yes

phone

Recommended

String

For Individual onboarding this field represents the individual's phone number

For Company onboarding
This field represents the company representative phone number

Yes

email

Required

String

For Individual onboarding this field represents the individual's email address

For Company onboarding
This field represents the company email address

Yes

country

Required

String
ISO 3166-1 alpha-2 code

For Individual onboarding this field represents the individual's country

For Company onboarding
This field represents the company corporate country

Yes

type

Recommended
(for UI)

Required
(for API)

Enum

The two available types are:
Company
Individual

Each will present a different onboarding flow to your vendors

Yes

url

Recommended

String

Individual onboarding
Profile URL (website, blog, social network profile)

Company onboarding
Official Website URL

No

serviceDescription

Recommended

String

Individual onboarding
Description of the provided service

Not relevant for Company onboarding

Yes

category

Recommended

Enum

Individual and Company onboarding

MCC Enum

List of all
MCC codes

Yes

address

Recommended

Address

Individual onboarding
Vendor's personal address

Company onboarding
Corporate address

Address Object
country: string, ISO 3166-1 alpha-2 code
city: string
street: string
houseNumber: string
flatNumber: string (optional)
postCode: string

No

createOnboardingLink

Recommended

boolean

Individual and Company onboarding

True - you will receive an onboarding link in the API response

False - you will NOT receive an onboarding link in the API response

Yes

Autocomplete full addresses

In the UK, full and accurate addresses, that include at least city, street name and house number, are required for the automated vendor validation process, and are an integral part of KYC/KYB verification.

Making sure your vendors provide a full address is crucial for a successful onboarding process.

When pre-populating vendor information or onboarding vendors via API, make sure that every vendor has a full and accurate address with the above mentioned fields included.


Go Next

Now you can choose your integration type: