KYC Web (White- Label) - The implementation guide
Five Implementation Steps
Step 1: White-Label configuration
Customize the interface to align with your company's brand:
- Access to the Platform JAAK
- To navigate to Adjustments → My Company
- Click Edit button
- Retiring Company Name, Loading logo and Defining Primary / Secondary Colors
Step 2: Establishment of a Session KYC
Option A: Method API (Recommended)
Endpoint:
POST https://sandbox.api.jaak.ai/api/v1/kyc/flow
Required Headers:
Authorization: Bearer YOUR_API_KEY
Body Parameters:
| Parameter | Required | Description |
|---|---|---|
name | Yes | Full user name |
flow | Yes | Session name / identifier |
countryDocument | Yes | Country code (Alpha 3, e.g. "MEX") |
flowType | Yes | Type of KYC (typically)KYC") |
redirectUrl | No | Redirection URL at complete |
verificationType | No | Reporting method: "Whatsapp," "sms," "email" or "" |
verification | No | Object with contact details |
Example of an application:
{
"name": "User Name",
"flow": "OnBoarding",
"countryDocument": "MEX",
"redirectUrl": "https://www.ejemplo.com/verificacion-completa",
"verificationType": "email",
"verification": {
"EMAIL": "usuario@email.com"
}
}
Answer:
{
"sessionUrl": "https://sandbox.kyc.jaak.ai/session/WIoGa8e"
}
The last 7 characters represent the Short Key.
Note: Telephone numbers for SMS / WhatsApp should include country code (e.g. + 52 for Mexico, + 1 for USA).
Option B: Manual Method in the Platform
- Navigation to KYC → Meetings
- Click "Create New Session KYC"
- Complete user information and redirection URL
- Copy generated session URL
Step 3: To target Flow User KYC
Direct Retirement: Put the Session Url onto a button ("Check My Identity") at your site / app
Automatic notification: Configure Call API so that JAAK send the link to WhatsApp, SMS or email
Once users gain access to Sessional Url, they navigate through:
- Acceptance of terms and privacy policy
- Issuance of geolocalization permits
- Collection from front of document
- Reg capture of document
- Facial verification video engrave
Step 4: Reporting and Recovery of Results
After complete, users are redirected to your redirectUrl.
Option Webhole (Recommended):
- Go to Adjustments → My Company → Edit
- Locate Product Section
- Enter endpoint URL into field "KYC Webhole "
Email option: Configure directly into the Platform's options JAAK
Also you can manually review results at KYC → Sessions.
Step 5: Session Detail Consultation
- login https://platform.jaak.ai or https://sandbox.jaak.ai
- Select KYC → Sessions of the seciebar
- See table with user names, session statements and timprints
- Click on any session to access:
- Individual service results (document check, survival, OFAC)
- Evidence captured (photos, video)
- Results of approval or rejection
- Download or share data using time links (if permitted)
Council: That view allows for audits, user support and capture quality assessment.