Get sanitized ramp eligibility

Production

GET

/v1/ramp-info

Returns only sanitized per-corridor KYC state and buy/sell eligibility for the profile derived from the validated API credential. A manager secret may select one directly managed child with X-Managed-Profile-Id; public keys cannot use the selector. The endpoint never returns PII, provider/customer IDs, KYC failure reasons, bank/wallet data, ramp history, or exact financial limits. When both public and secret headers are supplied they must belong to the same credential. Supabase Bearer sessions do not authorize this endpoint.

Auth: X-Public-Key or X-API-Key.

Request

Authorization

API Key

Add parameter in header

X-Public-Key

Example:

X-Public-Key: ********************

API Key

Add parameter in header

X-API-Key

Example:

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

Header Params

Responses

🟢200

application/json

Sanitized corridor eligibility.

Bodyapplication/json

🟠400

🟠401

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/ramp-info' \
--header 'X-Managed-Profile-Id;' \
--header 'X-Public-Key: <api-key>'

Response Example

200 - Example 1

{
    "corridors": {
        "property1": {
            "canBuy": true,
            "canSell": true,
            "kycStatus": "not_started"
        },
        "property2": {
            "canBuy": true,
            "canSell": true,
            "kycStatus": "not_started"
        }
    }
}

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

Get user ramp limits

List the user's API keys