Skip to main content
POST
finance.statement-account.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.statement-analysis.collect.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
identityFields
enum<string>[]

Personal identity fields to include; none by default.

Maximum array length: 6
Available options:
name,
address,
birthDate,
email,
phone,
governmentId

Response

The result

maskedNumber
string

Account number masked except its last four digits.

Required string length: 1 - 2048
Pattern: ^[Xx*]{2,30}[0-9]{1,4}$
bankName
string

Bank name.

Required string length: 1 - 2048
accountType
string

Account type.

Required string length: 1 - 2048
category
string

Account category.

Required string length: 1 - 2048
currency
string

Three-letter currency code.

Required string length: 1 - 2048
dateRange
object

Requested date range; start must precede end.

name
string

Account holder name, only when selected.

Required string length: 1 - 2048
address
string

Account holder address, only when selected.

Required string length: 1 - 2048
birthDate
string

Calendar date, YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
email
string

Account holder email, only when selected.

Required string length: 1 - 2048
phone
string

Account holder phone, only when selected.

Required string length: 1 - 2048
governmentId
string

Government identifier, only when selected.

Required string length: 1 - 2048