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    

Client

An entity that integrates Dapi into their application.

User

A set of credentials in a financial institution paired with Dapi.

End-User

An individual using your application.

accountID

An identifier for a bank account the user has.
Each user can have multiple bank accounts. For instance, username_johndoe has a checking account and savings account with HSBC.

accessCode

A unique code given to the user when a user successfully logs in to Connect through your application. Valid only for 30 minutes after a successful login.

accessToken

A unique token linked to one user. This token is valid indefinitely.

Your application must request Exchange Token to exchange a user’s accessCode for a user associated accessToken.
This token is used to run all Dapi operations against a user including data retrieval and payment initiation. It remains valid indefinitely.

connectionID

An ID for a user’s successful login to Connect. It is returned once a user account is linked on Connect.

userSecret

An encrypted version of the userKey. It is returned once a user account is linked on Connect. It should be stored on the user’s device or browser after login.

userID

A unique identifier for each user of your application. It is returned once a user account is linked to Connect.

appKey

A unique identifier for each of your applications.

appSecret

A private token that is generated and available to view only upon the creation of your application. It is stored with you and linked to all the users of your application. You must store this safely; losing the appSecret would result in permanently losing access to your application.

It must never be put on the client-side of any application!

jobID

A unique ID generated by Dapi to identify a new operation. Can be used to reference the response for any past job as well as track the job’s status.

Updated 3 months ago

Glossary


Suggested Edits are limited on API Reference Pages

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