Start Building with Amani

Overview

Amani is an identity verification platform. Every integration follows the same core flow: create a customer profile, send them a verification link or launch the SDK, they complete the ID + selfie check, and you receive the result via API or webhook. How you trigger that flow is what differs between integration methods.

Core Integration Flow

Regardless of the method you choose, every verification follows the same four steps:

Amani Products

No-Code (Studio)

Amani Studio lets you verify customers without writing any code. You create a profile, generate a verification link or QR code, and share it with your customer. The entire verification happens on their device — no app development required.

Step-by-Step Guide

Amani Verify App

Your customers can also complete verification using the Amani Verify mobile app — they scan the QR code from Studio or the API and are guided through the flow natively on their device.

API Integration

The Amani API lets you programmatically create customer profiles, generate verification links, and retrieve results. Ideal for automating your onboarding flow or embedding verification into your backend. Valid API credentials (username and password) are required.

Step 1 — Authenticate

Send a POST request to the login endpoint with your admin credentials:

POST /api/v1/auth/login/
Content-Type: application/json

{
  "email": "your@email.com",
  "password": "yourpassword"
}

Response:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Step 2 — Create a Customer Profile

Use the access token to create a new customer. All fields are optional — only a unique identifier is needed:

POST /api/v1/customer/
Authorization: Token <your_access_token>
Content-Type: application/json

{
  "id_card_number": "UNIQUE_ID_123",
  "name": "John",
  "surname": "Doe",
  "email": "john.doe@example.com",
  "phone": "+905001234567"
}

Response — store the token, this is the profile token:

{
  "token": "PROFILE_TOKEN_XYZ..."
}

Step 3 — Generate a Verification Link

Construct the verification link using the profile token and your server region:

https://verify.amani.ai?pid=<PROFILE_TOKEN>&server_url=https://{region}.amani.ai

Example:

https://verify.amani.ai?pid=be1a2e01HX79R...A757XPS&server_url=https://eu.amani.ai

Step 4 — Send the Link & Receive Results

Share the link via email, SMS, WhatsApp, or display it as a QR code. The customer is guided through ID upload, selfie capture, and background verification. Once complete, retrieve the result by polling the API or via a webhook.

SDK Integration

Amani SDKs let you embed the full verification experience natively inside your mobile or web application. Customers never leave your app — ID capture, selfie, and verification all happen in-context.

Choosing Your SDK

Amani offers three SDK tiers depending on your needs:

Platform Support

🎤 Voice Assistant

The Voice Assistant is an accessibility add-on that guides customers through the verification process using audio instructions. It runs alongside the KYC SDK and can be added to any mobile integration.

General Integration Flow

Regardless of platform, all SDK integrations follow the same pattern:

Receiving Results

Once a customer completes the verification process, Amani provides two ways to receive the outcome: polling via the API or real-time push via webhooks. Most production integrations use webhooks.

Option 1 — Polling the API

Query the customer's verification status at any time using the API:

GET /api/v1/customer/<customer_id>/
Authorization: Token <your_access_token>

The response includes the customer's current status, document results, and any service outcomes. Full API reference is available in the API Reference →

Option 2 — Webhooks (Recommended)

Webhooks allow Amani to push a notification to your server the moment a verification event occurs — no polling required. This is the recommended approach for production systems.

When a customer completes verification, Amani sends an HTTP POST to your endpoint with the customer / profile ID, verification status, document type and result, and timestamp. Always verify the webhook signature using your secret key before processing the payload.

Verification Statuses