Skip to main content
GET
/
consumers
/
{id}
Retrieve a Consumer
curl --request GET \
  --url https://commerce.driv.ly/api/consumers/{id}
{
  "data": {
    "id": "con_2k4jd93vsd82",
    "ssn": "123-45-6789",
    "email": "john.doe@example.com",
    "lastName": "Doe",
    "birthDate": "1984-09-20",
    "firstName": "John",
    "phoneNumber": "555-0199"
  },
  "success": true
}

Path Parameters

​
id
string
required

Customer is uniquely identified by id

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

Response

Consumer Found

​
data
object
Examples:
{
  "id": "con_2k4jd93vsd82",
  "ssn": "123-45-6789",
  "email": "john.doe@example.com",
  "lastName": "Doe",
  "birthDate": "1984-09-20",
  "firstName": "John",
  "phoneNumber": "555-0199"
}
​
success
boolean
⌘I