How to use ECHO service

API description

The ECHO REST API is designed for server-to-server calls. The client API key is required in the header of API calls.

Request

Clients may request connectivity information using a POST to: https://{URL}/ibv/connection_info

Header

Name	Description	Example	Required
x-api-key	A unique API Key for the environment	19YYgyZecTaSs2N0gjlq32Vh6D	Yes

Body

Name	Description	Example	Type	Format	Required
routing_number	Routing number of the account the consumer wants to use for IBV. Used to identify the financial institution.	074000013	String	/^\d{9}$/	Yes
account_number	Account number of the account.	2302389238923	String	/^[0-9]*$/	Yes

Example

{
 "routing_number": "074000010",
 "account_number": "2302389238923"
}

Response

👍
Success - HTTP 200

Name	Description	Example	Type
routing_number	The nine digit routing number passed to the endpoint	71000013	String
account_number	The account number passed to the endpoint	2302389238923	String
connection_exists	True if EDGE Connect has existing connections for the routing number or any of the IBV aggregators on the EDGE Connect platform reported a matching financial institution. If the result is false, some aggregators may still be able to connect the user’s accounts using the search for institutions feature.	TRUE	Boolean
institutions	Institutions found based on the routing number. More than one institution may correspond to the same routing number. Note that the consumer may connect/log into their account through an institution/site that is different from the one returned by this API.	"[ { Institution information } ][ { Institution information } ]"	Json Array
[“institutions”][x][“name”]	Name of the financial institution	Chase	String
[“institutions”][x][“login_url”][“login_url”]	Login url of the financial institution	https://secure07b.chase.com/web/auth/dashboard	String
[“institutions”][x][“status”]	Status of the connection based on real time data. The current version of the API supports two statuses: “normal” and “unreliable_last_3_day.” “unreliable_last_3_day” means the EDGE Connect platform has detected enough issues with the connection in the past 3 days to consider the connection as “unreliable”.	normal	String

Example

{
  "routing_number": "074000013",
  "account_number": "2302389238923",
  "connection_exists": true,
  "institutions": [
    {
      "name": "Chase",
      "login_url": "https://secure07b.chase.com/web/auth/dashboard",
      "status": "normal"
    }
  ]
}

❗️
Invalid Data - HTTP 400

The API will validate the input routing number and return an error message if it is not a valid routing number.

{
 "message": "Invalid routing number."
}

Updated 3 days ago