Introduction

This document is a comprehensive VKYC API Integration Guide for clients integrating with the PixDynamics VKYC platform. It covers the request/response formats of every endpoint and the event-driven flow behind a complete video-based KYC (VKYC) journey.

The PixDynamics VKYC solution is built on RESTful APIs and communicates exclusively in JSON over secure HTTPS channels. This guide documents the endpoints required for a full integration: authentication, customer session creation, webhook notifications and status checks.

Target audience and prerequisites

This guide is intended for technical teams, developers and solution architects at partner institutions — banks, NBFCs and FinTech companies — that want to integrate the PixDynamics VKYC solution into their digital onboarding platforms.

To implement the integration you should have a working knowledge of:

REST APIs

Resource-oriented endpoints, HTTP verbs and status codes.

JSON

Reading and building nested JSON request and response bodies.

HTTP / HTTPS

Headers, TLS and server-to-server calls.

API security

Token-based authentication and safe credential handling.

API protocol and security

• All APIs are stateless and exposed over HTTPS for secure, encrypted communication.
• Payloads follow the JSON format for seamless parsing and standardisation.
• Communication integrity is protected against tampering and man-in-the-middle attacks by HTTPS.
• All APIs in this document are encrypted using AES-256, ensuring end-to-end data protection.

APIs covered in this guide

API	Method	Endpoint	Purpose
Auth Token	POST	/api/v1/vkyc/auth/token/	Generate the access token used by the other APIs.
Customer Session Creation	POST	/api/v1/vkyc/create/customer/	Register the customer and generate the VKYC URL.
Webhook	POST	Your endpoint	Receive VKYC session status updates as they happen.
Status Check	GET	/api/v1/vkyc/vcip-status/external/{unique_id}/	Fetch the current VKYC session status for a customer.

Integration flow

1. Call the Auth Token API with your merchant credentials to obtain an access token.
2. Call the Customer Session Creation API with the customer's details. The response returns a unique_id and a customer_redirect_url.
3. Redirect the customer to customer_redirect_url to begin the video KYC journey.
4. Receive webhook notifications on your endpoint as the session progresses (requested, queued, on call, verified, checked, audited, CBS events).
5. Optionally poll the Status Check API with the unique_id at any point to read the current status.

:::note Base URL The base URL is issued per merchant during onboarding — for example https://sandbox. All paths in this guide are relative to it. :::