Skip to content
Go

Customers

Taxi & Private Hire › Products › Customer › Customers

Generally available

The Customer entity is the passenger record — first/last name, phone (normalised E.164), email, default account, default brand, password hash for self-service login, priority tier, loyalty miles, tags. One row per known passenger; new bookings either match an existing customer by phone or create a new one. Customers can self-book via the app, be booked by operators, or be linked to corporate accounts for billing.

Example request

POST /client/{clientId}/brand/{brandId}/customer

See the API reference for the full request and response schema.

Endpoints

MethodPath
GET /client/{clientId}/account/{accountId}/customer/{customerId}
GET /client/{clientId}/brand/{brandId}/customer/{customerId}/addresses
POST /client/{clientId}/brand/{brandId}/customer · primary
GET /client/{clientId}/brand/{brandId}/customer/{customerId}
POST /client/{clientId}/brand/{brandId}/customer/{customerId}
POST /client/{clientId}/customer/{customerId}/account/{accountId}
POST /client/{clientId}/customer/{customerId}/accountdepartment/{accountDepartmentId}
POST /client/{clientId}/customer/{customerId}/brand/{brandId}
POST /client/{clientId}/customer/{customerId}/clientcapability/{capabilityId}
POST /client/{clientId}/customer/{customerId}/tag/{tagName}
GET /client/{clientId}/customer/{customerId}/addresses
POST /client/{clientId}/customer
DELETE /client/{clientId}/customer/{customerId}/account/{accountId}
DELETE /client/{clientId}/customer/{customerId}/accountdepartment/{accountDepartmentId}
DELETE /client/{clientId}/customer/{customerId}/clientcapability/{capabilityId}
GET /client/{clientId}/customer/{customerId}
GET /client/{clientId}/customer/{customerId}/tag
GET /client/{clientId}/customer/phone
DELETE /client/{clientId}/customer/{customerId}/tag/{tagName}
POST /client/{clientId}/customer/{customerId}

Full request/response schemas and an interactive explorer will live in the API reference (coming soon).

Use cases

Operator flows that exercise this feature.

Link a customer to an account

config risk: low

Attach a customer to a corporate account so they can book on it.

  1. POST /client/{clientId}/customer/{customerId}/account/{accountId}
Link a customer to a department

config risk: low

Attach a customer to an account department (cost-centre).

  1. POST /client/{clientId}/customer/{customerId}/accountdepartment/{accountDepartmentId}
Set a customer default requirement

config risk: low

Attach a default service requirement (e.g. WAV) to a customer so it pre-fills on their bookings.

  1. POST /client/{clientId}/customer/{customerId}/clientcapability/{capabilityId}
Mark a customer VIP

config risk: low

Tag a customer as VIP to influence priority.

  1. POST /client/{clientId}/customer/{customerId}/tag/{tagName}
Create a customer

config risk: low

Register a new passenger / customer.

  1. POST /client/{clientId}/customer
Update a customer

config risk: low

Modify a customer profile (contact, name, priority).

  1. POST /client/{clientId}/customer/{customerId}