REST API v1

One API for KYC, documents & compliance

Authenticate with API keys, create verification sessions, and receive structured decisions. Designed for server-to-server integration and mobile SDK backends.

Quick start

Base URL: https://api.ideevy.ai/v1
Sandbox keys available after demo — no card required for evaluation.

1
Create API key
Dashboard → Settings → API keys (Bearer token).
2
Start verification
POST /verifications with country and document type.
3
Receive result
Poll GET /verifications/:id or use webhooks.

# Example: create session
curl -X POST https://api.ideevy.ai/v1/verifications \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "referenceId": "user-9281",
    "country": "US",
    "documentType": "drivers_license"
  }'

Core endpoints

POST/v1/verifications

Create a new verification session. Returns sessionUrl for hosted flow or upload tokens for direct API upload.

GET/v1/verifications/{id}

Retrieve session status, extracted document fields, and final decision.

POST/v1/verifications/{id}/documents

Upload document images (front/back) when not using hosted capture.

POST/v1/screening

Standalone AML screening (PEP, sanctions, adverse media) without full ID flow.

GET/v1/countries

List supported countries, document types, and required fields per jurisdiction.

Webhooks

Subscribe to verification.completed, verification.review, and verification.failed. Payloads are signed with HMAC-SHA256.

{
  "event": "verification.completed",
  "data": {
    "id": "ver_abc123",
    "status": "approved",
    "referenceId": "user-9281"
  }
}