Skip to main content
POST
/
tools
/
check-eligibility
Check membership eligibility for a benefit
curl --request POST \
  --url https://apiv2.example.com/tools/check-eligibility \
  --header 'Content-Type: application/json' \
  --data '
{
  "membershipId": "273682",
  "productOfferingId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "customerRef": "john.doe@example.com"
}
'
{
  "eligible": true,
  "reason": "Membership verified — recurring benefit applied",
  "discountAmount": 5,
  "provider": "demo"
}

Body

application/json

Request to check whether a membership qualifies for a benefit/discount.

​
membershipId
string
required

The membership number to validate (e.g. an IKEA Family membership number).

Example:

"273682"

​
productOfferingId
string

The product offering the benefit would apply to, if known.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
customerRef
string

Optional customer reference for auditing the check.

Example:

"john.doe@example.com"

Response

Eligibility check completed.

Result of a membership eligibility check.

​
eligible
boolean
required

Whether the membership qualifies for the benefit.

Example:

true

​
reason
string

Human-readable explanation of the decision.

Example:

"Membership verified — recurring benefit applied"

​
discountAmount
number<decimal>

The recurring discount amount granted when eligible.

Example:

5

​
provider
string

The provider that produced the decision.

Example:

"demo"