Authentication

First you will need an API key and secret, which you should receive when you are granted Sandbox access. If you are doing a multi-bank integration, then you will need a unique key and secret for each institution.

Once you have your credentials authenticating API calls is a two step process:

1) Retrieve Access Token

First you will need to ping the authentication service for the institution you are working with to obtain an access token for making API calls.

To do this you will need to know your API key, secret, and the Bank-Auth-URL which is a value that should have been provided to you. Below is an example request and response.

Request

curl --request POST \
  --url https://<BANK-AUTH-URL>/oauth/token \
  --header 'content-type: application/json' \
  --data '{"client_id":"<YOUR API KEY>","client_secret":"<YOUR API SECRET>","audience":"https://<BANK-NAME>-graphql/","grant_type":"client_credentials"}'

Example Response

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InktU1BuZlZ4T09OTC1WZlJhOFoyNSJ9.eyJodHRwOi8vemVzY3Jvdy5jb20vbmFtZSI6IlRoZSBTb25zIG9mIEhvbm9yIE0yTSIsImh0dHA6Ly96ZXNjcm93LmNvbS9lbWFpbCI6IiIsImh0dHA6Ly96ZXNjcm93LmNvbS9zeW5jX2NvbnRyb2wiOlsib3JnIiwiYXBpX29yZyJdLCJodHRwOi8vemVzY3Jvdy5jb20vc3luY19yb2xlcyI6WyJvcmc6MTItNjk0MjAiLCJhcGlfb3JnOjEyLTY5NDIwIl0sImlzcyI6Imh0dHBzOi8vemUtYmV0YS1kZXYudXMuYXV0aDAuY29tLyIsInN1YiI6ImVQeHAxU2VMSE5KdjhETDl6MWdHeVhRNTVJYzJmRDJPQGNsaWVudHMiLCJhdWQiOiJodHRwczovL2JldGEtZGV2LWdyYXBocWwvIiwiaWF0IjoxNjYwNTM5NzMzLCJleHAiOjE2NjA1NDMzMzMsImF6cCI6ImVQeHAxU2VMSE5KdjhETDl6MWdHeVhRNTVJYzJmRDJPIiwic2NvcGUiOiJvcmc6MTItNjk0MjAiLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMifQ.lcwDjlZa22czb1pxl4C5qiD7QJuQiFLaMTBIVAzFOQg0KjKU_Gatwd-TG1tDvp_IJro2jIl_-D4eo_LefJFH1SNb1BJ2zdMEenaHuU9bALLt9BOOCU5hAee1mzeVmjgGeZGRMKnf6azukPJCEhGA86Q651U7fjnBNEfp31sal0PL-oVAtFeRqvOg9w8UVJoODuInfW6YZxinUkR9ZbE13MrntuW6mPQx9wcnsYFNwVjdbB3x1zlJoFXYS4xxXdi6UCPwY5J7dUL-UVfF6fbDQDAzppSnYDQJ9Um281eQ26Zy7SLTEFxdfCSqfvLvPpBIpZDKJdCJJEAvBtk3qHER6w",
  "token_type": "Bearer"
}

2) Make API calls

Now that you have the access token simply add it each request you make to the API in the authorization header.

curl --request GET \
  --url https://<BANK-URL>.zescrow.com/api/graphql \
  --header 'authorization: Bearer <YOUR API TOKEN>'

That’s it! You are now ready to start building your application.

Quick Start

Close Subaccount