NAV Navbar

API Reference

Base URL

The Leapfin API is organized around REST. Our API uses HTTP response codes to indicate API errors.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.


Example Request

        curl \
          -H "X-Api-Key: a1b2c3d4e5f6"

A sample key is provided in all examples in this documentation. To make a request on your account, replace the sample key with your actual key.

You will be provided a Secret API Key by Leapfin accessible on the integrations page in your Leapfin account. Please remember you should never expose your secret API key in any public website's client-side code. We expect the API key to be included in all API requests to the server in the Header as follows:

X-Api-Key: a1b2c3d4e5f6

All requests should be submitted with a content-type application/json:

Content-Type: application/json


Data Ingestion

Object Type

  -H "X-Api-Key: a1b2c3d4e5f6" 
  -H "Content-Type: application/json"
      "unique_id": "test",
      "amount": 12345,
      "date": "2018-01-01"
      "unique_id": "test",
      "amount": 12345,
      "date": "2018-01-01"

The request body must be a non-empty JSON array of objects, where each object has a unique unique_id. The unique_id field and the [object_type] name in the request will be determined with the Leapfin Implementation Team during the onboarding process. In cases where the object already exists in our system, the default behavior is to update the existing data.

HTTP Request


Object properties

Property Required Description
unique_id Yes External ID