Skip to main content

​
Data Flow Diagram

Integration Architecture The diagram is a sequence diagram that shows the full KYC verification lifecycle across three environments:
  • Public Environment — the customer, mobile app, and UAE KYC SDK
  • Client Controlled Environment — your edge server, middleware, whitelisted proxy, and database
  • UAE KYC Environment — the UAE KYC server
The flow is divided into four steps:

​
Step 1: Initiate Onboarding

The customer starts the onboarding process from the Mobile App. The app makes an API call to your Client Middleware, which sends a Create Journey request to the UAE KYC Server through the Client Whitelisted Proxy: 
Client Middleware → Whitelisted Proxy → ICP Server
The UAE KYC Server returns a Journey Token (UUID), which is passed back through the proxy to the middleware and then to the mobile app.

​
Step 2: SDK Invocation

The Mobile App initializes the UAE KYC SDK with the received Journey Token. The SDK performs a handshake with the UAE KYC Server by calling the /uik-service/journey/handshake endpoint, routed through your Client Edge Server and Whitelisted Proxy: 
UAE KYC SDK → Client Edge Server → Whitelisted Proxy → ICP Server
The UAE KYC Server responds with a Handshake Confirmation, establishing a secure session for the verification process. In many bank deployments, the Client Edge Server is fronted by an internal FQDN such as stg-icp-dash.<bank>.ae, which is only accessible from office/VPN networks and forwards traffic over the approved secure channel to the UAE KYC FQDNs.

​
Step 3: Customer Interaction

The customer proceeds through the verification steps guided by the SDK. Each interaction follows the same routing path through the edge server and proxy to the UAE KYC Server via the /uik-service/update-journey endpoint:
  1. Select Document Type — the customer chooses their identity document, and the server acknowledges
  2. Capture Document — the customer scans their document, and the server responds with a verification page
  3. Capture Selfie — the customer takes a selfie for biometric matching, and the server responds with a journey completion acknowledgement
After all steps are complete, the SDK triggers a completion callback to the mobile app.

​
Step 4: Post Journey Completion

The Mobile App notifies the Client Middleware that the journey is complete. The middleware then retrieves the verification results from the UAE KYC Server through the proxy:
  1. Journey Details — calls the Journey Details API (/v2/journey-details/{journeyToken}) to get journey logs and status
  2. Customer Details — calls the Customer Details API (/customer-details/{journeyToken}) to get the verified user information
Finally, the middleware stores the customer KYC record (journey details and customer details as JWT) in the Client Database.