API Parameters

Security

The QiD Service complies with the highest international security standards and privacy regulations - to that end and to ensure that only authorised Principal Subscribers are able to issue a QiD Service request, the QiD Service makes use of a token-based authentication security protocol.

QiD API Request/Return Parameters

QiD Service requests are processed on a first-in-first-out (FIFO) basis

API Request Parameters:

subscriber_id: Used to identify the Primcipal Subscriber (Required)

metadata_list: Used to specify specific metadata details (Not required - Metadata IDs need to comma delimited as per the table below)

livecheck_id: Used to indicate if a liveness check is to be performed ('0' - No liveness check/'1' - Check liveness') (Not required - default: '0' - No liveness check)

mode_id: Used to indicate UX style ('0' - Light mode/'1' - Dark mode) (Not required - default: '0' - Light mode)

location_id: Used to indicate if GPS location coordinates need to be recorded ('0' = No location check/'1' - Check location) (Not required - default: '0' - No location check)

Note: Activating a particular QiD Service (enabled by setting the API request parameter to '1') may result in additional service fees being charged - please check before activating a particular QiD Service...

API Return Parameters (Success):

Code: Ref API Response Codes

webid_key: Unique 16-character code used as a primary key to identify the QiD Service request (eg: ‘wQaZgd98o77LlGgz’)

webid_url: Unique (tiny) url for the Subscriber App to use to launch an in-app aiDX web instance and used a secondary key to identify the QiD Service request (eg: ‘https://web.qid.bio/6GtRdjIG’)

Webhook Return Parameters (Success):

Code: Ref API Response Codes

webid_key: Unique 16-character code used as a primary key to identify the QiD Service request (eg: ‘wQaZgd98o77LlGgz’)

aidx_uuid: Unique user ID used as a primary key to identify the user (eg: ‘23bf11b3-391e-4a78-901c-a1e4573b272c’)

metadata: As requested by the Principal Subscriber

location: GPS location data ss requested by the Principal Subscriber in decimal degrees (DD) (eg: '32.40338 27.17403')

** API/Webhook Return Parameter (Fail)**:

Code: Ref API Response Codes

Metadata IDs

Request ID	Attribution/Emotion	Return Value
1	Gender	Value & Confidence %
2	Age Range	Age range - low & Age range - high
3	Beard	Boolean & Confidence %
4	Spectacles	Boolean & Confidence %
5	Eyes Open	Boolean & Confidence %
6	Face Mask	Boolean & Confidence %
7	Mouth Open	Boolean & Confidence %
8	Moustache	Boolean & Confidence %
9	Emotions	Values & Confidence %

API Response Codes

The QiD Service API will return one of the following Response Codes:

Code: 000

Return Value	Description
Type	Error
Description	Unknown error
Remedy	Contact support

Code: 001

Return Value	Description
Type	Error
Description	No Subscriber ID provided
Remedy	Provide a Subscriber ID

Code: 002

Return Value	Description
Type	Error
Description	Unknown Subscriber
Remedy	Contact support

Code: 003

Return Value	Description
Type	Error
Description	Inactive Subscriber
Remedy	Contact support

Code: 004

Return Value	Description
Type	Error
Description	Invalid IP address
Remedy	Initiate QiD Service request from a valid IP address

Code: 005

Return Value	Description
Type	Error
Description	‘Inactive IP address
Remedy	Initiate QiD Service request from a registered IP address

Code: 006

Return Value	Description
Type	Error
Description	QiD API Service request expired
Remedy	Re-initiate QiD Service request

Code: 007

Return Value	Description
Type	Error
Description	Invalid QiD Service request
Remedy	Re-initiate QiD Service request

Code: 008

Return Value	Description
Type	Error
Description	Incompatible capture device
Remedy	Mobile phone only

Code: 009

Return Value	Description
Type	Error
Description	Incompatible mobile browser
Remedy	Install a compatible browser

Code: 010

Return Value	Description
Type	Error
Description	User abandoned QiD Service request
Remedy	Re-initiate QiD Service request

Code: 011

Return Value	Description
Type	Error
Description	User failed to capture the ‘3D selfie’ within the allotted time
Remedy	Re-initiate QiD Service request

Code: 012

Return Value	Description
Type	Error
Description	User abandoned QiD Service request following ‘3D selfie’ capture timeout
Remedy	Re-initiate QiD Service request

Code: 013

Return Value	Description
Type	Error
Description	User abandoned QiD Service request during ‘3D selfie’ capture error - ’No Face'
Remedy	Re-initiate QiD Service request

Code: 014

Return Value	Description
Type	Error
Description	User abandoned QiD Service request following ‘3D selfie’ capture error - ’No Face’
Remedy	Re-initiate QiD Service request

Code: 015

Return Value	Description
Type	Error
Description	User abandoned QiD Service request during ‘3D selfie’ capture error - ’No Human Face'
Remedy	Re-initiate QiD Service request

Code: 016

Return Value	Description
Type	Notice
Description	User abandoned QiD Service request following ‘3D selfie’ capture error - ’No Human Face'
Remedy	Re-initiate QiD Service request

Code: 017

Return Value	Description
Type	Notice
Description	User abandoned QiD Service request during ‘3D selfie’ capture error - ’Too Dark'
Remedy	Re-initiate QiD Service request

Code: 018

Return Value	Description
Type	Error
Description	User abandoned QiD Service request following ‘3D selfie’ capture error - ’Too Dark'
Remedy	Re-initiate QiD Service request

Code: 019

Return Value	Description
Type	Error
Description	User abandoned QiD Service request during ‘3D selfie’ capture error - ’Too Bright'
Remedy	Re-initiate QiD Service request

Code: 020

Return Value	Description
Type	Error
Description	User abandoned QiD Service request following ‘3D selfie’ capture error - ’Too Bright'
Remedy	Re-initiate QiD Service request

Code: 021

Return Value	Description
Type	Error
Description	User abandoned QiD Service request during ‘3D selfie’ capture error - ’Sunglasses’
Remedy	Re-initiate QiD Service request

Code: 022

Return Value	Description
Type	Error
Description	User abandoned QiD Service request following ‘3D selfie’ capture error - ’Sunglasses'
Remedy	Re-initiate QiD Service request

Code: 023

Return Value	Description
Type	Error
Description	User abandoned QiD Service request during ‘3D selfie’ capture error - ’Blur’
Remedy	Re-initiate QiD Service request

Code: 024

Return Value	Description
Type	Error
Description	User abandoned QiD Service request following ‘3D selfie’ capture error - ’Blur’
Remedy	Re-initiate QiD Service request

Code: 025

Return Value	Description
Type	Error
Description	User abandoned QiD Service request during ‘3D selfie’ capture error - ’Bad Pose’
Remedy	Re-initiate QiD Service request

Code: 026

Return Value	Description
Type	Error
Description	User abandoned QiD Service request following ‘3D selfie’ capture error - ’Bad Pose’
Remedy	Re-initiate QiD Service request

Code: 027

Return Value	Description
Type	Error
Description	User abandoned QiD Service request during ‘3D selfie’ capture error - ’Bad Frame’
Remedy	Re-initiate QiD Service request

Code: 028

Return Value	Description
Type	Error
Description	User abandoned QiD Service request following ‘3D selfie’ capture error - ’Bad Frame’
Remedy	Re-initiate QiD Service request

Code: 029

Return Value	Description
Type	Error
Description	User liveness check failed
Remedy	Re-initiate QiD Service request

Code: 030

Return Value	Description
Type	Error
Description	Liveness check couldn't be completed
Remedy	Re-initiate QiD Service request

Code: 051

Return Value	Description
Type	Error
Description	Missing Webhook URL
Remedy	Contact support

Code: 052

Return Value	Description
Type	Error
Description	Invalid Webhook URL
Remedy	Contact support

Code: 053

Return Value	Description
Type	Error
Description	Invalid token
Remedy	Contact support

Code: 054

Return Value	Description
Type	Error
Description	Unable to generate a token
Remedy	Contact support

Code: 055

Return Value	Description
Type	Notice
Description	New token is generated successfully
Remedy	-

Code: 056

Return Value	Description
Type	Error
Description	Token has expired
Remedy	Either refresh the token or generate a new token

Code: 100

Return Value	Description
Type	Notice
Description	QiD Service request queued - awaiting response from User
Remedy	-

Code: 101

Return Value	Description
Type	Notice
Description	QiD Service request successfully completed
Remedy	-

Webhook URL

As all responses by the QiD Service are handled using Webhook URLs, please ensure that you set up a secure Webhook URL for sandbox and production...

API Parameters

Security#

QiD API Request/Return Parameters#

Metadata IDs#

API Response Codes#

Code: 000#

Code: 001#

Code: 002#

Code: 003#

Code: 004#

Code: 005#

Code: 006#

Code: 007#

Code: 008#

Code: 009#

Code: 010#

Code: 011#

Code: 012#

Code: 013#

Code: 014#

Code: 015#

Code: 016#

Code: 017#

Code: 018#

Code: 019#

Code: 020#

Code: 021#

Code: 022#

Code: 023#

Code: 024#

Code: 025#

Code: 026#

Code: 027#

Code: 028#

Code: 029#

Code: 030#

Code: 051#

Code: 052#

Code: 053#

Code: 054#

Code: 055#

Code: 056#

Code: 100#

Code: 101#

Webhook URL#

Security

QiD API Request/Return Parameters

Metadata IDs

API Response Codes

Code: 000

Code: 001

Code: 002

Code: 003

Code: 004

Code: 005

Code: 006

Code: 007

Code: 008

Code: 009

Code: 010

Code: 011

Code: 012

Code: 013

Code: 014

Code: 015

Code: 016

Code: 017

Code: 018

Code: 019

Code: 020

Code: 021

Code: 022

Code: 023

Code: 024

Code: 025

Code: 026

Code: 027

Code: 028

Code: 029

Code: 030

Code: 051

Code: 052

Code: 053

Code: 054

Code: 055

Code: 056

Code: 100

Code: 101

Webhook URL