Skip to main content
POST
finance.account-availability.check

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}$

Body

application/json
mobile
string
required

Person’s ten digit mobile number.

Pattern: ^[0-9]{10}$

The person has approved this check.

Response

The result

anyAvailable
boolean
required

At least one consent route found an account.

choices
object[]
required

Available consent routes, with no account or route identifiers.

Maximum array length: 20