Get one check definition

One definition in full: subject applicability, consent requirement, price, required inputs, output fields, retry policy and freshness.

Authorization

AuthorizationBearer <token>

Use Authorization: Bearer vrf_live_... or vrf_test_....

In: header

Path Parameters

checkName*string

The check to act on.

Value in

"IDENTITY"
"KRA_PIN"
"EMPLOYER_VERIFICATION"
"BUSINESS_VERIFICATION"
"CRB_SCORE"
"CRB_STANDARD"
"CRB_FULL"
"CREDITINFO_SCORE"
"CREDITINFO_STATUS"
"CREDITINFO_COMP"

Response Body

`application/json`

`application/problem+json`

curl -X GET "https://example.com/api/v1/checks/definitions/IDENTITY"

{  "name": "IDENTITY",  "displayName": "string",  "category": "string",  "description": "string",  "subjectTypes": [    "INDIVIDUAL"  ],  "active": true,  "requiresConsent": true,  "price": {    "amount": 0.1,    "currency": "KES"  },  "requiredInputs": [    {      "key": "string",      "label": "string",      "type": "TEXT",      "required": true,      "description": "string"    }  ],  "outputFields": [    "string"  ],  "freshnessDays": 0,  "retryPolicy": {}}