API reference
API reference
The AveTrust REST API — base URL, authentication and endpoints.
Base URL — https://api.avetrust.net/api/v1 (production) or
https://api-test.avetrust.net/api/v1 (test).
Authentication — the X-Api-Key header on every request. See
Authentication.
Endpoints
| Method | Path | Description |
|---|---|---|
POST | /sessions | Create a verification session |
GET | /sessions/{id} | Retrieve a session summary |
GET | /sessions/{id}/result | Detailed result (checks + decision) |
GET | /sessions | List sessions (paginated, filter by status) |
POST | /sessions/{id}/send | Send the hosted link (EMAIL / SMS) |
POST | /sessions/{id}/decision | Decide (approved / rejected) |
GET | /sessions/events | Real-time SSE stream (text/event-stream) |
Create — body
{
"checks": ["DOCUMENT", "LIVENESS", "FACE_MATCH"],
"decisionMode": "AUTO",
"externalUserId": "user_42",
"callbackUrl": "https://your-app.example/kyc/webhook",
"simulate": "approved"
}simulate is honored only with a sk_test_ key. Defaults: checks →
["DOCUMENT","LIVENESS"], decisionMode → AUTO.
Create — response
{
"sessionId": "b0e78b78-…",
"sessionToken": "st_…",
"status": "PENDING",
"expiresAt": "2026-08-05T12:00:00Z",
"hostedUrl": "https://verify.avetrust.net/s/st_…"
}Prefer an SDK
The SDKs wrap these endpoints with typed models and webhook signature verification. A full OpenAPI spec is coming.
Next steps
- SDKs · Webhooks · Quickstart