Returns kyc state of the user with the provided phone number, also returns supported documents for KYC submission
/api/kyc/state
curl -L \
--url 'https://sandbox-api.fonbnk.com/api/kyc/state?phoneNumber=text' \
--header 'x-client-id: YOUR_API_KEY'{
"kycUrl": "https://aten.fonbnk-services.com/kyc?phone=254110611756",
"passedKyc": true,
"kycStatus": "approved",
"kycStatusDescription": "Exact Match",
"reachedKycLimit": false,
"offrampKycRules": [
{
"type": "bank",
"minAmount": 10
}
],
"onrampKycRules": [
{
"type": "carrier",
"minAmount": 7
}
],
"documentTypes": [
{
"title": "National ID",
"value": "NATIONAL_ID",
"requiredFields": {
"first_name": {
"type": "string",
"label": "First Name",
"required": true
},
"last_name": {
"type": "string",
"label": "Last Name",
"required": true
},
"dob": {
"type": "date",
"label": "Date of birth",
"required": true
},
"email": {
"type": "email",
"label": "Email",
"required": true
},
"id_number": {
"type": "string",
"label": "ID number",
"required": true,
"format": "00000000",
"regexp": "^[0-9]{1,9}$"
}
}
},
{
"title": "National ID (no photo)",
"value": "NATIONAL_ID_NO_PHOTO",
"requiredFields": {
"first_name": {
"type": "string",
"label": "First Name",
"required": true
},
"last_name": {
"type": "string",
"label": "Last Name",
"required": true
},
"dob": {
"type": "date",
"label": "Date of birth",
"required": true
},
"email": {
"type": "email",
"label": "Email",
"required": true
},
"id_number": {
"type": "string",
"label": "ID number",
"required": true,
"format": "00000000",
"regexp": "^[0-9]{1,9}$"
}
}
},
{
"title": "Passport",
"value": "PASSPORT",
"requiredFields": {
"first_name": {
"type": "string",
"label": "First Name",
"required": true
},
"last_name": {
"type": "string",
"label": "Last Name",
"required": true
},
"dob": {
"type": "date",
"label": "Date of birth",
"required": true
},
"email": {
"type": "email",
"label": "Email",
"required": true
},
"id_number": {
"type": "string",
"label": "ID number",
"required": true,
"format": "A00000000",
"regexp": "^[A-Z0-9]{7,9}$"
}
}
},
{
"title": "Alien Card",
"value": "ALIEN_CARD",
"requiredFields": {
"first_name": {
"type": "string",
"label": "First Name",
"required": true
},
"last_name": {
"type": "string",
"label": "Last Name",
"required": true
},
"dob": {
"type": "date",
"label": "Date of birth",
"required": true
},
"email": {
"type": "email",
"label": "Email",
"required": true
},
"id_number": {
"type": "string",
"label": "ID number",
"required": true,
"format": "000000",
"regexp": "^[0-9]{6,9}$"
}
}
}
]
}Successful response