Description
Validate Customer ID and generate OTP. This is the first step in the authentication flow where the customer submits their Customer Unique ID.
Client API: This endpoint is hosted by the Client System. Bigcity Microsite calls this API when a customer enters their Customer ID.
Headers
Authorization
required
Basic Authentication header. Format: Basic <base64(username:password)>
Content-Type
application/json
Parameters
customer_id
required, type: string
The unique Customer ID assigned to the customer.
Example Request
{
"customer_id": "CUST12345"
}
Example Response
{
"status": true,
"message": "OTP generated successfully",
"reference_id": "REF123456"
}
Example of Error Response
{
"status": false,
"message": "Invalid Customer ID"
}
Response Fields
status
type: boolean
Indicates whether the OTP was generated successfully.
message
type: string
Human-readable message describing the result.
reference_id
type: string
Reference ID to be used in the OTP verification step (only on success).