Initiate a request

POST

/api/initiate

Initiate a request - please refer to the list of API response codes in the Insights section for the details...
Once you obtained an webid_url, please embed the webid_url in an iframe or webviewer. webid_key is the unique reference for each request.
The mode (production or sandbox) will be calculated based on domain/ip address from which we receive the request. Please contact support to setup the mode.

Note : You can pass a custom header webhook_url to receive the webhook callbacks. If nothing is specified, it uses the default webhook_url given during the subscriber setup. This option isn't available for production IP address.

Request

Header Params

Authorization

string

required

Bearer token, replace with your token

Example:

Bearer {{token}}

webhook_url

string

optional

A webhook url to receive the webhook callback during development mode

Example:

https://example.com/webhookdev

metadata

string

optional

Comma-separated values up to 9, each number represents an facial attribute. The webhook will return only the requested metadata attributes as specified in the metadata. default is 0, specifies no need to return any facial attribute values in webhook

Example:

'1,2,4,9'

mode_id

string

optional

Specifies the theme for the application, whether it should be loaded in light or dark mode. The default mode is Light. Possible values are LIGHT and DARK

Example:

DARK

livecheck_id

integer

optional

Handles the liveness check for the image. The default value is '0', which means liveness check is not performed by default.

Example:

location_id

integer

optional

If this is set to '1', geolocation is mandatory during the qid process. By default it is 0

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://qid.aiq.bio/api/initiate' \
--header 'Authorization: Bearer INJit2y7gkwXfUkTtzVUm3JZRxU46NOh658izrn7AtKTCXxsABXPzH1cifMpUEBAM70ASVZZ7TenLqc5qGkVyJrYTpBNXEtsWh15nDMbAg097NWgRVwOYf2hxGs0brc4qjqoitzgKTHxjp1OPFXK5Nk9i6j6IpAL6zOhgqpsvyVKenh0LgxpGKSE1tMJcw2eeHUjnNWcSUCLmOB7N7ZGZaLHe0mFrqAKc9V1XR3LlZrv07Rg' \
--header 'webhook_url: https://example.com/webhookdev' \
--header 'metadata: '\''1,2,4,9'\''' \
--header 'mode_id: DARK' \
--header 'livecheck_id: 1' \
--header 'location_id: 1'

Responses

🟢200OK

application/json

Body

status

boolean

required

Indicates whether the request is succesfully received or not

code

string

required

An error code or the success code

message

string

required

Detailed description of an error or a notice

webid_url

string

optional

The url to be used to perform the identity by an end-user. This will be available only if status is true

webid_key

string

optional

An unique 16bit string to identify the request for future reference (For example, with webhooks). This will be available only if status is true

Examples

FailureSuccess

{
    "status": false,
    "code": "056",
    "message": "Token is expired"
}

Modified at 2025-06-27 11:38:05

Refresh an existing token

Webhook