Create company verification
curl --request POST \
--url https://server.heliumid.io/api/v1/company-verifications \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"vendorData": "business_12345",
"meta": {
"applicationId": "app_67890"
},
"campaignId": "cmp_64ff2f3f4f31d4d5f2ab1234"
}
'import requests
url = "https://server.heliumid.io/api/v1/company-verifications"
payload = {
"vendorData": "business_12345",
"meta": { "applicationId": "app_67890" },
"campaignId": "cmp_64ff2f3f4f31d4d5f2ab1234"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
vendorData: 'business_12345',
meta: {applicationId: 'app_67890'},
campaignId: 'cmp_64ff2f3f4f31d4d5f2ab1234'
})
};
fetch('https://server.heliumid.io/api/v1/company-verifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://server.heliumid.io/api/v1/company-verifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'vendorData' => 'business_12345',
'meta' => [
'applicationId' => 'app_67890'
],
'campaignId' => 'cmp_64ff2f3f4f31d4d5f2ab1234'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://server.heliumid.io/api/v1/company-verifications"
payload := strings.NewReader("{\n \"vendorData\": \"business_12345\",\n \"meta\": {\n \"applicationId\": \"app_67890\"\n },\n \"campaignId\": \"cmp_64ff2f3f4f31d4d5f2ab1234\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://server.heliumid.io/api/v1/company-verifications")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vendorData\": \"business_12345\",\n \"meta\": {\n \"applicationId\": \"app_67890\"\n },\n \"campaignId\": \"cmp_64ff2f3f4f31d4d5f2ab1234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.heliumid.io/api/v1/company-verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vendorData\": \"business_12345\",\n \"meta\": {\n \"applicationId\": \"app_67890\"\n },\n \"campaignId\": \"cmp_64ff2f3f4f31d4d5f2ab1234\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Created company verification",
"data": {
"link": "https://verify.heliumid.io/company?processId=69d4f7657bcbe3b58b96b2f7&hostedToken=eyJleGFtcGxlIjoidG9rZW4ifQ",
"verificationId": "cv_0b5f6f4e0aab25d8c130ab21",
"campaignId": "cmp_64ff2f3f4f31d4d5f2ab1234",
"campaignVersion": 3,
"expiresAt": "2026-08-25T12:00:00.000Z"
},
"code": 200
}{
"status": false,
"message": "Verification not found or has been deleted",
"code": 400
}{
"status": false,
"message": "Unauthorized",
"code": 401
}API Reference
Create company verification
Create a company verification session and receive a hosted link for the authorised representative. The returned verificationId is the public company verification identifier. The hosted processId inside the link is the internal company verification record ID.
POST
/
v1
/
company-verifications
Create company verification
curl --request POST \
--url https://server.heliumid.io/api/v1/company-verifications \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"vendorData": "business_12345",
"meta": {
"applicationId": "app_67890"
},
"campaignId": "cmp_64ff2f3f4f31d4d5f2ab1234"
}
'import requests
url = "https://server.heliumid.io/api/v1/company-verifications"
payload = {
"vendorData": "business_12345",
"meta": { "applicationId": "app_67890" },
"campaignId": "cmp_64ff2f3f4f31d4d5f2ab1234"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
vendorData: 'business_12345',
meta: {applicationId: 'app_67890'},
campaignId: 'cmp_64ff2f3f4f31d4d5f2ab1234'
})
};
fetch('https://server.heliumid.io/api/v1/company-verifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://server.heliumid.io/api/v1/company-verifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'vendorData' => 'business_12345',
'meta' => [
'applicationId' => 'app_67890'
],
'campaignId' => 'cmp_64ff2f3f4f31d4d5f2ab1234'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://server.heliumid.io/api/v1/company-verifications"
payload := strings.NewReader("{\n \"vendorData\": \"business_12345\",\n \"meta\": {\n \"applicationId\": \"app_67890\"\n },\n \"campaignId\": \"cmp_64ff2f3f4f31d4d5f2ab1234\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://server.heliumid.io/api/v1/company-verifications")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vendorData\": \"business_12345\",\n \"meta\": {\n \"applicationId\": \"app_67890\"\n },\n \"campaignId\": \"cmp_64ff2f3f4f31d4d5f2ab1234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.heliumid.io/api/v1/company-verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vendorData\": \"business_12345\",\n \"meta\": {\n \"applicationId\": \"app_67890\"\n },\n \"campaignId\": \"cmp_64ff2f3f4f31d4d5f2ab1234\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Created company verification",
"data": {
"link": "https://verify.heliumid.io/company?processId=69d4f7657bcbe3b58b96b2f7&hostedToken=eyJleGFtcGxlIjoidG9rZW4ifQ",
"verificationId": "cv_0b5f6f4e0aab25d8c130ab21",
"campaignId": "cmp_64ff2f3f4f31d4d5f2ab1234",
"campaignVersion": 3,
"expiresAt": "2026-08-25T12:00:00.000Z"
},
"code": 200
}{
"status": false,
"message": "Verification not found or has been deleted",
"code": 400
}{
"status": false,
"message": "Unauthorized",
"code": 401
}Authorizations
Your Helium ID API key.
Body
application/json