Create customer

POST

/public/v3/customers

Creates new customer based on your user reference. You will use Customer ID across all endpoints.

Parameters

none

Query parameters

none

Request Body Parameters

ParameterData typeRequired?Description
user_referencestringyesThis must be a unique string from your system to identify the customer (for example a primary key for the customer in your database)

Response Body Parameters

ParameterData typeRequired?Description
idstringyesCustomer ID. You will use this ID across all endpoints
user_referencestringyesUser reference provided in request body

Request example

1 2 3 4 5 6 curl --location --request POST 'https://api.friendlyscore.com/public/v3/customers' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {access_token}' \ --data-raw '{ "user_reference": "{USER_REFERENCE}" }'

Response example:

1 2 3 4 { "id": "1234", "user_reference": "{USER_REFERENCE}" }

Was this article helpful?

Friendly Score UK Ltd.

84 Brook Street

London W1K 5EH

Call us on +44 20 3709 6726

Company registered in England

Company number 09168668, ICO ZA111687

VAT registration number 206 9758 80

Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)