This endpoint will let the Distributor register the users with SafeGold. The user details will be sent in the payload.

The Registration API is idempotent. If the Registration API is called by passing the same mobile_no, ​ the API will return the details of the same user again.

Request Parameters

FieldDescriptionData TypeLength
nameName of the CustomerString100
mobile_noMobile Number of the CustomerNumeric10
pin_codePincode of the CustomerNumeric6
emailEmail of the Customer
(Optional Parameter)

Ignore delivery_address in request example

Success 200 Response Parameters

idThe User ID of the Customer provided during Registration.
nameName of the Customer.
mobile_noMobile Number of the Customer.
pincodePincode of the Customer.
emailEmail ID of the Customer.
gold_balanceGold Balance of the Customer in Grams.
kyc_requirement.identity_requiredFlag to Update the Flag of the KYC Identity requirement.
kyc_requirement.pan_requiredFlag to Update the Flag of PAN requirement.

Failure Parameters

Status CodeCodeCode Description
HTTP Status 400
1Missing required information


Points to remember

SafeGold uses its customer's phone numbers to uniquely identify them, so every time a phone number is entered which is not registered on SafeGold's system, this API will create a new user with the information provided else it will display the data of an existing user associated with the phone number.

Click Try It! to start a request and see the response here!