Get KYC status
Get the identity verification status of a client for every carrier it can verify on. Use next_step to know which step to call next, so you drive the whole flow off one poll instead of hardcoding the sequence.
Reseller accounts only. Request access.
user_idintegerrequiredID of the child user to check.
curl -X GET 'https://backend.omnidim.io/api/v1/reseller/kyc/status?user_id=1234' \ -H 'Authorization: Bearer YOUR_API_KEY'
{ "success": true, "user_id": 1234, "regions": [ { "region": "IN", "carrier": "carrier-1", "carrier_label": "Carrier 1", "kyc_required": true, "can_purchase": false, "status": "pan_verified", "next_step": "aadhaar-otp", "review_status": null }, { "region": "IN", "carrier": "carrier-2-new", "carrier_label": "Carrier 2 (new)", "kyc_required": true, "can_purchase": false, "status": "not_started", "next_step": "register", "review_status": null } ] }
Authorization
BearerAuth Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
In: header
Query Parameters
ID of the child user to check.
Response body
application/jsonResponse Body
application/json
application/json
application/json
application/json
next_step is the field to drive your integration from: read it once here to
get the first step, then chain from each step's response until the status is
completed.
There is one entry per carrier, not per region. Verification is per carrier, so
a client verified on one carrier of a region still has to verify on the other
before it can buy there. Match on carrier, and pass that same name to the
steps and to the purchase.
can_purchase is the exact gate a purchase enforces, so this answer and a
purchase attempt can never disagree. When it is false while next_step is
null, the client has finished every step and the carrier is still reviewing:
review_status says pending_review.
The full loop, with the step tables, is in the Reseller API guide.
Credit transfer logs
Paginated history of all credit transfers and reverts for the reseller account. Returns reverse-chronological order by default. Date filters are inclusive.
Get KYC requirements for a region
Get the ordered list of verification steps for a carrier and the fields each step needs, so your integration can build a verification form without hardcoding the sequence.
