Skip to content

Create a new customer

Request

Creates a customer with basic information such as name, contact information, and address. To check complete list of API validations, click here.

Some fields are required only for a particular flow. Account funding additionally requires dob and nationality, and reads kyc.last_kyc_date; LRS requires phone and kyc.pan_number for a customer in India. Creating a customer is not idempotent - a second create with an email already on your account returns 400 Email has already been taken and does not return the existing record. Store the id against your own user, or recover it with GET /v1/customer?email_address=.

Security
JWT
Bodyapplication/jsonrequired
namestring

The name of the customer. Reserved sandbox test values: jexru7, nerqu8, havku9, dexru6 and renvak4 (any letter case) force a sanctions-screening hit whenever this customer is screened.

Example:"John Doe"
customer_typestring

The type of customer

Enum:"individual""business"
emailstring, (email)

The email address of the customer.

Example:"customer@gmail.com"
phonestring

The phone number of the customer, with country code. Phone number validation is done using the phonelib library.

Example:"+91-9023456789"
dobstring, (date)

The date of birth of the customer, as a calendar date in YYYY-MM-DD format with no time or time zone. Must be a date before today.

Optional in general, required for account funding customers.

Example:"2003-11-29"
nationalitystring, (iso-3166-1-alpha-3)

The nationality of the customer, as an ISO 3166-1 alpha-3 code. The alpha-2 form is rejected: send IND, not IN.

Optional in general, required for account funding customers.

Example:"IND"
kycobjectwrite-only

The KYC records you already hold for this customer. Accepts exactly the two fields below.

addressstring

The street address of the customer.

Example:"123 Main St"
citystring

The city where the customer is located.

Example:"Anytown"
statestring

The state where the customer is located.

Example:"Anystate"
countrystring, (iso-3166-1-alpha-3)

The country where the customer is located. Country should be sent as a ISO 3166-1 alpha-3 code.

Example:"IND"
pincodestring

The postal code/pincode of the customer's address. List of countries where pincode is mandatory are listed here.

Example:"560048"
curl -i -X POST \
  https://api.glomopay.com/api/v1/customer \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "John Doe",
    "customer_type": "individual",
    "email": "customer@gmail.com",
    "phone": "+91-9023456789",
    "dob": "2003-11-29",
    "nationality": "IND",
    "kyc": {
      "pan_number": "BFQPG7654R",
      "last_kyc_date": "2026-02-14"
    },
    "address": "123 Main St",
    "city": "Anytown",
    "state": "Anystate",
    "country": "IND",
    "pincode": "560048"
  }'

Responses

Customer created successfully

Bodyapplication/json
idstringread-only

The unique identifier for the customer.

Example:"cust_5JU9yv0lGSUP"
namestring

The name of the customer. Reserved sandbox test values: jexru7, nerqu8, havku9, dexru6 and renvak4 (any letter case) force a sanctions-screening hit whenever this customer is screened.

Example:"John Doe"
customer_typestring

The type of customer

Enum:"individual""business"
emailstring, (email)

The email address of the customer.

Example:"customer@gmail.com"
phonestring

The phone number of the customer, with country code. Phone number validation is done using the phonelib library.

Example:"+91-9023456789"
dobstring, (date)

The date of birth of the customer, as a calendar date in YYYY-MM-DD format with no time or time zone. Must be a date before today.

Optional in general, required for account funding customers.

Example:"2003-11-29"
nationalitystring, (iso-3166-1-alpha-3)

The nationality of the customer, as an ISO 3166-1 alpha-3 code. The alpha-2 form is rejected: send IND, not IN.

Optional in general, required for account funding customers.

Example:"IND"
tax_identification_numberstringread-only

The customer's PAN (tax identification number), derived from the kyc.pan_number you send at creation. null where you sent none, and also where PAN processing is not enabled for your account; the value you sent is stored either way. Searchable via the tax_identification_number query parameter on the list-customers endpoint.

Example:"BFQPG7654R"
addressstring

The street address of the customer.

Example:"123 Main St"
citystring

The city where the customer is located.

Example:"Anytown"
statestring

The state where the customer is located.

Example:"Anystate"
countrystring, (iso-3166-1-alpha-3)

The country where the customer is located. Country should be sent as a ISO 3166-1 alpha-3 code.

Example:"IND"
pincodestring

The postal code/pincode of the customer's address. List of countries where pincode is mandatory are listed here.

Example:"560048"
statusstringread-only

The status of the customer.

Example:"active"
created_atstring, (date-time)read-only

When the customer was created, as an ISO 8601 date-time in UTC.

Example:"2021-06-01T12:00:00Z"
updated_atstring, (date-time)read-only

When the customer was last updated, as an ISO 8601 date-time in UTC.

Example:"2021-06-01T12:00:00Z"
Response
{ "id": "cust_5JU9yv0lGSUP", "name": "John Doe", "customer_type": "individual", "email": "customer@gmail.com", "phone": "+91-9023456789", "dob": "2003-11-29", "nationality": "IND", "tax_identification_number": "BFQPG7654R", "address": "123 Main St", "city": "Anytown", "state": "Anystate", "country": "IND", "pincode": "560048", "status": "active", "created_at": "2021-06-01T12:00:00Z", "updated_at": "2021-06-01T12:00:00Z" }