MOmollie
Onboarding API

Get onboarding status

Retrieve the onboarding status of the currently authenticated organization.

🔑 Access with

Advanced access token with onboarding.read

OAuth access with onboarding.read

get/v2/onboarding/me

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/onboarding/me
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: onboarding.read

Response

The onboarding status object of the current organization.

resourcestring required

Indicates the response contains an onboarding status object. Will always contain the string onboarding for this resource type.

namestring required

The name of the organization.

statusstring required

The current status of the organization's onboarding process.

Possible values: needs-data in-review completed

canReceivePaymentsboolean required

Whether the organization can receive payments.

canReceiveSettlementsboolean required

Whether the organization can receive settlements to their external bank account.

signedUpAtstring required

The sign up date time of the organization in ISO 8601 format.

Example response

{
  "name": "My webshop",
  "status": "completed",
  "canReceivePayments": true,
  "canReceiveSettlements": true,
  "signedUpAt": "2023-01-15T13:45:30+00:00",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "dashboard": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "organization": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.