Skip to main content
GET
/
customers
/
{id}
Retrieve a customer
curl --request GET \
  --url https://api.engine.usesophic.com/customers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "reference": "<string>",
  "full_name": "<string>",
  "onboarding": "<string>",
  "mifid_category": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "line3": "<string>",
    "district_county": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "country_code": "<string>"
  },
  "phone_number": "<string>",
  "risk_profile": "<string>",
  "risk_score": "<string>",
  "referrer_code": "<string>",
  "customer_type": "<unknown>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-11-07T05:31:56Z",
  "nationalities": [
    "<string>"
  ],
  "passport_number": "<string>",
  "id_number": "<string>",
  "tax_number": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The ID of the customer.

Response

OK

​
id
string
required

Unique resource identifier.

​
reference
string | null
required

A friendlier, shorter, customer-visible ID.

​
status
enum<string>
required

The status of the customer (active, suspended, closing, closed).

Available options:
active,
suspended,
closing,
closed
​
full_name
string
required

The full name of the customer.

​
onboarding
string | null
required

The onboarding ID of the customer.

​
mifid_category
string | null
required

The MIFID category of the customer (retail, professional, etc.).

​
address
Address · object | null
required
​
phone_number
string | null
required
​
risk_profile
string | null
required
​
risk_score
string | null
required
​
referrer_code
string | null
required
​
customer_type
any
required

The type of customer.

​
first_name
string
required

The first name of the customer.

​
last_name
string
required

The last name of the customer.

​
date_of_birth
string<date-time> | null
required
​
nationalities
string[] | null
required
​
passport_number
string | null
required
​
id_number
string | null
required
​
tax_number
string | null
required
​
created_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was created.

​
modified_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was last modified.