verification

List my verification sessions

The caller's own verification sessions (one row per provider and type). Self-scoped: a filter narrows this set and can never reach another account's rows. With NO query string the response is the legacy {success, data:[...], count} shape, every row, provider ASC — unchanged for existing clients. With limit or offset the response is the ADR 0003 envelope {success, data:{items, total, filtered, limit, offset}}: total is the caller's row count before filters, filtered after, items one page; limit=0 returns the counts alone. Filters or a sort WITHOUT limit/offset return the legacy shape over the filtered, sorted rows. status/type/provider are comma-separated ORs; an unrecognised member matches nothing (never a 400). q is a case-insensitive substring match over session_id, provider, status and last_error. from/to bound "last moved" = verified_at, else updated_at: YYYY-MM-DD is an inclusive whole UTC day, RFC3339 an exact instant (to exclusive); malformed is a 400. since/until and created_after/created_before are accepted as aliases. Every sort tiebreaks on id in the same direction, so pages never repeat or skip a row. An unknown query KEY is 400 unknown_param.

get/verification/sessions

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/verification/sessions
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Query parameters

statusstring

csv of statuses, OR'd (pending, active, verified, failed, expired, revoked); unknown members match nothing

typestring

csv of verification types, OR'd (kyc, kyb, tax_id_selfie, ...)

providerstring

csv of provider slugs, OR'd (cybrid, activecampaign, ...)

qstring

case-insensitive substring over session_id, provider, status, last_error

fromstring

last-moved >= this (YYYY-MM-DD = start of that UTC day, or RFC3339)

tostring

last-moved < this (YYYY-MM-DD = end of that UTC day inclusive, or RFC3339 exclusive)

sort'created' | 'updated' | 'status' | 'type' | 'attempts'

sort field

sort_dir'asc' | 'desc'

sort direction

limitinteger

page size 1..200 (clamped); 0 = counts only; absent = unpaged legacy shape

offsetinteger

page offset >= 0

group_idstring uuid

only when the caller's account is a member of this group (uuid); an empty list otherwise. 404 group_not_found if the group is not visible to you

exclude_group_idstring uuid

only when the caller's account is NOT a member of this group (uuid); same 404 rule

Response

paged envelope (legacy {success,data:[],count} when limit/offset absent)

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.