Quick Start

2. Get your API key

In order to authenticate requests you need to supply your API key. You can retrieve your API key from your Account Management page.

3. Enrol a subject

Once you've got your API key the next step is to enrol a subject which will generate a facial recognition record for them. In the POST request below you need to replace your_api_key with the key from Step 2.

curl 
    --data @usermodel.json 
    --compressed 
    -H "Content-Type: application/json" 
    -H "ApiKey: your_api_key" 
    -X POST https://www.qikface.com/api/biometricface/enrol

The format for the JSON data needed in the POST request is here. A minimal example is shown below. Note that the "Photos" field is an array which allows multiple photos to be provided. At least one photo must be suppleid and up to 3 will be accepted.

{
    "Name": "JaneD",
    "Photos": [base64Photo1]
}

The response to the subject enrolment is a GUID string representing the ID of the successfully enrolled Subject. The ID field is required when the Subject needs to be verified.

4. Verify a subject

Once a subject has been successfully enrolled you can do a test verification. A verification is where a photo is tested for the confidence that it matches a specific subject.

curl 
    --data @verify.json 
    --compressed 
    -H "Content-Type: application/json" 
    -H "ApiKey: your_api_key"  
    -X POST https://www.qikface.com/api/biometricface/verify

The format for the JSON data sent in the POST request is available here. A minimal example is shown below:

{
    "SubjectID": "196FCF79-C5AC-4601-816E-36C34C5CE8C4",
    "Photo": base64Photo
}

The response to the verify operation is a decimal number between 0 and 1.0 which indicates the confidence that the user is a match. The higher the number the greater the confidence, i.e. a result of 0.99 indicates a very high confidence whereas a result of 0.10 indicates a very low confidence.

5. Identify a subject

An identification is where a photo is matched against multiple subjects in a population and the top N matching subjects are returned.

curl 
    --data @identify.json 
    --compressed 
    -H "Content-Type: application/json" 
    -H "ApiKey: your_api_key"  
    -X POST https://www.qikface.com/api/biometricface/identify

The format for the JSON data sent in the POST request is available here. A minimal example is shown below. The Photo is a required parameter and is a base 64 encoded photo of the Subject for the facial recognition identify. The Confidence parameter is a value between 0 and 1.0 that indicates the confidence threshold at which a match will be included in the results. Count is the maximum number of matches that will be returned.

{
    "Confidence": 0.85,
    "Count": 3,
    "Photo": base64Photo
}

The response to the identify operation is a list of key value pairs with the key being the SubjectID and the value being the score at which that Subject macthed the photo. An example repsonse is shown below.

{ 
{"9775327b-a131-4b4b-ab98-b56ff397e485":0.969501555},
{"2c586ae9-f278-40ad-9da5-289bd094e346":0.8612}
}