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

Field

Description

Data Type

Length

name

Name of the Customer

String

100

mobile_no

Mobile Number of the Customer

Numeric

10

pin_code

Pincode of the Customer

Numeric

6

email

Email of the Customer
(Optional Parameter)

String

100


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.

email

Email ID 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 400

1

Missing 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.

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