KYC API

🪪 REL-ID IDV V3 KYC API Overview

📘 What is REL-ID IDV?

REL-ID Identity Verification (IDV) is an add-on module for the REL-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 REL-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 REL-ID system, and your backend must implement it to accept KYC submissions over a secure HTTPS endpoint.

⚙️ What It Sends

When triggered, the REL-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:

Implement a secure HTTPS endpoint (e.g., https://yourdomain.com/kyc)
Accept KYC JSON payloads as defined in the spec
Optionally validate or store the data as per your internal process
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 REL-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 REL-ID Gateway Management Console.

📎 Next Steps

Updated 3 months ago