Verification ChecksCatalogue

List available check definitions

GET
/api/v1/checks/definitions

The checks available to your workspace, a page at a time.

Read this rather than hard-coding the catalogue: checks are activated and retired without an API version change. Requires an API key; no dedicated scope. See pagination.

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

subjectType?string

Return only items that apply to this subject type.

Value in

  • "INDIVIDUAL"
  • "BUSINESS"
page?integer

Zero-based page number. The first page is 0.

Range0 <= value
Default0
size?integer

Records per page. Large values are capped.

Range1 <= value <= 200
Default20
search?string

Free-text search. Supported fields vary by resource.

sortBy?string

Sort key. An unsupported key falls back to the endpoint's default order.

sortDirection?string

Sort direction.

Default"asc"

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/problem+json

curl -X GET "https://example.com/api/v1/checks/definitions?page=0&size=20&sortBy=name"
{  "items": [    {      "id": "0a000137-a0cd-164f-81a0-cde9e7760000",      "checkName": "IDENTITY",      "displayName": "Identity verification",      "description": "Verify a Kenyan national ID.",      "checkCategory": "IDENTITY",      "currencyCode": "KES",      "active": true,      "turnaroundMinutes": 2,      "icon": "shield-check",      "colour": "#2563eb",      "sortOrder": 10,      "outputFields": [        "identityMatched",        "riskLevel"      ],      "prerequisiteChecks": [],      "failureBehaviour": "REVIEW",      "retryAttempts": 0,      "retryDelaySeconds": 0,      "freshnessDays": 60    }  ],  "page": 0,  "size": 10,  "totalItems": 18,  "totalPages": 2,  "hasNext": true,  "hasPrevious": false}