---
title: "Get onboarding status"
method: GET
path: "/v2/onboarding/me"
tags: ["Onboarding API"]
---

# Get onboarding status

`GET /v2/onboarding/me`

## Request

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

Retrieve the onboarding status of the currently authenticated organization.

> 🔑 Access with
>
> [Advanced access token with **onboarding.read**](/reference/authentication)
>
> [OAuth access with **onboarding.read**](/reference/authentication)

## Response `200`

The onboarding status object of the current organization.

- object
  - `resource` string, required: Indicates the response contains an onboarding status object. Will always contain the string `onboarding` for this resource type.
  - `name` string, required: The name of the organization.
  - `status` string, required: The current status of the organization's onboarding process. Possible values: `needs-data` `in-review` `completed`
  - `canReceivePayments` boolean, required: Whether the organization can receive payments.
  - `canReceiveSettlements` boolean, required: Whether the organization can receive settlements to their external bank account.
  - `signedUpAt` string, required: The sign up date time of the organization in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
  - `_links` object, required: An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
    - `self` object: In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.
    - `dashboard` object: Direct link to the onboarding process in the Mollie dashboard. The merchant can be redirected to this page to complete their onboarding.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.
    - `organization` object: The API resource URL of the organization.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.
    - `documentation` object: In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
      - `href` string, required: The actual URL string.
      - `type` string, required: The content type of the page or endpoint the URL points to.

## Other responses

- `429`: Rate Limit has been reached.

---

[API](https://skmtc.dev/mollie/apis/mollie-connect.md) - [All operations](https://skmtc.dev/mollie/apis/mollie-connect/llms.txt) - [OpenAPI document](https://skmtc.dev/mollie/apis/mollie-connect/revisions/65271e79a786?raw)