Get link to connect external account added through Finicity

API Method: GET /api/connectFinancialAccount/v2

Description:

This API method provides a link to connect an external financial account using Finicity's V2 integration. The method is used in banking applications to initiate the process of linking external accounts (such as bank accounts, credit cards, or investment accounts) to the user's profile within the application for services such as account aggregation, balance tracking, or transaction monitoring.

Endpoint:

GET /api/connectFinancialAccount/v2

Functionality:

  • Purpose: Retrieves a URL link that the user can navigate to in order to initiate the external account connection via Finicity's V2 service.
  • User Flow: When a user wants to link their external financial accounts (e.g., from another bank or financial institution), this endpoint provides a Finicity-powered link. The user is directed to the Finicity platform, where they authenticate and select the accounts they want to link.
  • External Service: Finicity V2 is an enhanced version of the Finicity integration, offering improved security, faster data fetching, and support for a broader range of financial institutions.

Request Headers:

  • Authorization: Bearer token required for user authentication and authorization to initiate account linking.
  • Content-Type: application/json

Response:

  • 200 OK: Returns a JSON object containing the URL where the user can initiate the external account linking.

    {
      "link": "https://connect.finicity.com/v2/...",
      "expiresAt": "2024-09-23T15:30:00Z"
    }
    
    • link (string): The Finicity-generated URL to initiate the connection process.
    • expiresAt (string): The expiration time of the generated link (in ISO 8601 format).
  • 401 Unauthorized: If the bearer token is invalid or expired.

  • 500 Internal Server Error: If there was a failure in communicating with the Finicity service or an unexpected server error.

Example Response:

{
  "link": "https://connect.finicity.com/v2/abc123",
  "expiresAt": "2024-09-23T15:30:00Z"
}

Notes:

  • The link typically expires after a set duration, so it is important to use the link promptly.
  • This method is part of a broader Finicity V2 integration that provides enhanced connectivity to external financial institutions.
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!