Bank Logins UI

Bank Logins UI is a simple user interface built on top of our Bank Login API.

Our bank logins UI tool is a quick way to link a bank account without building your own UI. View our bank logins demo.

Setup:

  1. Issue Public Key: Issue a public key with scope CLIENT|CONTROLS.

  2. Issue OAuth Key: Issue an OAuth Key for the user, with scopes USER|GET, NODES|GET, NODES|POST, NODE|PATCH.

  3. Create the URL with the public key, OAuth key, success and failure URI.
    Sandbox URL: https://uat-uiaas.synapsefi.com/link?oauth_key=OAUTH_KEY&public_key=PUBLIC_KEY&success_uri=SUCCESS&failure_uri=FAILURE
    Production URL: https://uiaas.synapsefi.com/link?oauth_key=OAUTH_KEY&public_key=PUBLIC_KEY&success_uri=SUCCESS&failure_uri=FAILURE

  4. Test the UI to ensure everything is rendering properly.

Path Parameters

An oauth_key and public_key are required path parameters. See How to OAuth a User and Issue a Public Key.

Path Parameters

Path Parameter
Note

oauth_key

OAuth key of the user who needs to link new accounts (required)

public_key

Your public key (required)

Android Webviews

If you are rendering this component inside an Android webview, please make sure that you have DOM storage enabled settings.setDomStorageEnabled(true);

GET Params on redirect

GET Params returned on success_uri:

GET Param
Note

user_id

Synapse ID of the user

GET Params returned on failure_uri:

GET Param
Note

error_code

Error code from Errors Section

http_code

HTTP code from Errors Section

message

Reason for failure

user_id

Synapse ID of the user

Customizing the UI

You can customize the following things on the UI. If you wish to change any of these fields, please go to Client Manager on the dashboard to do so.

Field
Comment

Color Palette

You can update the color with any hex value. By default it uses our colors.

Logo

Any landscape logo (recommended: 1388 × 367 pixels). By default it uses our logo

Disclosure

The footer disclosure text can be modified. By default it says Banking services are provided by Evolve Bank and Trust; Members FDIC.

Legal Agreements

Any bank login privacy agreements that you want the user to agree to while logging into a bank. By default the user agrees to our Website Terms of Use and our Privacy Policy

Success URI

Once login is successful where should we redirect the user

Failure URI

If login fails or user wants to abandon the login, where should we redirect the user

Bank Logins UI


Bank Logins UI is a simple user interface built on top of our Bank Login API.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.