Get onboarding status

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

Get the status of onboarding of the authenticated organization.

Parameters

There are no parameters for this endpoint.

Response

200 application/hal+json

resourcestring
Indicates the response contains an onboarding object. Will always contain onboarding for this endpoint.
namestring
The name of the organization.
signedUpAtdatetime
The sign up date and time of the organization.
statusstring

The current status of the organization’s onboarding process. Possible values:

  • needs-data The onboarding is not completed and the merchant needs to provide (more) information
  • in-review The merchant provided all information and Mollie needs to check this
  • completed The onboarding is completed
canReceivePaymentsboolean
Whether or not the organization can receive payments.
canReceiveSettlementsboolean
Whether or not the organization can receive settlements.
_linksobject

An object with several URL objects relevant to the onboarding status. Every URL object will contain an href and a type field.

Show child parameters

selfURL object
The API resource URL of this endpoint itself.
dashboardURL object
The URL of the onboarding process in Mollie Dashboard. You can redirect your customer to here for e.g. completing the onboarding process.
organizationURL object
The API resource URL of the organization.
documentationURL object
The URL to the onboarding status retrieval endpoint documentation.

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/onboarding/me \
     -H "Authorization: Bearer access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

1
2
3
4
5
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");

$onboarding = $mollie->onboarding->get();

1
2
3
4
5
6
from mollie.api.client import Client

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

onboarding = mollie_client.onboarding.get("me")

1
2
3
4
5
Mollie::Client.configure do |config|
  config.api_key = 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM'
end

Mollie::Onboarding.me

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 share suggestions on our Discord:
https://discord.gg/VaTVkXB4aQ

Response

 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
29
HTTP/1.1 200 OK
Content-Type: application/json

{
    "resource": "onboarding",
    "name": "Mollie B.V.",
    "signedUpAt": "2018-12-20T10:49:08+00:00",
    "status": "completed",
    "canReceivePayments": true,
    "canReceiveSettlements": true,
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/onboarding/me",
            "type": "application/hal+json"
        },
        "dashboard": {
            "href": "https://www.mollie.com/dashboard/onboarding",
            "type": "text/html"
        },
        "organization": {
            "href": "https://api.mollie.com/v2/organization/org_12345",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/onboarding-api/get-onboarding-status",
            "type": "text/html"
        }
    }
}