List available checks

GET

/api/v1/kyc/checks

const url = 'https://connect.payhero.africa/api/v1/kyc/checks';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://connect.payhero.africa/api/v1/kyc/checks \
  --header 'Authorization: Basic <credentials>'

Returns the catalogue of identity checks, each with the fields it needs. Fields with a fixed set of values (a bank, a country) carry an options array. Read the catalogue rather than hardcoding it — a new check reaches your integration without a release on your side.

Authorizations

basicAuth

Responses

200

The available checks.

application/json

Array<object>

One available check and the fields it needs.

object

key

string

label

string

country

ISO country code, or GLOBAL for checks that take the country as an input field.

string

category

The kind of check, independent of which provider ran it. Decides what a token is worth when attached to a Team’s KYC.

string

Allowed values: national_id tax_id phone passport bank_account bank_id company

description

string

fields

Array<object>

object

name

string

label

string

required

boolean

hint

string

options

Present when the field has a fixed set of values, e.g. a bank or a country.

Array<object>

object

value

string

label

string

Example

[
  {
    "key": "kra_pin",
    "label": "KRA PIN",
    "country": "KE",
    "category": "national_id",
    "description": "Confirms a KRA PIN is registered and active, and returns the taxpayer name.",
    "fields": [
      {
        "name": "number",
        "label": "KRA PIN",
        "required": true,
        "hint": "A123456789B",
        "options": [
          {
            "value": "34",
            "label": "Equity Bank"
          }
        ]
      }
    ]
  }
]

401

Missing or invalid Basic auth credentials.

application/json

object

error_code

string

error_message

string

status_code

integer

Example

{
  "error_code": "invalid_argument",
  "error_message": "the transaction amount is insufficient as it wont cater for cost: (4.62)",
  "status_code": 400
}