Skip to main content
POST
finance.consent.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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

Your own identifier for this person.

Required string length: 1 - 512

The person has approved this check.

reason
string
required

Reason for the check, at least 20 characters.

Required string length: 20 - 512
mobile
string
required

Same mobile used for the availability check.

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

Opaque choice from finance.account-availability.check.

Required string length: 1 - 512
dataRange
object
required

Inclusive date range.

financialTypes
enum<string>[]
required

Financial record types.

Required array length: 1 - 20 elements

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

Sections the person authorizes.

Required array length: 1 - 3 elements

Section of the financial record.

Available options:
PROFILE,
SUMMARY,
TRANSACTIONS

How you will use the data.

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

One fetch or repeated fetches.

Available options:
ONETIME,
PERIODIC
frequency
object
required

Maximum fetch frequency.

dataLife
object
required

How long you will retain fetched data.

purpose
object
required

Explicit consent purpose.

How long consent remains valid.

Inclusive date range.

dataFilters
object[]

Financial data filters.

Maximum array length: 20
taxId
string

Optional tax identifier for matching.

Required string length: 1 - 512
allowAdditionalPhone
boolean
default:false

Allow the person to add another mobile.

Response

The result

status
enum<string>
required

Consent state.

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

Platform link for the person to complete the flow.

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

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

Reference to what this call created. Pass it as ref to Follow-up operations for this resource.