State

Get KYC state

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

GEThttps://sandbox-api.fonbnk.com/api/kyc/state

Query parameters

Response

200

Successful response

Body

application/json

kycUrlstring

URL to the KYC form

offrampKycRequiredboolean

Indicates if KYC is required for the offramp for the user

onrampKycRequiredboolean

Indicates if KYC is required for the onramp for the user

passedKycboolean

Indicates if the user has passed KYC

kycStatusenum

Status of the last KYC

initiatedapprovedrejectedinvalid

Request

JavaScriptCurlPython

const response = await fetch('https://sandbox-api.fonbnk.com/api/kyc/state?phoneNumber=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "kycUrl": "text",
  "offrampKycRequired": false,
  "onrampKycRequired": false,
  "passedKyc": false,
  "kycStatus": "initiated"
}