Skip to main content
This quickstart covers Identity Verification (KYC) — the most common starting point. For other products, jump directly to:

​
Prerequisites

Before you begin, you need:
Keep your API Secret confidential. Never expose it in client-side code, public repositories, or frontend applications.

​
Step 1: Generate a verification token

Create a verification session by calling the token generation endpoint. Use your API Key and Secret for Basic Auth. 
curl -X POST https://ivs.idenfy.com/api/v2/token \
  -H "Content-Type: application/json" \
  -u "YOUR_API_KEY:YOUR_API_SECRET" \
  -d '{
    "clientId": "unique-customer-id-123"
  }'
Response: 
{
  "authToken": "pgYQX0z2T8msB64gkl...",
  "scanRef": "d2714c8a-ec05-11ec-8ea0-0242ac120002",
  "clientId": "unique-customer-id-123",
  "redirectUrl": "https://ivs.idenfy.com/api/v2/redirect?authToken=pgYQX0z2T8msB64gkl..."
}

​
Step 2: Redirect your customer

Send your customer to the redirectUrl from the response. They will:
  1. Select their document type and country
  2. Upload or capture their ID document
  3. Complete a liveness check (selfie)
Redirect the user’s browser to the redirectUrl:
window.location.href = data.redirectUrl;

​
Step 3: Receive results

Set up a webhook endpoint to receive verification results. Configure your webhook URL in Dashboard → Settings → Webhooks).
Example webhook payload
{
  "final": true,
  "status": {
    "overall": "APPROVED",
    "autoDocument": "DOC_VALIDATED",
    "autoFace": "FACE_MATCH",
    "manualDocument": "DOC_VALIDATED",
    "manualFace": "FACE_MATCH"
  },
  "scanRef": "d2714c8a-ec05-11ec-8ea0-0242ac120002",
  "clientId": "unique-customer-id-123",
  "data": {
    "docFirstName": "JOHN",
    "docLastName": "DOE",
    "docNumber": "AB1234567",
    "docExpiry": "2028-12-31",
    "selectedCountry": "US",
    "selectedDocType": "ID_CARD"
  }
}
Use the Testing & Sandbox to simulate different verification outcomes before going live.

​
What’s next?

​
Continue with KYC

Token parameters

Customize with country restrictions, document types, liveness, AML checks.

Webhook reference

Full webhook payload with all status codes and data fields.

Choose integration method

Compare redirect, iFrame, SDK, and no-code options.

Go live checklist

Everything to verify before switching to production.

​
Explore other products

Business Verification (KYB)

Verify companies, retrieve registry data, screen beneficial owners.

AML Screening

Screen against sanctions, PEPs, and adverse media.

Fraud Prevention

Risk scoring, proxy detection, phone and address verification.

Face Authentication

Re-authenticate returning users with biometric face matching.