Skip to main content
Company verification lets you collect business registration details, company documents, ownership information, and authorised-representative checks through Helium ID’s hosted flow. This guide explains:
  • how to create a company verification session
  • how to use the returned hosted link correctly
  • what the representative completes in the hosted flow
  • how to track progress and outcomes after submission

Before you start

  • Create an API key in the Helium ID Dashboard.
  • Make this request from your server. Do not expose your API key in browser or mobile-app code.
  • Configure your API key’s webhook URLs if you want automated updates.
  • Keep the returned hosted link intact. The link includes a secure hosted-flow token and must be used exactly as returned.

Create a company verification

Send a POST request to:
The endpoint is public for integrations, but authentication is required. Include your API key in the x-api-key header.

Request headers

string
required
Your Helium ID API key.
string
required
Set this to application/json.

Request body

string
Optional identifier from your system, such as a business or application ID.
object
Optional metadata to associate with the verification.
string
Optional company-verification campaign identifier. If provided, the new session uses that published campaign configuration.

Example request

Example response

Understand the response

The response contains two IDs that serve different purposes:
  • data.link: the full hosted URL you should redirect the representative to
  • data.verificationId: Helium ID’s public company-verification identifier, useful for your own tracking and webhook correlation
The hosted URL also contains:
  • processId: Helium ID’s internal company-verification record ID
  • hostedToken: the secure token that authorizes the hosted session
Always treat data.link as an opaque value. Do not rebuild it yourself and do not remove any query parameters. For a fuller explanation of company verification IDs, see IDs and Terminology.

Send the representative to the hosted flow

Redirect the company’s authorised representative to data.link. The hosted page identifies your workspace in its Requested by card using the workspace name and logo configured in Helium ID. The representative completes these steps:
  1. Upload company documents
  2. Review AI-assisted extraction results
  3. Confirm company details
  4. Review ownership and control details
  5. Complete the authorising-person section
  6. Provide additional compliance information
  7. Review and submit the company verification
Depending on your workspace configuration, the flow can also include a hosted selfie liveness check for the authorising person.
  • Do not replace processId with vendorData, your own customer ID, or the public verificationId.
  • Do not strip the hostedToken from the URL.
  • Do not generate your own company-verification links on the client.
If you need to resend the representative to the hosted flow, reuse the current link you stored or generate a new hosted link from the dashboard.

Tracking company verifications

There is currently no public GET /v1/company-verifications/{id} endpoint. You should track company verification progress using:
  1. webhooks
  2. the Helium ID Dashboard

Webhook events

Company verification uses company-specific event names. Events sent to the events webhook URL:
  • company_verification.submitted
  • company_verification.liveness_completed
  • company_verification.under_review
Events sent to the decision webhook URL:
  • company_verification.successful
  • company_verification.failed
Webhook payloads include the company-verification identifier and status so you can correlate the update with your own records. For field-by-field payload details, see Webhook Payload Schemas.

Live vs test company verifications

  • Live company verifications: final review and terminal decisions are handled by Helium ID.
  • Test company verifications: customer admins can move the verification through review states in the dashboard for testing purposes.

Managing verifications

Use the Helium ID Dashboard to review company verifications created for your workspace:
  1. Log in to the Helium ID Dashboard
  2. Open Verifications
  3. Switch to the company-verifications view
  4. Open the specific company verification to inspect its details, uploaded documents, progress, and current status