Skip to main content

Managing Company

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 endpoint below:

List Companies – Shows a list of all company reviews, including their status and details

List companies

Authorizations:
API key pair
query Parameters
created
Array of strings <date-time> [ items <date-time > ]

Multiple values may be separated by commas.

page
integer

A page number within the paginated result set.

perPage
integer

Number of results to return per page.

registrationNumber
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

Reviewing a Company​

To mark a company review as complete, change its status to COMPLETED using the API:

Change Status – Marks a company review as completed

Change company status

Note that the status cannot be changed from PENDING and PROCESSING statuses.

Authorizations:
API key pair
path Parameters
id
required
string

A unique value identifying this company.

Request Body schema: application/json
status
string (KybStatusEnum)

Responses

Request samples

Content type
application/json
Example
{
  • "status": "NEED_TO_PROCESS"
}

Response samples

Content type
application/json
Example
{
  • "status": "NEED_TO_PROCESS"
}
note

You can also receive a webhook notification when a company is reviewed by enabling the COMPANY_REVIEW notification in your Notification Settings.

Retrieve all company information​

Retrieve complete information about company

Retrieve all company info

Authorizations:
API key pair
path Parameters
id
required
string

A unique value identifying this company.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "company": {
    },
  • "meta": {
    },
  • "beneficiaries": [
    ],
  • "comments": [
    ],
  • "addressAudit": {
    },
  • "websiteAudit": {
    },
  • "companyNameAudit": {
    },
  • "documents": [
    ],
  • "questionnaires": [
    ],
  • "dataMatchings": [
    ],
  • "einVerification": {
    },
  • "auditLogs": {
    },
  • "amlMonitoringUsers": [
    ],
  • "govChecks": {
    }
}

Deleting a Company​

Companies can be removed from the dashboard or via API:

Delete Company – Removes a company and its session from the system

Delete company

Authorizations:
API key pair
path Parameters
id
required
string

A unique value identifying this company.

Responses

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 know what fields are needed, retrieve the flow information:

Retrieve Flow – Shows the fields currently required during RI

Retrieve KYB session info

Various info for KYB session.

Authorizations:
KYB token auth

Responses

Response samples

Content type
application/json
{
  • "locale": "en",
  • "theme": {
    },
  • "flow": {
    }
}

Step 3: Update​

Any updates can be made using the same endpoints used in the initial KYB flow, described in:

note

To check if a questionnaire is required, use the list endpoint and fill in the first item, especially if multiple are listed.

Questionnaire List – Lists all questionnaires for the KYB form

List questionnaires

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]