Verification ChecksVerificationsKenyan Identity check on IPRS (Internal Population Registration Service)
List reports
Lists reports in your workspace. It is not filtered to Kenyan Identity check on IPRS (Internal Population Registration Service) — read each report's checks to see what it ran.
Scope: reports:read
Reports in your workspace, newest first, as summaries. Fetch a single report for its check results.
AuthorizationBearer <token>
Use Authorization: Bearer vrf_live_... or vrf_test_....
In: header
Query Parameters
page?integer
Zero-based page number. The first page is 0.
Range
0 <= valueDefault
0size?integer
Records per page. Large values are capped.
Range
1 <= value <= 200Default
20search?string
Free-text search. Supported fields vary by resource.
status?string
Return only reports in this lifecycle state.
Value in
- "DRAFT"
- "PENDING_CONSENT"
- "PENDING_PAYMENT"
- "PROCESSING"
- "PARTIAL"
- "COMPLETED"
- "READY"
- "PENDING_REVIEW"
- "REVIEW_REJECTED"
- "RELEASED"
- "FAILED"
- "CANCELLED"
subjectType?string
Filter by subject type.
Value in
- "INDIVIDUAL"
- "BUSINESS"
from?string
Inclusive start date.
Format
dateto?string
Inclusive end date.
Format
datesortBy?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
curl -X GET "https://example.com/api/v1/reports?page=0&size=20&sortBy=createdAt"{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "subjectName": "string", "subjectType": "INDIVIDUAL", "status": "DRAFT", "riskScore": 0, "checksCount": 0, "completedChecksCount": 0, "createdAt": "2019-08-24T14:15:22Z" } ], "page": 0, "size": 20, "totalItems": 42, "totalPages": 3, "hasNext": true, "hasPrevious": true}