Skip to content

Getting Started

To get the best out of our platform, you need to get API credentials and configure webhook integration.

API credentials

Create an API key from the management platform. You will get a client ID and secret.

All API requests are authenticated using those two credentials in the following headers: X-CLIENT-ID and X-CLIENT-SECRET.

Webhook Configuration

Configure your webhook to receive updates when users make updates on the management platform.

From the same screen as the API credentials, click on the Screen Settings button to configure your webhook integration.

  • The provided URL should be support the following HTTP methods: HEAD and POST.
  • The secret will be used to sign JWT messages.

All webhook messages will be of the format:

{
  "ctx": "aml", // or kyc
  "ref": "transaction-reference", // transaction reference (or user, ...). context-dependent
  "action": "REJECT", // action that triggered the webhook notification.
  "comment": "optional comment"
}