- 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 aPOST request to:
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 todata.verificationId: Helium ID’s public company-verification identifier, useful for your own tracking and webhook correlation
processId: Helium ID’s internal company-verification record IDhostedToken: the secure token that authorizes the hosted session
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 todata.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:
- Upload company documents
- Review AI-assisted extraction results
- Confirm company details
- Review ownership and control details
- Complete the authorising-person section
- Provide additional compliance information
- Review and submit the company verification
Important: use the returned link exactly as-is
- Do not replace
processIdwithvendorData, your own customer ID, or the publicverificationId. - Do not strip the
hostedTokenfrom the URL. - Do not generate your own company-verification links on the client.
Tracking company verifications
There is currently no publicGET /v1/company-verifications/{id} endpoint.
You should track company verification progress using:
- webhooks
- the Helium ID Dashboard
Webhook events
Company verification uses company-specific event names. Events sent to the events webhook URL:company_verification.submittedcompany_verification.liveness_completedcompany_verification.under_review
company_verification.successfulcompany_verification.failed
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:- Log in to the Helium ID Dashboard
- Open Verifications
- Switch to the company-verifications view
- Open the specific company verification to inspect its details, uploaded documents, progress, and current status