User Registrations

This API is used to identify if the user is registered or not.

POST {API_URL}/client/register-user

Auth required: YES

Please pass your API key as the username and API secret as the password as Basic Auth to access the endpoint

Query Parameters

Name
DataType
Description
Type

phone

String

phone number of the user

Optional

countryCode

String

contryCode of phone No.

Optional

email

String

email of the user

Optional

firstName

string

first name of the user

Mandatory

lastName

string

last name of the user

Optional

dateOfBirth

string

dob of the user

Optional

gender

string

User's gender (Allowed values: MALE, FEMALE, OTHERS)

Optional

enableOffers

boolean

Flag to enable promotional offers

Optional

enableNotifications

boolean

Flag to enable notifications

Optional

You need to pass either below paarmeters of the user from which the user,

{
    "firstName": "Shivam Dubey",
    "email": "[email protected]",
    "phone": "9807876896",
    "isEmailVerified": true,
    "isPhoneVerified": true,
    "countryCode": "+91",
    "gender": "MALE",
    "dateOfBirth": "2025-05-13T16:13:02.128Z",
    "shippingAddress": [
        {
            "apartment": "20/41 Rambagh",
            "city": "Agra",
            "state": "UP",
            "pincode": "282006",
            "country": "INDIA"
        },
        {
            "apartment": "20/41 Rambagh",
            "city": "Agra",
            "state": "UP",
            "pincode": "282007",
            "country": "INDIA"
        }
    ],
    "billingAddress": [
        {
            "apartment": "20/41 Rambagh",
            "city": "Agra",
            "state": "UP",
            "pincode": "8",
            "country": "INDIA"
        },
        {
            "apartment": "20/41 Rambagh",
            "city": "Agra",
            "state": "UP",
            "pincode": "282009",
            "country": "INDIA"
        }
    ]
}
{
    "message": "Account created successfully",
    "userId": "66ced0ebf72e8b7beddfe1e1"
}

Last updated