Kyc

KYC

Get KYC state

get

https://sandbox-api.fonbnk.comhttps://aten.fonbnk-services.com

/api/kyc/state

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

Authorizations

ClientIdHeaderTimestampHeaderSignatureHeader

x-client-idstringRequired

Query parameters

phoneNumberstringOptional

emailstringOptional

Responses

200

Successful response

application/json

kycUrlstringOptional

URL to the KYC form

passedKycbooleanOptional

Indicates if the user has passed KYC

kycStatusenum · enumOptional

Status of the last KYC

Possible values:

get

/api/kyc/state

HTTPcURLJavaScriptPython

GET /api/kyc/state HTTP/1.1
Host: sandbox-api.fonbnk.com
x-client-id: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "kycUrl": "https://aten.fonbnk-services.com/kyc?phone=254110611756",
  "offrampKycRules": [
    {
      "type": "bank",
      "minAmount": 10
    }
  ],
  "onrampKycRules": [
    {
      "type": "carrier",
      "minAmount": 7
    }
  ],
  "passedKyc": true,
  "kycStatus": "approved",
  "kycStatusDescription": "Exact Match",
  "reachedKycLimit": false,
  "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}$"
        }
      }
    }
  ]
}