kyc

Get KYC state

Returns kyc state of the user with the provided phone number, also returns supported documents for KYC submission

get/api/kyc/state

Request

Base URL
https://sandbox-api.fonbnk.com
Auth
- API key in header x-client-id
- or API key in header x-timestamp
- or API key in header x-signature
TypeScript
https://skmtc.dev/fonbnk/apis/fonbnk-on-ramp-api/docs/api/kyc/state/get.ts
A function with typed inputs. Its response is checked against the schema.

phoneNumberstring

emailstring

Successful response

kycUrlstring

URL to the KYC form

passedKycboolean

Indicates if the user has passed KYC

kycStatus'initiated' | 'approved' | 'rejected' | 'invalid'

Status of the last KYC

No recorded changes to this operation across all 1 revision of this API.