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

Introduction

Service Request Timeout#

An ID Check Service request will expire after 12 hours of inactivity when the Service request will automatically be archived - the Subscriber Service will then receive the following response:
{
    "status":false,
    "code":"006",
    "message":"QiD API Service request expired",
    "webid_key":"66a3-6f8c-9011-b737-8799-07rs", // The webid_key returned at the request initiation.
    "mode":1 // 1 = Production, 0 = Sandbox. Will be calculated based on your sandbox IP address
}
If the default timeout does not happen to give your End-Users sufficient time to respond to an ID Check request, please request the time limit to be extended by contacting us by email at support@IDaaS.bio

End-User Aborting The Process#

End-Users are able to abort the ID Check process either explicitly or by simply closing the browser window - the Subscriber Service will then receive the following response:
{
    "status":false,
    "code":"010",
    "message":"User abandoned QiD Service request during '3D selfie' capture process",
    "webid_key":"66ab-54b2-9e72-b259-7177-87no",
    "mode":1 // 1 = Production, 0 = Sandbox. Will be calculated based on your sandbox IP address
}

End-User Aborting The Process after capture timeout#

End-Users are able to abort the ID Check process after the capture timeout - the Subscriber Service will then receive the following response:
{
    "status":false,
    "code":"011",
    "message":"User abandoned QiD Service request during \'3D selfie\' capture timeout",
    "webid_key":"66ab-54b2-9e72-b259-7177-87no",
    "mode":1 // 1 = Production, 0 = Sandbox. Will be calculated based on your sandbox IP address
}
You can find the list of error codes in the error code section.

Successful ID check#

Upon completion of a successful request - the Subscriber Service will then receive the following response:
{
    "status":true,
    "webid_key":"66af-2613-df8d-5614-6392-16ab",
    "mode":1, // 1 = Production, 0 = Sandbox. Will be calculated based on your sandbox IP address
    "code":"101",
    "message":"QiD Service request successfully completed",
    "aidx_uuid":"66a9-b279-59ac-e312-6957-75bc" // aiDX unique id to identify an user
}
You can find the list of error codes in the error code section.
Note: For Webhooks, the Service will always respond with an http Status Code = '200'
Modified at 2024-08-05 12:46:09
Previous
Webhook
Built with