Getting started

Set up a controlled workspace and make your first request safely.

Prepare the workspace

Sign in through the SmartVerify client portal. Confirm your wallet, permitted services and authorised users. API clients use a SmartVerify-issued token with the minimum client scope.

Gather inputs

Use required fields only, validate locally and use synthetic values in development. Never put real personal data, tokens or provider responses in frontend code or logs.

Submit with purpose and authority

Every request needs a specific lawful purpose, authority confirmation and charge approval. ID + Photo additionally needs biometric consent. Reuse one idempotency key on retries.

POST /api/v1/verifications
Authorization: Bearer sv_test_REDACTED
Idempotency-Key: onboarding-case-8421
Content-Type: application/json

{
  "service_code": "said_verification",
  "subject": "8001015009087",
  "purpose": "Employee onboarding for Example Ltd, case 8421",
  "authority_confirmed": true,
  "charge_approved": true
}

Read the result

201 is a new completed result; 202 means pending or manual review; 200 commonly indicates an idempotent replay.