Skip to main content
POST
Send an eligibility request to a partner

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

partnerUrlForEligibilityCheck
string
required

URL used to perform the eligibility check.

Body

application/json

A request initiated by the Bango Platform, to be processed by the partner.

The following request types are available. See each request type schema for detailed information on purpose and response payload types.

  • OFFERS_ELIGIBILITY_CHECK: Ask the partner up-to-date eligibility data across for a specific offer or for all available offers for a consumer.

Ask the partner for all available offers eligibility up-to-date for a consumer.

The consumer is identified using consumer properties that contains the identification of the consumer, frequently the consumerId.

requestId
string<uuid>
required

Unique ID associated with request/response to an API.

Example:

"85d814e6-7ca7-4753-8477-5363b67a6091"

type
enum<string>
required

Indicates the type of the eligibility check being requested.

Available options:
OFFERS_ELIGIBILITY_CHECK
Example:

"OFFERS_ELIGIBILITY_CHECK"

payload
object
required

Response

The response payload, which depends on the request type.

Supported HTTP responses

  • HTTP 200 OK:
    • ELIGIBILITY_RETRIEVED
    • ELIGIBILITY_DENIED

This is one of the two responses to an OFFERS_ELIGIBILITY_CHECK request. It Contains information about the consumer's eligibility for offers. This response is used when any eligibility information was provided by the partner.

requestId
string<uuid>
required

Unique ID associated with request/response to an API.

Example:

"85d814e6-7ca7-4753-8477-5363b67a6091"

type
any
required

Indicates the type of eligibility response.

payload
object
required