Skip to main content
POST
finance.consent.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.consent.create.

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

Response

The result

status
enum<string>
required

Consent state.

Available options:
pending,
initiated,
failed,
active,
paused,
revoked,
expired,
rejected

Date and time including its UTC offset.

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

Date and time including its UTC offset.

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)))$
dataRange
object

Inclusive date range.

financialTypes
enum<string>[]

Authorized financial types.

Maximum array length: 20

Financial record type.

Available options:
DEPOSIT,
TERM_DEPOSIT,
RECURRING_DEPOSIT,
SIP,
CP,
GOVT_SECURITIES,
EQUITIES,
BONDS,
DEBENTURES,
MUTUAL_FUNDS,
ETF,
IDR,
CIS,
AIF,
INSURANCE_POLICIES,
NPS,
INVIT,
REIT,
GSTR1_3B,
OTHER

Authorized record sections.

Maximum array length: 3

Record section.

Available options:
PROFILE,
SUMMARY,
TRANSACTIONS

Authorized use.

Available options:
VIEW,
STORE,
QUERY,
STREAM
fetchType
enum<string>

Authorized fetch pattern.

Available options:
ONETIME,
PERIODIC
frequency
object

Authorized fetch frequency.

dataLife
object

Authorized data retention.