Create Company Verification

Company verification lets you collect a business’s registration information, authorised-representative details, and supporting documents through Helium ID’s hosted flow.

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.
Keep the returned hosted link intact. Its processId is Helium ID’s internal verification ID and is required to open and submit the hosted flow.

Create a company verification

Send a POST request to:

POST /v1/company-verifications

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.

Example request

curl -X POST 'https://server.heliumid.io/api/v1/company-verifications' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
    "vendorData": "business_12345",
    "meta": {
      "applicationId": "application_67890"
    }
  }'

const response = await fetch(
  "https://server.heliumid.io/api/v1/company-verifications",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-api-key": process.env.HELIUM_ID_API_KEY,
    },
    body: JSON.stringify({
      vendorData: "business_12345",
      meta: { applicationId: "application_67890" },
    }),
  }
)

const result = await response.json()
console.log(result.data.link)

Example response

{
  "status": true,
  "message": "Created company verification",
  "data": {
    "link": "https://verify.heliumid.io/company?processId=69d4f7657bcbe3b58b96b2f7",
    "verificationId": "69d4f7657bcbe3b58b96b2f7"
  },
  "code": 200
}

Send the user to the hosted flow

Redirect the company’s authorised representative to data.link. The hosted page identifies your workspace in its Requested by sidebar card, using the workspace name and logo configured in Helium ID. The representative completes these steps:

Business information, including registration, business activity, address, and contact details.
Authorised representative information and identity-document details.
Supporting documents, including business registration and proof of address.

Important: use only the returned link

The hosted company-verification flow accepts only the internal verificationId generated by this endpoint. Do not substitute vendorData, a customer ID, or any other external identifier for processId; those values cannot start or update a verification.

Managing verifications

Use the Helium ID Dashboard to review company verifications created for your workspace. The API-key creation endpoint does not expose a public company-verification retrieval endpoint.

Getting started

Verifications

Company Verifications

Technical Guides

Reference

Before you start

Create a company verification

Request headers

Request body

Example request

Example response

Send the user to the hosted flow

Important: use only the returned link

Managing verifications

​Before you start

​Create a company verification

​Request headers

​Request body

​Example request

​Example response

​Send the user to the hosted flow

​Important: use only the returned link

​Managing verifications

Before you start

Create a company verification

Request headers

Request body

Example request

Example response

Send the user to the hosted flow

Important: use only the returned link

Managing verifications