Submit onboarding data

Onboarding API v2
POSThttps://api.mollie.com/v2/onboarding/me
Authentication:Organization access tokensApp access tokens

Submit data that will be prefilled in the merchant’s onboarding. Please note that the data you submit will only be processed when the onboarding status is needs-data.

Note

Information that the merchant has entered in their dashboard will not be overwritten.

Parameters

Please note that even though all parameters are optional, at least one of them needs to be provided in the request.

organizationobjectoptional

Data of the organization you want to provide.

Show child parameters

namestringoptional
Name of the organization.
addressaddress objectoptional

Address of the organization.

Show child parameters

streetAndNumberstringrequired
The street name and house number of the organization. If an address is provided, this field is required.
postalCodestringconditional
The postal code of the organization. If an address is provided, this field is required for countries with a postal code system.
citystringrequired
The city of the organization. If an address is provided, this field is required.
countrystringrequired
The country of the address in ISO 3166-1 alpha-2 format. If an address is provided, this field is required.
registrationNumberstringoptional
The Chamber of Commerce registration number of the company.
vatNumberstringoptional
The VAT number of the company, if based in the European Union. The VAT number will be checked with the VIES service by Mollie.
vatRegulationstringoptional
The organization’s VAT regulation, if based in the European Union. Either shifted (VAT is shifted) or dutch (Dutch VAT rate) is accepted.
profileobjectoptional

Data of the payment profile you want to provide.

Show child parameters

namestringoptional
The profile name should reflect the trade name or brand name of the profile’s website or application.
urlstringoptional
The URL to the profile’s website or application. The URL must be compliant to RFC3986 with the exception that we only accept URLs with http:// or https:// schemes and domains that contain a TLD. URLs containing an @ are not allowed.
emailstringoptional
The email address associated with the profile’s trade name or brand.
descriptionstringoptional
A description of what kind of goods and/or products will be offered via the payment profile.
phonestringoptional
The phone number associated with the profile’s trade name or brand. Must be in the E.164 format. For example +31208202070.
businessCategorystringoptional

The industry associated with the profile’s trade name or brand.

Please refer to the documentation of the business category for more information on which values are accepted.

categoryCodeintegeroptional

Warning

This parameter is deprecated and will be removed in 2022. Please use the businessCategory parameter instead.

The industry associated with the profile’s trade name or brand.

Possible values:

  • 5192 Books, magazines and newspapers
  • 5262 Marketplaces, crowdfunding, donation platforms
  • 5399 General merchandise
  • 5499 Food and drinks
  • 5533 Automotive Products
  • 5641 Children Products
  • 5651 Clothing & Shoes
  • 5712 Home furnishing
  • 5732 Electronics, computers and software
  • 5734 Hosting/VPN services
  • 5735 Entertainment
  • 5815 Credits/vouchers/giftcards
  • 5921 Alcohol
  • 5944 Jewelry & Accessories
  • 5945 Hobby, Toy, and Game Shops
  • 5977 Health & Beauty products
  • 6012 Financial services
  • 6051 Crypto currency
  • 7299 Consultancy
  • 7922 Events, conferences, concerts, tickets
  • 7997 Gyms, membership fee based sports
  • 7999 Travel, rental and transportation
  • 8111 Lawyers and legal advice
  • 8299 Advising/coaching/training
  • 8398 Charity and donations
  • 8699 Political parties
  • 9399 Government services
  • 0 Other

Example

cURLPHPPythonRubyNode.js
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
curl -X POST https://api.mollie.com/v2/onboarding/me \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" \
     -d '{
             "organization": {
                "name": "Mollie B.V.",
                "address": {
                   "streetAndNumber": "Keizersgracht 126",
                   "postalCode": "1015 CW",
                   "city": "Amsterdam",
                   "country": "NL"
                },
                "registrationNumber": "30204462",
                "vatNumber": "NL815839091B01"
             },
             "profile": {
                "name": "Mollie",
                "url": "https://www.mollie.com",
                "email": "info@mollie.com",
                "phone": "+31208202070",
                "businessCategory": "MONEY_SERVICES"
             }
         }'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");

$mollie->onboarding->submit([
    "organization" => [
        "name" => "Mollie B.V.",
        "address" => [
           "streetAndNumber" => "Keizersgracht 126",
           "postalCode" => "1015 CW",
           "city" => "Amsterdam",
           "country" => "NL",
        ],
        "registrationNumber" => "30204462",
        "vatNumber" => "NL815839091B01",
    ],
    "profile" => [
        "name" => "Mollie",
        "url" => "https://www.mollie.com",
        "email" => "info@mollie.com",
        "phone" => "+31208202070",
        "businessCategory": "MONEY_SERVICES",
    ],
]);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
from mollie.api.client import Client

mollie_client = Client()
mollie_client.set_access_token('access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')

onboarding = mollie_client.onboarding.create(
    'me',
    data={
        'organization': {
            'name': 'Mollie B.V.',
            'address': {
                'streetAndNumber': 'Keizersgracht 126',
                'postalCode': '1015 CW',
                'city': 'Amsterdam',
                'country': 'NL',
            },
            'registrationNumber': '30204462',
            'vatNumber': 'NL815839091B01',
        },
        'profile': {
            'name': 'Mollie',
            'url': 'https://www.mollie.com',
            'email': 'info@mollie.com',
            'phone': '+31208202070',
            'businessCategory': 'MONEY_SERVICES',
        },
    },
)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Mollie::Client.configure do |config|
  config.api_key = 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM'
end

Mollie::Onboarding.submit(
  organization: {
    name: "Mollie B.V.",
    address: {
       streetAndNumber: "Keizersgracht 126",
       postalCode: "1015 CW",
       city: "Amsterdam",
       country: "NL"
    },
    registrationNumber: "30204462",
    vatNumber: "NL815839091B01"
  },
  profile: {
    name: "Mollie",
    url: "https://www.mollie.com",
    email: "info@mollie.com",
    phone: "+31208202070",
    businessCategory: "MONEY_SERVICES"
  }
)

1
2
3
4
We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

Response

1
HTTP/1.1 204 No Content