Discover Accounts API
This method enables an AA to discover accounts belonging to a Customer based on the customer identifiers. A list of masked account information and corresponding linkRefNumber for each discovered account are returned based on identifier matching logic at FIP.
Request Parameters
Parameter Name
Data type
Required?
Description
ver
string
yes
Version of the NBFC-AA Ecosystem API. Example:"1.0"
timestamp
string (date-time)
yes
Current TimeStamp
txnid
string
no
An unique transaction identifier used for providing an end to end traceability. Example : "f35761ac-4a18-11e8-96ff-0277a9fbfedc"
Customer
This block would contain the information about the customer including the identifiers & the customer address at the AA
Id
string
Yes
The unique customer address with the AA. Example:"customer_identifier
@AA_identifier"
Identifiers
A list of customer’s identifiers used to link accounts.
Category
string
Yes
Category of identifiers based on the ability to find authenticity online. Could be STRONG, WEAK or ANCILLIARY
type
string
Yes
Specifies the type of identifier. Example : "AADHAAR"
value
string
Yes
Contains the value/number of selected identifer. Example : "XXXXXXXXXXXXXXXX"
FITypes
string
no
Contains a list of the requested financial information type. 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
Response Parameters
Parameter Name
Data type
Required?
Description
ver
string
Yes
The version of the API. Example: "1.0"
timestamp
string (date-time)
Yes
Creation timestamp of the message which will be updated at each leg. Example: "2018-12-06T11:39:57.153Z"
txnid
string
Yes
An unique transaction identifier used for providing an end to end traceability. Example: "f35761ac-4a18-11e8-96ff-0277a9fbfedc"
Discovered Accounts
A list of discovered accounts
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"
Example
Sample Request
{
"ver": "1.0",
"timestamp": "2019-04-22T08:16:35.076Z",
"txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
"Customer": {
"id": "customer_identifier@AA_identifier",
"Identifiers": [
{
"category": "STRONG",
"type": "AADHAAR",
"value": "XXXXXXXXXXXXXXXX"
}
]
},
"FITypes": [
"DEPOSIT"
]
}
Sample Response
{
"ver": "1.0",
"timestamp": "2018-12-06T11:39:57.153Z",
"txnid": "f35761ac-4a18-11e8-96ff-0277a9fbfedc",
"DiscoveredAccounts": [
{
"FIType": "DEPOSIT",
"accType": "SAVINGS",
"accRefNumber": "BANK11111111",
"maskedAccNumber": "XXXXXXX3468"
}
]
}