HLID API / DEVELOPERS
Powerful infrastructure.
Simple integration.
Built for developers. Ready for scale.
Integrate identity verification directly into your applications, websites and business workflows. Flexible APIs, clear documentation and developer-friendly integration tools.
- REST
- WEBHOOKS
- SANDBOX
const verification = await heliumid.verifications.create({
type: "individual",
checks: ["document", "biometric", "liveness"],
reference: "CUSTOMER_001"
});{
"id": "ver_HL082941X",
"status": "pending"
}01 / QUICK START
Your first verification
in a few lines.
Create a verification request, send your customer the hosted link and receive a webhook when the checks complete.
Everything your developers need
- RESTful verification APIs
- SDKs and integration tools
- Custom verification workflows
- Real-time verification responses
- Webhooks and event notifications
- Sandbox testing environment
Illustrative SDK syntax. Final examples match the published HeliumID API.
import HeliumID from "@heliumid/sdk";
const heliumid = new HeliumID(process.env.HLID_API_KEY);
// Create an identity verification request
const verification = await heliumid.verifications.create({
type: "individual",
checks: ["document", "biometric", "liveness"],
reference: "CUSTOMER_001",
webhook: "https://example.com/hooks/heliumid"
});
console.log(verification.link);{
"id": "ver_HL082941X",
"status": "pending",
"reference": "CUSTOMER_001",
"link": "https://verify.heliumid.io/s/HL082941X",
"expires_at": "2026-10-23T10:00:00Z"
}02 / BUILDING BLOCKS
Compose the verification
your product needs.
Verifications
Create individual or business verification requests with the checks you need.
Hosted Flow
Send customers to a guided, mobile-friendly experience on any device.
Webhooks
Receive events as checks complete, cases are reviewed and results are final.
Results
Fetch outcomes, extracted data and supporting information when you need them.
Sandbox
Test end to end with synthetic documents and deterministic outcomes.
Documentation
Reference, guides and examples kept in step with the published API.
03 / FAQ
Developer questions.
01Do I need the SDK?
No. The HLID API is a plain REST API. SDKs are a convenience for common languages.
02How do I test without real documents?
Use the sandbox environment. It accepts synthetic documents and returns deterministic outcomes so you can exercise every path.
03How are results delivered?
Poll the verification resource or subscribe to webhooks. Webhook deliveries are signed so you can verify their origin.
04Can I customise the checks?
Yes. Choose the information, documents and checks per request, or save a workflow and reference it.