Skip to main content
POST
finance.bank-account-verification.get

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
ref
string
required

The ref returned by finance.bank-account-verification.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
includeHolderName
boolean
default:false

Include the holder name.

includeAccountNumber
boolean
default:false

Include the full account number.

includeBankDetails
boolean
default:false

Include bank code, name and account type.

includePaymentAddress
boolean
default:false

Include the payer payment address.

Response

The result

status
enum<string>
required

Flow state; purged means personal data was erased.

Available options:
pending,
complete,
failed,
expired,
purged
verified
boolean

Verdict only when explicitly known.

holderName
string

Holder name when requested.

Required string length: 1 - 512
maskedAccountNumber
string

Masked account number.

Required string length: 1 - 512
accountNumber
string

Full account number when requested.

Required string length: 1 - 512
bankCode
string

Bank branch code when requested.

Required string length: 1 - 512
bankName
string

Bank name when requested.

Required string length: 1 - 512
accountType
string

Bank account type when requested.

Required string length: 1 - 512
paymentAddress
string

Payer address when requested.

Required string length: 1 - 512
expiresAt
string<date-time>

Flow expiry when known.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$