Ramp
Get user KYC state
Returns the current KYC state for a user from Fonbnk. When cryptoAmount is provided, the response includes requiredKycType and canProceed so the client knows whether to prompt for KYC before creating an order.
get/ramp/kyc
Query parameters
provider'FONBNK' | 'ONRAMP_MONEY' | 'GUARDARIAN' required
The ramp provider to query KYC state from
userEmailstring required
Example:user@example.com
The end-user's email address (Fonbnk keys KYC state by this)
countryCodestring required
Example:NG
ISO 3166-1 alpha-2 country code
cryptoAmountnumber
Example:25
Amount of crypto (USDC) the user intends to receive. When provided, the response includes requiredKycType and canProceed.
Response
KYC state