> For the complete documentation index, see [llms.txt](https://docs.vida.id/identity-stack/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vida.id/identity-stack/verify/kyc-mobile-sdk/about-vida-kyc-sdk.md).

# About VIDA KYC SDK

VIDA KYC Mobile SDK is a set of tools that lets you embed end-to-end KYC verification directly into your mobile apps with minimal custom development. The SDK combines document capture, OCR, document verification, passive liveness, and face match into a single, guided experience with a consistent UI across Android and iOS.

Without the SDK, engineering teams must design camera flows, implement image quality checks, integrate multiple APIs (OCR, liveness, face), and handle all the edge cases separately for each platform. With VIDA KYC Mobile SDK, you configure one flow that already knows how to capture the right frames, enforce quality thresholds, and talk to VIDA’s backend services.

## How VIDA KYC Mobile SDK Works

The SDK lets you verify applicants entirely inside your mobile application using a built-in VIDA KYC UI that you can customize to match your brand.

1. **Launch from your app**\
   Your app creates a KYC configuration (access token, flow type, region, document options, liveness configuration) and initializes the SDK.
2. **Guided document capture**\
   The SDK opens the camera, applies image-quality gates (blur, glare, cropping, resolution), and guides the user with real-time instructions such as moving closer or avoiding glare. Once the document meets all checks, capture happens automatically.
3. **OCR and document verification**\
   Captured images are sent to VIDA’s backend, where the document is classified (e.g., KTP, Driving License, Passport, MyKAD, MyPR, MyKAS, MyTentera) and OCR is run to extract structured fields. Additional checks validate authenticity and image quality before results are returned.
4. **Selfie, passive liveness, and face match**\
   For flows that require biometric verification, the SDK captures a selfie, runs liveness using VIDA’s liveness engine, and compares the selfie to the portrait extracted from the document.
5. **Unified response back to your app**\
   When the flow finishes, the SDK returns a single structured response (`VidaKycResponse` / `VIDAKYCResponse`) via the success callback. This response includes document verification, OCR results, liveness status, and face match results.

## KYC Mobile SDK Configurations

You can configure VIDA Mobile SDK solution for the following:

#### Supported platforms

* **Native Android** – distributed via VIDA’s Maven repository (`id.vida:kyc-sandbox` / `id.vida:kyc`), with `VidaKyc` as the main entry point.Kyc&#x20;
* **Native iOS** – distributed via CocoaPods (`vidaKYC` pod), with `VIDAKYC` as the main entry point.

#### Flow Configurations

You choose the verification flow and geography when building your KYC configuration:

1. **Flow type** – `DOCUMENT CAPTURE` (OCR and Document Verification) or `FULL KYC` (OCR and Document Verification + Liveness + Face Match).
2. **Region** – Indonesia or Malaysia, which determines available document types and back-end checks.
3. **Document types** – KTP, Driving License, Passport, MyKAD, MyKAS, MyPR, MyTentera, and others supported by VIDA.
4. **Liveness configuration** – optional `VIDALivenessConfig` / VIDA Liveness configuration for flows that include passive liveness and other liveness methods (Color Flash, Active Liveness with Gesture, Zoom)
5. **UI configuration** – options for tutorials, document selection, branding, colors, and localization, so the flow feels native to your app.
6. **Error configuration** – number of retries, liveness retry limits, and how users can reach support (email or phone)
