Sign in
Funding

Read the buyer's onramp identity state

Changed on

Reads the buyer's identity state at the provider — which regulatory region they fall under, the verification tier they have reached, and which identity steps they have already satisfied.

The embedded flow needs this to prompt for exactly what is outstanding: without it a client can only infer the remaining steps, and re-asks for declarations the buyer already made.

get/v2/funding/onramp/identity

Request

  • Base URL: https://api.openfort.io
  • URL: https://api.openfort.io/v2/funding/onramp/identity
  • Auth: HTTP bearer

Query parameters

authIntentIdstring required
customerRefstring required

Response

Buyer identity state resolved.

region'us' | 'eu' | 'null' nullable required

Regulatory region the provider judged the buyer to be in.

level'L0' | 'L1' | 'L2' | 'PENDING' | 'REJECTED' | 'REQUIRES_KYC' required

Verification tier reached; anything but L0/L1/L2 means more is needed.

providedFieldsstring[] required

Changes