Skip to main content
POST
finance.institution.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.institutions.list.

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

Response

The result

name
string
required

Institution legal name.

Required string length: 1 - 512
financialTypes
string[]
required

Supported financial record types.

Maximum array length: 30

Financial record type.

Required string length: 1 - 512
institutionType
string
required

Institution category.

Required string length: 1 - 512
status
enum<string>
required

Availability of the institution.

Available options:
active,
inactive,
temporarily_inactive