get https://partners-staging.safegold.com/v1/users/
This endpoint will let the Distributor query the user’s gold balance through the mobile number.
| Method | GET |
|---|---|
| Staging URL | https://partners-staging.safegold.com/v1/users/{user_id} |
| Production URL | https://partners.safegold.com/v1/users/{user_id} |
URL Params
| Parameter | Value |
|---|---|
| user_id | [Numeric] Example: user_id = 12345 |
Success 200 Response Parameters
| Field | Description |
|---|---|
| ID | The User ID of the Customer provided during Registration |
| name | Name of the Customer |
| mobile_no | Mobile Number of the Customer |
| pincode | Pincode of the Customer |
| gold_balance | Gold Balance of the Customer in Grams |
| kyc_requirement.identity_required | Flag to Update the Flag of the KYC Identity requirement |
| kyc_requirement.pan_required | Flag to Update the Flag of PAN requirement |
Failure Parameters
| Status Code | Code | Code Description |
|---|---|---|
| HTTP Status 200 | ||
| 1 | User with that ID is missing |