How APIs Works?

The Majority of the APIs allows you to search and retrieve the information based on specific search criteria. The process involves multiple API calls to start a search, track request status, and retrieve detailed records. If a request fails (due to invalid authentication, insufficient credits, or other errors), the API returns appropriate error responses.

👍

Important:

Always include these headers in every request:

Content-Type: application/json (if the request body is a JSON. Refer to respective API section for more details.)

Authorization: Bearer {auth-token}

1. Submit a Search Request

Send a POST request with the required payload to initiate a search.

POST /api/v1/kyb/canada/business

Successful Response (200)
Returns a JSON object containing:

• id – Unique request identifier
• Initial request details

2. Check Request Status

Poll the GET BY ID endpoint until the request reaches a final state (Completed or Error).

GET /api/v1/kyb/canada/business/?id={id}

Statuses may progress from Pending → Processing → Completed.

Response includes: request status, timestamp, and an array of possible matches.

Pagination: Use page, order, offset, and limit query parameters to navigate results.

👍

⚙ Best Practice:

• Use exponential backoff polling with a capped maximum interval (e.g., start at 2 seconds, double each time, and cap at 30 seconds) to reduce server load and optimize resource usage.
• Alternatively, use webhooks if your integration supports them — this eliminates the need for polling entirely, as the API will notify your system when the request is complete.

3. Retrieve Detailed Business Information

Once the status is Completed, fetch complete details for a specific match using its unique rid..

GET /api/v1/kyb/canada/business/?rid={rid}

Response contains full business details for the specified entity.

📘

Note:

This endpoint is specific to certain APIs. In cases where the API returns full details in the initial response, a separate "Retrieve Detailed Information" call is not required.

4. Retrieve All Submitted Records

Get a list of all business search requests submitted.

GET /api/v1/kyb/canada/business/

Response includes IDs, entity names, search flags, statuses, timestamps, and created-by details.

Pagination: Use page and order parameters to navigate results.

In Summary, the API supports:

Searching for business information

Tracking the status of search requests

Retrieving full details for a specific entity

Viewing all submitted business search records