POST

/v1/consumers

Bearer*
curl --request POST \
  --url https://api.oneslipstream.com/v1/consumers \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "firstname": "Eve",
  "lastname": "Moneypenny",
  "title": "miss",
  "dob": "1975-07-27",
  "addresses": [
    {
      "city": "London",
      "country": "GB",
      "line1": "New Bond Street",
      "postcode": "SE1 7TP"
    }
  ]
}'
{
  "id": "con_bPKKB3sYsukFanSsaBcMCMR2",
  "description": "A special secretary",
  "firstname": "Eve",
  "lastname": "Moneypenny",
  "metadata": {
    "job": "secretary"
  },
  "othername": "string",
  "title": "miss",
  "addresses": [
    {
      "buildingName": "null",
      "buildingNumber": "7",
      "city": "London",
      "country": "GB",
      "line1": "New Bond Street",
      "line2": "null",
      "postcode": "SE1 7TP",
      "state": "Greater London",
      "subBuildingName": "null",
      "subBuildingNumber": "null"
    }
  ],
  "dob": "1975-07-26T00:00:00.000Z",
  "createdAt": "2022-07-26T00:00:00.000Z"
}

Authorizations

Authorizationheaderrequired
string

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

Body

application/json
description
string

An arbitrary string attached to the object

firstnamerequired
string

The customer's firstname

lastnamerequired
string

The customer's lastname

metadata
object

Set of key-value pairs that you can attach to an object, useful for storing additional information about the object in a structured format

othername
string | null

The customer's middle names or initials

titlerequired
enum<string>

The customer's title

Available options:
mr,
mrs,
miss,
ms,
dr,
prof,
sir
dobrequired
string

The consumer's date of birth

addressesrequired
object[]

The customer's addresses

Response

200 - application/json
idrequired
string

The unique identifier for the consumer

description
string

An arbitrary string attached to the object

firstname
string

The customer's firstname

lastname
string

The customer's lastname

metadata
object

Set of key-value pairs that you can attach to an object, useful for storing additional information about the object in a structured format

othername
string | null

The customer's middle names or initials

title
enum<string>

The customer's title

Available options:
mr,
mrs,
miss,
ms,
dr,
prof,
sir
addresses
object[]

The customer's addresses

dob
string

The consumer's date of birth

createdAt
string

The date and time the consumer was created