Welcome to Dapi

Here you will find comprehensive documentation to help you integrate with Dapi's API as quickly as possible, as well as support if you get stuck. Get started below!

Get Started    

Platform Overview

Before you dive head-first into your Dapi application, it is important to get acquainted with the basics of the Dapi API.

API Keys

appKey

A unique identifier for your application.

appSecret

A private token linked to all the users of your application.

Store this safely and never share it in client-side code. It’s available for viewing and saving only once when the application is created. Save it safely the first time around because there’s no second chance!

userSecret

A private, encrypted version of the user key.

accessToken

A unique token linked to an end-user.

For more information, see Glossary.

API Environments

Sandbox

Build and test your application using test credentials in our sandbox environment. Here you can run all available API requests and test our functionality with a simulated Dapi bank.

Production

Go live with real financial institutions and user accounts. Please contact us to request access.

What is a User?

  • A user is a set of credentials attached to a financial institution.
  • An end-user is an individual using your application - your customer.

For instance

Bill Smith logs into your application with the username: app_billsmith and password: app_password. He then logs into his bank through your application using the Dapi API with username: bank_a_billsmith and password: bank_a_foobar. His Bank A savings account is linked to your application and can now be accessed.
Bill Smith is the end-user, whilst {bank_a_billsmith, bank_a_foobar, Bank_A} is the user.

An end-user can have accounts at multiple financial institutions, and is therefore associated with multiple users in Dapi.

For more information, see Users .

What are Jobs?

Each request to the Dapi API creates a new job or resumes an existing one.

Many financial institutions require multi-factor authentication (MFA) verification in order to authorize certain operations. To complete such multi-step operations and to keep track of previously accessed financial information, our API identifies each request with a unique jobID.

For more information, see Jobs.

Parameters

Operations with the Dapi API will require some of the following parameters:

appKey

Your application’s identifier, which you receive when creating a new app on the Dashboard. Place the appKey into the connector.js library in your web or mobile app.

appSecret

A private token that is generated and available to view only when a new application is first created in the Dashboard.

connectionID

An ID for a user’s successful log in to Connect. Returned in the response of UserLogin, once a user account is linked to Connect.

userSecret

An encrypted version of the user key generated upon successful login to Connect. Returned in the response of UserLogin.

accessCode

A unique code for a user’s successful login to Connect. Returned in the response of UserLogin.

accessToken

A unique token linked to one user which is sent to you in response to the Exchange Token request.

Updated 23 days ago

Platform Overview


Before you dive head-first into your Dapi application, it is important to get acquainted with the basics of the Dapi API.

Suggested Edits are limited on API Reference Pages

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