Retrieve Customer

GET 
/customers/:customer_id

Retrieves a customer based on the provided customer ID

Request

Path Parameters

customer_id uuidrequired

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Customer's ID

Responses

200

Customer retrieved

application/json

Schema

Schema

status string

Possible values: [success]

data

object

id uuid

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

merchant_id uuid

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

first_name string

Possible values: <= 255 characters

First name of the customer

last_name string

Possible values: <= 255 characters

Last name/s of the customer

email emailnullable

Possible values: <= 255 characters

Email Address

dob

object

Birthdate for an individual

day integerrequired

month integerrequired

year integerrequired

ssn SSN (string)nullable

Possible values: <= 10 characters

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

shipping

object

name stringrequired

Possible values: <= 255 characters

Name of the shipping contact person

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

required

Address of the shipping destination

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

status string

Possible values: [unverified, pending, verified, errored]

Customer's verification status

created_on Unix timestamp

Unix timestamp representing the date

code integer

Possible values: [200]

message string

Possible values: [Successful request]

Example (from schema)

{
  "status": "success",
  "data": {
    "id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "merchant_id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "first_name": "Peter",
    "last_name": "Griffin",
    "email": "peter@pathly.io",
    "dob": {
      "day": 9,
      "month": 11,
      "year": 1989
    },
    "ssn": "123-456789",
    "phone_number": "1234567890",
    "address": {
      "country": "US",
      "line1": "Passatge sant pere",
      "line2": "Apartment 2",
      "zip": "8397.0",
      "city": "Pineda de mar",
      "state": "Barcelona"
    },
    "shipping": {
      "name": "Louis Griffin",
      "phone_number": "1234567890",
      "address": {
        "country": "US",
        "line1": "Passatge sant pere",
        "line2": "Apartment 2",
        "zip": "8397.0",
        "city": "Pineda de mar",
        "state": "Barcelona"
      }
    },
    "status": "unverified",
    "created_on": 1656656767
  },
  "code": 200,
  "message": "Successful request"
}

401

Access token is missing or invalid

403

Access denied

404

Customer not found

application/json

Schema

Schema

status string

Possible values: [not found]

code integer

Possible values: [404]

message string

Failure reason

Example (from schema)

{
  "status": "not found",
  "code": 404,
  "message": "Entity not found"
}

500

Server error

Loading...