Skip to main content
You can manage companies either through the iDenfy dashboard or via the API.

​
Viewing Companies

To view all submitted companies (or forms), use the dashboard or the API.
For the List Companies endpoint (shows a list of all company reviews, including their status and details), see the API Reference tab for kybCompaniesList.

​
Reviewing a Company

To mark a company review as complete, change its status to COMPLETED using the API.
For the Change Status endpoint (marks a company review as completed), see the API Reference tab for kybCompaniesChangeStatusCreate.
You can also receive a webhook notification when a company is reviewed by enabling the COMPANY_REVIEW notification in your Notification Settings.

​
Re-Run KYB Automation

You can programmatically trigger a KYB automation re-run for a specific company without opening the dashboard.
For the Re-run Automation endpoint (POST /kyb/companies/{id}/automation/), see the API Reference tab for kybCompaniesAutomationCreate.
A finance check is performed before the automation task is queued. On success, the endpoint returns a 202 status code confirming the automation task has been scheduled. If the automation cannot be started, an error response is returned with a reason.

​
Retrieve All Company Information

For the Retrieve complete information about company endpoint, see the API Reference tab for kybCompaniesRetrieve.

​
Selecting Which Data to Return

By default the endpoint returns the complete company record. That response is assembled from several sources, so on a company with a large ownership structure or many ordered reports it can take a long time to come back. Pass the optional fields query parameter to return only the data types you actually need. It takes a list of values, either repeated or comma separated:
Accepted values match the top-level keys of the response — id, company, meta, token, documents, beneficiaries, questionnaires, comments, auditLogs, addressAudit, websiteAudit, companyNameAudit, dataMatchings, einVerification, govChecks, amlCheck, amlChecks, amlMonitoringUsers, and riskAssessment. Beneficiary data can be narrowed further with dotted values such as beneficiaries.info, beneficiaries.documents, or beneficiaries.ownershipPercentage, so you can pull the ownership structure without also pulling every beneficiary’s AML results. See the API Reference tab for the full list of accepted values. Requesting a parent returns everything beneath it — beneficiaries on its own covers every beneficiaries.* value, so there is no need to enumerate them. Omit fields entirely and the response is unchanged, so existing integrations keep working as they are.
An unrecognised value is rejected with a 400, and the error names the unknown field. Values are validated rather than silently ignored, so a typo fails the call instead of quietly returning less data than you expected.

​
Risk Assessment Results

The response includes a riskAssessment object, so you can retrieve a company’s risk scoring programmatically instead of opening the dashboard: The object is null when no risk assessment has been run for the company. See Get Risk Assessment Results for how the score is calculated.

​
Company Comments

The comments array returns the comments your team left on the company. Team members can edit and delete their own comments in the dashboard. See Editing and Deleting Comments.
Deleted comments are no longer returned. A comment returned in an earlier response can be missing from later ones, and an edited comment returns only its current text. Earlier versions of a comment are not available through the API. If your integration stores or counts comments, account for both cases.
The manager object on each comment identifies its author. A team member who was later deactivated or deleted still appears with their name, surname and email.

​
Deleting a Company

Companies can be removed from the dashboard or via the API.
For the Delete Company endpoint (removes a company and its session from the system), see the API Reference tab for kybCompaniesDestroy.

​
Request Update

You can ask your client to update submitted data using the Request More Information (RI) functionality.

​
Step 1: Request More Information

Initiate RI via dashboard. To track and handle these updates, set up the COMPANY INFO REQUEST webhook event.

​
Step 2: Checking the Flow

The data requested during RI may differ from the original form. To determine what fields are needed, retrieve the flow information.
For the Retrieve Flow endpoint (shows the fields currently required during RI), see the API Reference tab for kybInfoRetrieve.

​
Step 3: Update

Any updates can be made using the same endpoints used in the initial business verification flow, described in:
To check if a questionnaire is required, use the list endpoint and fill in the first item, especially if multiple are listed. See kybFormsQuestionnairesList in the API Reference.