KYC API

🪪 Ditto ID IDV V3 KYC API Overview

šŸ“˜ What is Ditto ID IDV?

Ditto ID Identity Verification (IDV) is an add-on module for the Ditto ID Digital Trust Platform that enables secure, document-based and biometric identity verification. It is primarily used during:

  • User onboarding – to verify the identity of a new user using their government-issued ID and selfie.
  • Post-login KYC – to trigger re-verification flows based on business rules.

šŸ”— Why This API?

This API allows enterprise backend systems to receive and process identity verification data collected by the Ditto ID mobile SDK. You can use this data for:

  • Regulatory KYC compliance
  • Backend customer validation
  • Record-keeping and audit trails
  • Real-time or deferred decision making on user access

The API is initiated by the Ditto ID system, and your backend must implement it to accept KYC submissions over a secure HTTPS endpoint.


āš™ļø What It Sends

When triggered, the Ditto ID server sends a POST request containing:

  • User Identity Info: Basic info such as user ID and mobile app ID
  • Document Data: Extracted fields from scanned ID documents
  • Liveness Check: Selfie image and liveness detection score
  • Face Match Result: Match score between ID photo and selfie

The payload includes detailed document status, images, source-level field comparisons, and validation results.


šŸ” What You Need To Do

As an enterprise developer, you are expected to:

  1. Implement a secure HTTPS endpoint (e.g., https://yourdomain.com/kyc)
  2. Accept KYC JSON payloads as defined in the spec
  3. Optionally validate or store the data as per your internal process
  4. Respond with a confirmation JSON indicating success or failure

āœ… Typical Use Cases

  • Real-time verification before allowing login or transaction
  • Flagging mismatched or expired documents
  • Manual verification for regulatory workflows
  • Synchronizing Ditto ID identity data with internal customer records

šŸ”’ Security and Customization

The KYC API supports:

  • AES-based request/response encryption
  • OAuth2-based Bearer token authentication
  • Custom field mappings using payload macros
šŸ”§

You can configure these via the Ditto ID Gateway Management Console.


šŸ“Ž Next Steps