Checks
List available check definitions
Every active check, with prices already resolved for your workspace.
Read this rather than hard-coding the catalogue — prices are workspace-specific, and checks are activated and retired without an API version change. Requires an API key; no dedicated scope.
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"
- "COMPANY"
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/checks/definitions"[ { "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": {} }]