Skip to main content
GET
cURL

Authorizations

api-key
string
header
required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Headers

X-Profile-Id
string | null

Restricts the lookup to entries belonging to this business profile, plus entries with no profile. If omitted, the merchant's default profile is used; merchants with more than one profile have no default and will receive an error asking for this header.

Query Parameters

data
string
required

The raw value to check against the blocklist, e.g. a card BIN

Response

Blocklist lookup result

data
string
required
blocked
boolean
required

Whether an entry matching data exists in the blocklist, under any data_kind