Welcome to the Sikoia API Reference documentation. Here you will find a list of all API endpoints and methods supported by the Sikoia platform.

📘
Just Getting Started?
Check out our quickstart guide!

Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Read our API Behaviour guides for more information.

Try It Out

This documentation is fully interactive, allowing you to test endpoints with real requests - all you need is an access token. If you're unsure where to get an access token, read our quickstart guide or get in touch using the support widget.

Recipes

To see how to link some of the endpoints together into business flows read through our API recipes.

Here's our Company Registry Data recipe:

API Reference Sections

The API reference is broken down into several sections:

Users & Authorisation - to manage user access and manage API authentication
Webhooks - to create and manage webhooks
Entity Management - to create, view, and edit Cases, Companies, and People.
Enriched Entity Data - to request, upload and view 3rd Party Data for entities
Insights - to generate Sikoia insights for entities based on the data available.

For a high level view of these Sikoia Concepts read our guides !