API overview

  • 1 minute(s) read
Prev Next

Welcome to the API documentation. Our API is a RESTful service designed to help you integrate quickly and reliably with our platform.

We rely on standard HTTP features, making it familiar for developers:

  • Resource oriented: Predictable URLs (e.g., /transaction-checks).

  • JSON-First: We accept application/json request bodies and return JSON responses

  • Standard status codes: We use standard HTTP response codes to indicate success or failure

How it works

  1. Authenticate: Securely connect using your API Key

  2. Send data: Send transaction/customer data via JSON (API) or CSV (Batch)

  3. Receive verdict: Get immediate risk scores to block or approve transaction/ customer

Integration methods

Feature

API

Batch file upload

Best for

Time-sensitive operations (e.g. Transaction blocking flows)

Not time-sensitive. You can upload the data in chunks and let it process

Method

Synchronous (Connection is open till you receive a response)

Asynchronous (System notifies you when complete)

Data format

JSON

CSV

Documentation

See first API call

See batch integration

Quick links

  • Environments: Understand the difference between test and production environments

  • Authentication: Learn how to securely connect to our API using your credentials

  • First API call: Example of your first API call in just a few steps

  • Batch integration: Parameters used to retrieve list of resources from the API

  • FAQs: Answers to common integration questions