Skip to main content
POST
fraud.card.inspect

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
bin
string
required

Six to nine leading card digits; never a full card number.

Pattern: ^[0-9]{6,9}$
includeIssuerContact
boolean

Include public issuer contact details; default off.

Response

The result

valid
boolean
required

Whether the card prefix is recognised.

bank
string

Issuing bank.

Required string length: 1 - 256
network
string

Card network.

Required string length: 1 - 100
type
string

Card type.

Required string length: 1 - 100
level
string

Card level.

Required string length: 1 - 100
countryCode
string

Issuing country code.

Required string length: 1 - 100
country
string

Issuing country.

Required string length: 1 - 100
issuerPhone
string

Requested public issuer phone.

Required string length: 1 - 100
issuers
object[]

Other issuer possibilities when documented.