Request access to the APIs

Overview

This article explains how to gain access to the Akkuro Lending APIs.

The Akkuro Lending APIs use an authorization mechanism similar to the OAuth 2.0 Client Credentials flow to ensure secure access. While it follows the core principles of machine-to-machine authentication using client credentials, there are implementation-specific differences in our environment.

Before integrating with our APIs, your system must obtain the following client credentials:

• client-id: A unique identifier of the client application.
• client-secret: A confidential string used to authenticate the client application.

Prerequisites

• You must already have an agreement with Akkuro Lending to get access to our APIs.

  The type of agreement required may vary depending on the target environment and the intended use. However, the access procedure remains unchanged for all environments.

Get client credentials

For security reasons, each client application is issued a unique set of credentials.

As a tenant, you may operate one or more white labels (customer-facing brands or sub-brands). Credentials are scoped to your tenant and either a specific white label or all white labels within that tenant.

Each set of credentials is scoped to your intended use case. Your system will be granted access to the relevant API domains (e.g., /collateral-management, /counterparty-management) based on your needs.

Initial credentials are typically issued after the inception phase, in which we identify integration points and required clients.

To request additional credentials, please contact your Customer Service representative with the following details:

• Client name (e.g., the name of the client application)
• Purpose of use (e.g., retrieve customer data)
• White label scope (e.g., your white label name)
• Expected number of requests (e.g., 500 requests per day)

Next steps

Once you've received your client credentials, you can now:

1. Review the Base URLs and environment.

2. Authenticate with the platform.