Kyboa’s Developer API is now available, allowing customers to connect Kyboa screening and maintained Entity workflows directly to their own systems.
Access to the current Developer API screening and Entity endpoints is included with Kyboa accounts at no additional API charge. There is no separate API credit pool: screenings created through the API consume credits from the same subscription allowance or prepaid balance used within the Kyboa interface. Registry search and company profile lookups are not currently offered through this API.
View the Kyboa Developer API documentation.
Bring Kyboa into your existing workflow
The API provides an alternative way to use Kyboa without requiring staff to manually create every screening through the web interface.
This can be useful where customer, counterparty or internal records already exist in another platform and screening needs to form part of an established onboarding or compliance process.
For example, an integration can create a screening when a new client is added to another system, maintain a corresponding Kyboa Entity, trigger a new screening when required, and retrieve screening status and risk information for use in the wider workflow.
What can the v1 API do?
The current API supports the core screening and Entity workflow, including:
- create quick individual screenings;
- create company name-only screenings;
- check the status and result metadata of a screening;
- check whether an Entity already exists;
- create a new individual or company Entity with core identity information;
- retrieve the current details of an Entity;
- trigger a new screening using a maintained Entity; and
- retrieve the screening history associated with an Entity.
Screening is asynchronous, using the same processing pipeline as screenings created through Kyboa itself. An integration creates the screening, retains the returned ID and can then poll the API until processing is complete.
The same credits for supported API screening
Screenings initiated through the current Developer API use the standard per-subject credit rules, with no additional API surcharge.
API screenings consume credits from the account’s unified balance:
- a quick individual screening uses 1 credit;
- a quick company name-only screening uses 1 credit; and
- a screening run from an Entity uses 1 credit for each distinct enabled person or organisation screened.
Aliases, translated names, local-language names and previous names belonging to the same person or organisation remain included without additional credits.
This means an integration can use the account’s subscription allowance or prepaid credit balance without purchasing a separate API package. The same balance also covers any premium registry lookups made through the Kyboa app; see How Credits Work for the current credit costs.
API access is included with every account
There is no separate integration activation process required from Kyboa.
An account administrator can create an API User from Account Users. Once activated, that API user can open API Management and generate a private API token for the integration.
The token is scoped to the customer’s own Kyboa account, so the integration cannot access records belonging to another account.
Current v1 limitations
The first version of the API is intentionally focused on common screening and Entity workflows rather than exposing every feature available in the Kyboa interface.
Current limitations include:
- No registry search or lookup API. Registry-enhanced company screening, including official Singapore and Malaysia registry lookups, is currently performed through the Kyboa interface.
- No bulk screening endpoint. Individual API screenings must currently be created separately.
- Limited Entity creation. The API can create the core Entity record, but detailed addresses, additional names, directors, shareholders and other nested records are currently maintained through Kyboa.
- No Entity update or registry refresh endpoints. Editing, deleting, restoring, registry re-imports, version history and review decisions remain web-interface workflows.
- No full report download through the API. Screening status, risk rating, confidence and report metadata are available, but the API does not currently return the full report PDF, raw provider data or individual match results.
- No webhook callbacks yet. Integrations currently poll the screening endpoint for completion rather than receiving a callback.
- No creation idempotency keys. Integrations should retain returned screening IDs and avoid blindly repeating creation requests, as another request can create another screening and consume additional credits.
These boundaries keep the v1 API relatively straightforward while covering the most useful integration scenarios. Additional API capabilities can be expanded as customer integration requirements develop.
Start with the documentation and Postman collection
The full Developer API documentation includes authentication setup, endpoint details, request and response examples, error handling, rate limits and suggested integration workflows.
A ready-to-import Postman collection is also available from the documentation, with examples covering authentication, quick screenings, Entity creation, Entity screening and polling.
Read the Developer API documentation and download the Postman collection.
Because API access is already included with Kyboa accounts, existing customers can begin testing an integration simply by creating an API User and generating a token.
