Skip to main content

Getting started guide

For third parties integrating with Banqup APIs​

Key roles​

The key roles involved in the process of integrating the Banqup APIs are:

  • Legal representative: The official company representative who is registered in the Banqup system. This person has rights to grant access permissions and invite other users. They are responsible for the company registration process and may also be the credential administrator.
  • Credential administrator: A trusted employee designated to manage client credentials securely. This role handles credential creation, storage, and distribution.
  • Developer: The technical implementer who integrates the Banqup APIs with company applications. Developers work with the provided credentials to establish authentication and authorization protocols for secure implementation of Banqup APIs.

Integration process​

1. Register the company in Banqup

The legal representative registers their company in Banqup.

2. Set up the client credentials

Recommended security practice: Credentials for production environments should be encrypted and shared as such with the developer. The developer then stores the credentials securely in the application and configures the app to handle decryption only when needed for API calls.

3. Integrate the Banqup APIs

  • The credential administrator securely transfers the encrypted credentials to the developer.

  • The developer implements an authentication flow to use the client credentials to create access tokens. The developer also creates API calls using the access token to retrieve data and interact with Banqup services, based on permissions granted to the client credentials by the legal representative.