Skip to main content
POST
/
v1
/
verifications
Create verification
curl --request POST \
  --url https://server.heliumid.io/api/v1/verifications \
  --header 'Content-Type: application/json' \
  --data '
{
  "vendorData": "test",
  "meta": {
    "key": "value"
  },
  "method": "auto"
}
'
{
  "status": true,
  "message": "Created verification",
  "data": {
    "link": "https://verify.heliumid.io/?processId=69d4f7657bcbe3b58b96b2f7",
    "verificationId": "69d4f7657bcbe3b58b96b2f7"
  },
  "code": 200
}

Headers

x-api-key
string

Body

application/json
vendorData
string
meta
object
method
enum<string>
default:auto

The verification method to use. 'auto' uses automated systems, 'manual' requires review by an Identity Specialist.

Available options:
auto,
manual

Response

200 - application/json

Create verification

status
boolean
message
string
data
object
code
integer