Get aggregate onboarding status

Production

GET

/v1/onboarding/status

Returns the effective profile's customer entities and aggregated provider/KYC state. Non-terminal provider statuses may be refreshed before the response is built.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Responses

🟢200

application/json

Aggregated onboarding state returned.

Bodyapplication/json

🟠400

🔴500

🟠401ManagedSelectorUnauthorized

🟠403ManagedSelectorForbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/onboarding/status' \
--header 'X-Managed-Profile-Id;' \
--header 'X-API-Key: <api-key>'

Response Example

200 - Example 1

{
    "activeEntityId": "d6ebdaf2-2d3f-4937-88a1-2746f3c0393f",
    "entities": [
        {
            "accounts": [
                {
                    "companyName": "string",
                    "country": "string",
                    "customerType": "individual",
                    "error": null,
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "kycCase": null,
                    "provider": "alfredpay",
                    "rail": "string",
                    "state": "pending",
                    "status": "pending",
                    "statusExternal": "string",
                    "taxReference": "string"
                }
            ],
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "status": "active",
            "type": "individual"
        }
    ],
    "roles": [
        "string"
    ],
    "selectionRequired": true
}

Modified at 2026-08-19 18:12:57

Discover KYC or KYB requirements

List managed profiles