Getting started
Quickstart
Create your first verification session and read its result in minutes.
Prerequisites
- An AveTrust API key (
sk_test_…for sandbox). See Authentication. - Export it:
export AVETRUST_API_KEY=sk_test_…
1. Create a verification session
curl https://api.avetrust.net/api/v1/sessions \
-H "X-Api-Key: $AVETRUST_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"checks": ["DOCUMENT", "LIVENESS", "FACE_MATCH"],
"callbackUrl": "https://your-app.example/kyc/webhook"
}'The response contains the session and the hosted portal link:
{
"sessionId": "b0e78b78-…",
"sessionToken": "st_…",
"status": "PENDING",
"expiresAt": "2026-08-05T12:00:00Z",
"hostedUrl": "https://verify.avetrust.net/s/st_…"
}hostedUrl is white-label
If your organization has a custom domain configured, hostedUrl uses it (e.g.
https://verify.your-bank.com/s/…). Otherwise it falls back to the AveTrust
domain. See Hosted portal.
2. Let your user complete it
Open hostedUrl on a phone (or send it by email/SMS — see
send the link). The user scans their
ID and takes a selfie with liveness detection.
3. Read the result
Poll the result, or better, receive a webhook.
curl https://api.avetrust.net/api/v1/sessions/SESSION_ID/result \
-H "X-Api-Key: $AVETRUST_API_KEY"Test without a phone
In sandbox, pass simulate: "approved" (or "rejected", "review") when
creating the session to force a verdict — no capture needed. See
Sandbox.
Next steps
- Authentication — keys and headers.
- Verification sessions — the lifecycle.
- SDKs — the same flow in your language.