QiD
  1. API
QiD
  • Overview
  • API Parameters
  • API
    • Request a token
      POST
    • Refresh an existing token
      POST
    • Initiate a request
      POST
  • Webhook
    • Introduction
  1. API

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

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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: 1' \
--header 'livecheck_id: 1' \
--header 'location_id: 1'

Responses

🟢200OK
application/json
Body

Examples
{
    "status": false,
    "code": "056",
    "message": "Token is expired"
}
Modified at 2025-07-22 05:21:00
Previous
Refresh an existing token
Next
Webhook
Built with