Get KYC requirements for a region
Get the ordered list of verification steps for a region and the fields each step needs, so your integration can build a verification form without hardcoding the sequence.
Reseller accounts only. Request access.
regionstring · enumrequiredRegion to get verification requirements for.
curl -X GET 'https://backend.omnidim.io/api/v1/reseller/kyc/requirements?region=IN' \ -H 'Authorization: Bearer YOUR_API_KEY'
{ "success": true, "region": "IN", "steps": [ { "step": "register", "required": [ "email", "name", "phone" ], "cooldown": false }, { "step": "verify-otp", "required": [ "email_otp", "mobile_otp" ], "cooldown": false }, { "step": "resend-otp", "required": [], "cooldown": false }, { "step": "verify-pan", "required": [ "business_type", "pan" ], "cooldown": false }, { "step": "aadhaar-otp", "required": [ "aadhaar" ], "cooldown": true }, { "step": "aadhaar-verify", "required": [ "otp" ], "cooldown": true }, { "step": "verify-gst", "required": [ "gst" ], "cooldown": false }, { "step": "skip-gst", "required": [], "cooldown": false }, { "step": "preview", "required": [], "cooldown": false }, { "step": "accept", "required": [], "cooldown": false } ] }
Authorization
BearerAuth Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
In: header
Query Parameters
Region to get verification requirements for.
"IN" | "US"Response Body
application/json
application/json
application/json
application/json
Step-by-step verification exists for regions that require it. India is the one today, and the check is an Aadhaar eKYC.
A region that returns an empty steps list has no step-based verification.
Check kyc_required on
KYC status to know whether
that region needs verification at all before a purchase.
The full loop is in the Reseller API guide.
Get KYC status
Get the identity verification status of a client for every region where verification is required. Use next_step to know which step to call next, so you drive the whole flow off one poll instead of hardcoding the sequence.
Submit a KYC verification step
Run one step of a client's identity verification. One endpoint handles every step: the step path parameter names the step, and the body carries user_id, region, and whatever that step needs. Pick a step from the examples below to see its body.
