Create a guest (legacy)

Important

A newer version of this REST API (v2.1) is available. If you're new to the Guest REST API, use the new version. Alternatively, if you're already using the old version, read about the differences between v2 and v2.1 so you can upgrade.

POST /v2/guests

Creates a guest.

Warning

The REST API does not validate whether a guest already exists when you create a guest. To avoid creating duplicate guests, first retrieve guests using their email address or other identifying information.

At a minimum, you must provide the following required attributes in the request body:

Attribute	Type	Description	Example
`guestType`	string enum	The level of identity obtained.	Must be one of the following: `"visitor"` `"customer"` `"traveller"`

In the response, the ref key contains the guest reference.

Create a guest using Personally Identifiable Information (PII):

RequestResponse

curl -X POST '<baseURL>/v2/guests' \
-u '<username>:<password>' \
-H 'Accept: application/json' \
--data-raw '
 {
    "guestType": "customer",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "female",
    "dateOfBirth": "1976-10-28T00:00:00.000Z",
    "emails": [
        "[email protected]"
    ],
    "phoneNumbers": [
        "0851234567"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "passportExpiry": "2033-01-01T00:00Z",
    "street": [
        "Apartment 15",
        "West Drive Avenue"
    ],
    "city": "Dublin",
    "country": "IE",
    "postCode": "D2",
    "state": "Dublin",
}'

201 Created response with Personally Identifiable Information (PII):

RequestResponse

{
   "href":"<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "ref":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "createdAt":"2024-03-07T16:15:11.000Z",
   "modifiedAt":"2024-08-23T16:17:16.000Z",
   "firstSeen":"2024-03-07T16:15:11.000Z",
   "lastSeen":"2024-08-23T16:17:16.000Z",
   "guestType":"customer",
   "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "female",
    "dateOfBirth": "1976-10-28T00:00:00.000Z",
    "emails": [
        "[email protected]"
    ],
    "phoneNumbers": [
        "0851234567"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "passportExpiry": "2033-01-01T00:00:00.000Z",
    "street": [
        "Apartment 15",
        "West Drive Avenue"
    ],
    "city": "Dublin",
    "country": "IE",
    "postCode": "D2",
    "state": "Dublin",
}

Create a guest using identifiers:

RequestResponse

curl -X POST '<baseURL>/v2/guests' \
-u '<username>:<password>' \
-H 'Accept: application/json' \
--data-raw '
 {
   "guestType":"customer",
   "identifiers":[
      {
         "provider":"BXLP",
         "id":"123456",
         "expiryDate":"2028-08-23T16:17:16.000Z"
      }
   ]
}'

201 Created response with identifiers:

RequestResponse

{   
   "href":"<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "ref":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "createdAt":"2024-03-07T16:15:11.000Z",
   "modifiedAt":"2024-08-23T16:17:16.000Z",
   "firstSeen":"2024-03-07T16:15:11.000Z",
   "lastSeen":"2024-08-23T16:17:16.000Z",
   "guestType":"customer",
   "identifiers":[
      {
         "provider":"BXLP",
         "id":"123456",
         "expiryDate":"2028-08-23T16:17:16.000Z"
      }
   ]
}

Do you have some feedback for us?

If you have suggestions for improving this article,