Skip to main content
POST
/
v2
/
loyalties
/
examine
/
rewards
Examine rewards
curl --request POST \
  --url {protocol}://{host}/v2/loyalties/examine/rewards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "customer_identification": {
    "customer_id": "<string>",
    "customer_source_id": "<string>",
    "member_id": "<string>"
  },
  "customer": {
    "metadata": {}
  },
  "member": {
    "metadata": {}
  }
}
'
{
  "customer": {
    "id": "<string>",
    "source_id": "<string>",
    "metadata": {},
    "object": "<string>"
  },
  "rewards": [
    {
      "id": "<string>",
      "name": "<string>",
      "metadata": {},
      "object": "<string>"
    }
  ],
  "memberships": [
    {
      "member": {
        "id": "<string>",
        "customer_id": "<string>",
        "program_id": "<string>",
        "metadata": {},
        "object": "<string>"
      },
      "program": {
        "id": "<string>",
        "name": "<string>",
        "metadata": {},
        "object": "<string>"
      },
      "cards": [
        {
          "card": {
            "id": "<string>",
            "card_definition_id": "<string>",
            "card_type": "INDIVIDUAL",
            "code": "<string>",
            "object": "<string>"
          },
          "rewards": [
            {
              "reward": {
                "id": "<string>",
                "object": "<string>"
              },
              "cost": {
                "points": 123,
                "object": "<string>"
              },
              "unavailability_reasons": [
                {
                  "details": "<string>",
                  "object": "<string>"
                }
              ],
              "object": "<string>"
            }
          ],
          "object": "<string>"
        }
      ],
      "object": "<string>"
    }
  ],
  "object": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}

Authorizations

Authorization
string
header
required

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

X-App-Id
string
header
required
X-App-Token
string
header
required

Body

application/json

Request body for examining rewards.

customer_identification
object
required

How the examined customer is identified. Depending on type, exactly one of customer_id, customer_source_id or member_id is required; the other two must not be present.

customer
object

Customer metadata overrides used during examination.

member
object

Member metadata overrides used during examination.

Response

Rewards examination result

Rewards examination result.

customer
object

Customer reference in examine results.

rewards
object[]

All rewards considered during examination (deduplicated).

memberships
object[]

Reward opportunities per program membership.

object
string

Object type marker. Always rewards_examine_result.

Allowed value: "rewards_examine_result"
Last modified on July 9, 2026