Customer

1.0

Offers a unified interface for managing and retrieving customer information.

overview

api reference

Overview

Our Customer API is responsible for the management and maintenance of any natural or legal person managed on the platform. This includes details of the person and their relationship to any product held on the platform.

The API enables you to create and manage customer profiles and search for customers based on their unique customerId or personal identifier. You can also use our API to verify a provided phone number and email address exists.

Customer Management

Retrieve Personal Identifying Information (PII) data about a customer using their customerId. If you do not have their customerId, you can search for the customer using one or more of the supported query filters.

Parameter	Definition
`customerId`	Unique customer identifier.
`givenName`	The given name (also known as the first name) associated with the customer profile.
`familyName`	The family name (also known as the last name) associated with the customer profile.
`postCode`	Postcode of the address associated with the customer profile.
`phoneNumber`	The phone number associated with the customer profile. (Phone number can be the home, work, fax, or mobile number).
`dateOfBirth`	The birthday and time associated with the customer profile, in  ISO 8601 format (i.e. "2000-07-19T09:14:44.568Z")

Customer Verification

Verify the customer’s email address and/or phone number exists through the Customer API. The API will verify that the email address and phone number exist but not confirm the possession. Confirm possession by sending a One-time Passcode (OTP).

We currently verify the mobile numbers registered to a network in the United Kingdom only. The endpoint assumes the country is the United Kingdom unless you prefix the mobile phone number with its international dialling code (e.g., +44 or 0044).

How does customer verification work?

The email address and phone number are validated similarly. Below is what a successful validation flow looks like.

1
You initiate the call and provide the emailAddress or phoneNumber, depending on your chosen verification endpoint.
2
The endpoint returns true or false to confirm the provided email address or phone number is verified.

Verification statuses

Both endpoints will return true or false depending on whether the email address or phone number is verified.

Status	Validation Type	Description
`true`	Phone	The phone number is valid and the number is verified.
`false`	Phone	The phone number is not valid because of a non-UK number format or the format is valid but not verified with network lookup or a valid number but it is not active on a network.
`true`	Email	The mailbox exists and is reachable. Or we were unable to conclusively verify or invalidate the email address.
`false`	Email	The mailbox is disabled, does not exist, is full or the syntax of the specified email address is incorrect. The email address could belong to a disposable email provider, seed, spam trap, black hole, technical role account or inactive domain.

Still have questions?

Can’t find the answer to your question? Our friendly team are more than happy to help

Was this page helpful?