Link Accounts API
This API is intended for initiating an account link request to link selected account/s with the AA customer address.
Request Parameters
Parameter Name
Data type
Required?
Description
ver
string
Yes
The version of the API. Example : "1.0"
timestamp
string (date-time)
Yes
Current Timestamp. Example : "2018-05-09T17:51:18.412Z"
txnid
string
Yes
An unique transaction identifier used for providing an end to end traceability. Example : "f35761ac-4a18-11e8-96ff-0277a9fbfedc"
Customer
Customer Identification Details
id
string
Yes
Customer Address with the AA Example : "customer_identifier
@AA_identifier"
Accounts
A list of customer’s accounts to be linked
FIType
string
Yes
The FIType which the account belongs to. Could be DEPOSIT, TERM-DEPOSIT, RECURRING_DEPOSIT, SIP, CP, GOVT_SECURITIES, EQUITIES, BONDS, DEBENTURES, MUTUAL_FUNDS, ETF, IDR, CIS, AIF, INSURANCE_POLICIES, NPS, INVIT, REIT or OTHER
accType
string
Yes
The Account Type/ Sub FIType
accRefNumber
string
Yes
Internal unique FIP Account Reference Number which links with the masked account number. Example : "BANK11111111"
maskedAccNumber
string
Yes
Masked account number. Example : "XXXXXXX3468"
Response Parameters
Parameter Name
Data type
Required?
Description
ver
string
Yes
The version of the API. Example : "1.0"
timestamp
string (date-time)
Yes
Current Timestamp. Example : "2018-05-09T17:51:18.412Z"
txnid
string
Yes
An unique transaction identifier used for providing an end to end traceability. Example : "f35761ac-4a18-11e8-96ff-0277a9fbfedc"
AuthenticatorType
string
Yes
There are two kinds of authenticators that the FIP may support (1) FIP Direct Authenticator- The authenticator obtains confirmation through an interaction directly with the customer. (2) FIP Authorization Token-based Authenticator- In this case, a token (e.g., a short-lived one-time password) is issued to the customer, which the customer can then supply to the AA for subsequent forwarding to the FIP. This provides a confirmation to the FIP that the customer has approved the linking request to AA. Could be DIRECT or TOKEN
refNumber
string
Yes
A UUID string to coorelate the ACCOUNTS-LINKED notification. Example : "f6b1482e-8f08-11e8-862a-02552b0d3c36"
Example
Sample Request
{
"ver": "1.0",
"timestamp": "2018-05-09T17:51:18.412Z",
"txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
"Customer": {
"id": "customer_identifier@AA_identifier",
"Accounts": [
{
"FIType": "DEPOSIT",
"accType": "SAVINGS",
"accRefNumber": "BANK11111111",
"maskedAccNumber": "XXXXXXX3468"
}
]
}
}
Sample Response
{
"ver": "1.0",
"timestamp": "2018-09-22T06:13:30.967+0000",
"txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
"AuthenticatorType": "TOKEN",
"RefNumber": "f6b1482e-8f08-11e8-862a-02552b0d3c36"
}