Validate access code - Way Docs

POST

/

v1

/

brands

/

{brandId}

/

access-codes

/

{accessCode}

/

validate

Validate access code

curl --request POST \
  --url https://api.letsway.com/v1/brands/{brandId}/access-codes/{accessCode}/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.letsway.com/v1/brands/{brandId}/access-codes/{accessCode}/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.letsway.com/v1/brands/{brandId}/access-codes/{accessCode}/validate"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "access-code-123e4567-e89b-12d3-a456-426614174000",
  "name": "Awesome Access Code",
  "code": "12345"
}

Authorizations

Authorization

string

header

required

Your brand's secret API key, e.g. Bearer way_sk_live_bhEqcn0i1fRoUEHBPjJkQA. Older Way-Brand-Id + Way-Secret-Key credentials still work: see Legacy authentication.

Path Parameters

brandId

string

required

The brand's ID - must match the brand your API key identifies (or the Way-Brand-Id header when one is sent).

accessCode

string

required

The access code to validate, as entered by the guest.

Body

application/json

The body is of type object.

Response

201 - application/json

Validate access code.

id

string

required

Unique identifier for the access code.

Example:

"access-code-123e4567-e89b-12d3-a456-426614174000"

name

string

required

Name of the access code.

Example:

"Awesome Access Code"

code

string

required

Code of the access code.

Example:

"12345"

⌘I

Validate access code

curl --request POST \
  --url https://api.letsway.com/v1/brands/{brandId}/access-codes/{accessCode}/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.letsway.com/v1/brands/{brandId}/access-codes/{accessCode}/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.letsway.com/v1/brands/{brandId}/access-codes/{accessCode}/validate"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "access-code-123e4567-e89b-12d3-a456-426614174000",
  "name": "Awesome Access Code",
  "code": "12345"
}