Pagination

All list endpoints use offset-based pagination with limit and offset query parameters.

Parameters

ParameterTypeDefaultDescription
limitintegervariesMaximum number of items to return (max 100).
offsetinteger0Number of items to skip before returning results.

Default limit values vary by endpoint:

EndpointDefault limit
GET /api/v1/sessions50
GET /api/v1/identities25
GET /api/v1/identities/\{id\}/sessions50
GET /api/v1/checks25

Example

Fetch the first page of sessions:

$curl "https://api.withverifa.com/api/v1/sessions?limit=10&offset=0" \
> -H "X-API-Key: vk_live_your_key_here"

Fetch the second page:

$curl "https://api.withverifa.com/api/v1/sessions?limit=10&offset=10" \
> -H "X-API-Key: vk_live_your_key_here"

Filtering

Most list endpoints support additional filters alongside pagination:

EndpointFilters
GET /api/v1/sessionsstatus — filter by session status
GET /api/v1/identitiesstatus — filter by identity status
q — search by external reference

Total counts

Some endpoints return a total field indicating the total number of matching records. Use this to calculate the number of pages:

1{
2 "data": [...],
3 "pagination": {
4 "total": 142,
5 "limit": 25,
6 "offset": 0
7 }
8}
total_pages = ceil(total / limit)