Connection to customer’s account

This API is called using the bank customer's credentials and returns a list of external accounts that have been granted permission to connect to the customer's account. Only requests that have been confirmed by the customer are included in the response.

Response:
The response is an array of accounts that have been approved by the customer, where each object contains the details of the connected account.

Explanation of Fields:

  • id: The unique ID assigned to the external account.
  • nickName: The username or nickname associated with the external account.
  • firstName / lastName: The first and last name of the external account holder.
  • dba: Relevant for business or sub-accounts, indicating the business name under which the account operates.
  • type: Specifies the type of external account connected:
    • 1: Consumer account.
    • 2: Business primary account.
    • 4: Business sub-account.
      This API helps customers view all the external accounts that have permission to connect to their account, showing only confirmed connections.
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!