Identities

Link customer profiles between Ventrata and external systems

Allow external applications to link and associate customer profiles to Ventrata customers. Most commonly used to power external account management and guest authentication.

To use this capability add octo/identifies to your Octo-Capabilities header.

Create, or update a new identities

POST /identities

PATCH /identities/:id

Creates or updates a new/existing identity

Request Body

Name	Type	Description
key	string	Key of the identity in the external system
data	object	A key/value store for any data you want to store against this identity

Response

200

{
  "id": "78674540-02e8-4476-88fb-fa3cfe50c028",
  "key": "2ba041a1992bfc80bab829a6",
  "data": {
    "myKey": "myValue"
  }
}

Create a new order, booking or gift

POST /orders

POST /bookings

POST /gifts

While creating an order, booking or gift you can include either the identityId or identityKey in the request to have that booking associated to the given identity created in the first step.

Body

Name	Type	Description
identityId	string	The id value of the identity
identityKey	string	The key value of the identity

Note you only need to include the identityId or the identityKey but not both.

Response

200

{
  //... rest of the order/booking/gift object
  "identity": {
    "id": "78674540-02e8-4476-88fb-fa3cfe50c028",
    "key": "2ba041a1992bfc80bab829a6",
    "data": {
      "myKey": "myValue"
    }
  }
}

Checkin lookup using identities

POST /checkin/lookup

Using the checkin capability to lookup bookings which is typically done using a reference, email or phone number, instead this allows you to lookup bookings using an identity instead.

Body

Name	Type	Description
checkin[identityId]	string	The id value of the identity
checkin[identityKey]	string	The key value of the identity

As with the requests above only identityId or identityKey are required, not both.

Response

200

{
  "message": null,
  "verified": true,
  "bookings": [
    //... all the bookings associated with this identity
  ]
}