API SuiteBusiness Verification (GST, Udyam, Udyog)
Udyam Details
Fetch Udyam (MSME) registration details. Server-side POST with Bearer auth; Udyam number in the path.
API reference
Try itLoading playground…
Loading…
AuthorizationBearer <token>
JWT Bearer token authentication. Obtain a token from the KwikID dashboard.
In: header
Path Parameters
udyam_idunknown
The Udyam number for which data has to be fetched.
Default
""Format
stringResponse Body
curl -X POST "https://__mock__/verification/v2/udyam/get//"{
"message": "string"
}{
"detail": {
"<location>": {
"<field_name>": [
"string"
]
}
},
"message": "string"
}{
"detail": {},
"message": "string"
}Overview
Call POST /verification/v2/udyam/get/{udyam_id}/ from your backend with Authorization: Bearer <token>. Replace {udyam_id} with the Udyam registration number the user or counterparty provided. Request body is typically empty unless your OpenAPI tenant adds fields.
Key features
- MSME verification: Validates the Udyam id exists and returns business context.
- Pairs with legacy Udyog: Compare with Upyog Details when you still see older Udyog numbers.
Implementation
Step 1: Call from your backend
POST /verification/v2/udyam/get/UDYAM-XX-00-0000000/ HTTP/1.1
Host: <verification-api-base-url>
Authorization: Bearer <token>
Content-Type: application/json
{}Error handling
| HTTP status | When |
|---|---|
| 400 | Validation error. |
| 401 | Invalid token. |
Benefits
- Supports MSME lending and supplier onboarding with a single Udyam id.