Get User KYC
GET{baseUrl}/us/api/v1/kyc/{userId}
Path Parameter
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | Integer | Yes | The user whose KYC information is being retrieved (SaaS user or their customer). |
Response
| Field | Type | Description |
|---|---|---|
| userId | Integer | Target user ID. |
| userType | Enum | USER | ADMIN | MERCHANT | … |
| String | Registered email. | |
| phone | String | Phone (excluding country code). |
| countryCode | String | Phone country code (e.g., 92). |
| personalInfo | Object | Personal info as per Create/Update Personal Info result model. |
| identificationInfo | Object | Identification info as per Create/Update Identification result model. |
| businessInfo | Object | (If applicable) Business info + business address. |
| status | Enum | Final KYC status (PENDING, VERIFIED, REJECTED) — updated by Admin. |
200 — SUCCESS
{
"data": {
"userId": 602,
"userType": "AGENT",
"email": "mbme@vp.com.pk",
"phone": "3319264232",
"countryCode": "92",
"status": "PENDING",
"personalInfo": { "...": "See Create Personal Info response" },
"businessInfo": { "...": "Company and address details" },
"identificationInfo": { "...": "Full file metadata, numbers, expiries" }
}
}