Discover KYC or KYB requirements

Production

GET

/v1/onboarding/requirements

Returns versioned document and ordered action metadata for an existing supported onboarding flow. GET operations, status polling, and readiness checks are intentionally omitted and remain documented in the integration guides and OpenAPI. Request fields and bodies are defined only by the referenced OpenAPI schemas and are not duplicated at the top level. This endpoint does not return profile state or customer PII. Monerium is outside this discovery proposal.

Request

Query Params

Responses

🟢200

application/json

Flow metadata and ordered non-GET action sequence.

Bodyapplication/json

🟠400

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/onboarding/requirements?country=&customerType='

Response Example

200 - Example 1

{
    "country": "AR",
    "customerType": "individual",
    "documentationUrl": "http://example.com",
    "documents": [
        {
            "acceptedMediaTypes": [
                "string"
            ],
            "collection": "direct-upload",
            "description": "string",
            "required": true,
            "requiredWhen": "string",
            "type": "string"
        }
    ],
    "flow": "string",
    "mode": "api",
    "openapiUrl": "http://example.com",
    "provider": "alfredpay",
    "requirementsVersion": "string",
    "steps": [
        {
            "condition": "string",
            "derivedValues": {
                "property1": "string",
                "property2": "string"
            },
            "description": "string",
            "fixedBody": {
                "property1": "string",
                "property2": "string"
            },
            "fixedQuery": {
                "property1": "string",
                "property2": "string"
            },
            "kind": "api",
            "method": "POST",
            "operationId": "string",
            "order": 1,
            "path": "string",
            "repeatFor": "string",
            "requestSchema": "string"
        }
    ]
}

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

Select active customer entity

Get aggregate onboarding status