Add a new customer

post

https://api.ophelos.dev/customers

This endpoint allows you to create a new customer in Ophelos. Before creating a new customer, the system performs a lookup using the provided information to check for existing customers to avoid duplication.

If an existing customer is found with matching details, the request will return the existing customer details.

Lookup Details:

The lookup is performed using key customer information such as email, phone number, or other unique identifieres.
If a match is found, the system will return the existing customer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Customer information to create

Accept full name.

kind

string

enum

The kind of customer. This can be an individual or a business.

Allowed:

full_name

string

required

length between 0 and 256

^[a-zA-Z\s-]+$

The full name of the customer.

first_name

string

length between 1 and 128

^[a-zA-Z\s-]+$

The first name of the customer. Optional in this context as full name is required.

last_name

string

length between 0 and 128

^[a-zA-Z\s-]+$

The last name of the customer. Optional in this context as full name is required.

date_of_birth

date

Date of birth of the customer.

preferred_locale

string

enum

length between 5 and 5

Defaults to en-GB

The preferred locale of the customer.

Allowed:

contact_details

array of objects

The contact details of the customer. This can be an email address, phone number, mobile number, or fax number.

contact_details

metadata

object

A set of key-value pairs that you can attach to a customer object. It can be useful for storing additional information about the debt in a structured format.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Existing customer returned.

201Customer created successfully.

400Bad Request - The request could not be understood or was missing required parameters.

401Unauthorized - Authentication is needed to get the requested response.

403Forbidden - The client did not have permission to access the requested resource.

404Not Found - The requested resource was not found.

429Rate Limit Exceeded - The rate limit has been exceeded.

500Internal Server Error - An unexpected error occurred on the server.