MOmollie
Onboarding API

Get onboarding status

Changed on

Retrieve the onboarding status of the currently authenticated organization.

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

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

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.

status'needs-data' | 'in-review' | 'completed' required

The current status of the organization's onboarding process.

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

{
  "resource": "onboarding",
  "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

  • 7cab62b21830Revision changes
    • info

      added the non-success response with the status

  • ef4b5a97b56aRevision changes
    • info

      the endpoint scheme security advancedAccessToken was added to the API

    • info

      the endpoint scheme security organizationAccessToken was removed from the API