7.3.4. Biometrics¶

Download the OpenAPI file for this interface abis.yaml.

7.3.4.1. Services¶

7.3.4.1.1. CRUD¶

GET /v1/subjects/{subjectId}/{encounterId}/templates¶

Get biometrics templates

Query Parameters:
Parameters:	subjectId (string) – the id of the subject encounterId (string) – the id of the encounter
	biometricType (string) – the type of biometrics to return biometricSubType (string) – the sub-type of biometrics to return templateFormat (string) – the format of the template to return qualityFormat (string) – the format of the quality to return transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority
Status Codes:	200 OK – Operation successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 400 Bad Request – Bad request 403 Forbidden – Read not allowed 404 Not Found – Unknown record or unkown biometrics 500 Internal Server Error – Unexpected error

Example request:

GET /v1/subjects/{subjectId}/{encounterId}/templates HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "biometricType": "FACE",
        "biometricSubType": "UNKNOWN",
        "template": "c3RyaW5n",
        "templateFormat": "ISO_19794_2",
        "quality": 1,
        "qualityFormat": "ISO_19794",
        "vendor": "string",
        "algorithm": "string"
    }
]

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: getTemplateResponse

POST ${request.query.callback}¶

Response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

[
    {
        "biometricType": "FACE",
        "biometricSubType": "UNKNOWN",
        "template": "c3RyaW5n",
        "templateFormat": "ISO_19794_2",
        "quality": 1,
        "qualityFormat": "ISO_19794",
        "vendor": "string",
        "algorithm": "string"
    }
]

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

POST /v1/subjects/{subjectId}/{encounterId}¶

Insert one encounter

Query Parameters:
Parameters:	subjectId (string) – the id of the subject encounterId (string) – the id of the encounter
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority algorithm (string) – Hint about the algorithm to be used
Status Codes:	201 Created – Insertion successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 400 Bad Request – Bad request 403 Forbidden – Insertion not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/subjects/{subjectId}/{encounterId} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "galleries": [
        "string"
    ],
    "encounter": [
        {
            "encounterType": "string",
            "clientData": "c3RyaW5n",
            "contextualData": {
                "date": "2019-05-21"
            },
            "biographicData": {
                "dateOfBirth": "2019-05-21",
                "gender": "M",
                "nationality": "string"
            },
            "biometricData": [
                {
                    "biometricType": "FACE",
                    "biometricSubType": "UNKNOWN",
                    "image": "c3RyaW5n",
                    "imageRef": "https://example.com",
                    "captureDate": "2019-05-21",
                    "captureDevice": "string",
                    "impressionType": "LIVE_SCAN_PLAIN",
                    "width": 1,
                    "height": 1,
                    "bitdepth": 1,
                    "resolution": 1,
                    "compression": "NONE"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: insertResponse

POST ${request.query.callback}¶

Response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "status": "OK",
    "subjectId": "string",
    "encounterId": "string"
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

GET /v1/subjects/{subjectId}/{encounterId}¶

Read one encounter

Query Parameters:
Parameters:	subjectId (string) – the id of the subject encounterId (string) – the id of the encounter
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority
Status Codes:	200 OK – Read successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 400 Bad Request – Bad request 403 Forbidden – Read not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example request:

GET /v1/subjects/{subjectId}/{encounterId} HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "galleries": [
        "string"
    ],
    "encounter": {
        "encounterType": "string",
        "clientData": "c3RyaW5n",
        "contextualData": {
            "date": "2019-05-21"
        },
        "biographicData": {
            "dateOfBirth": "2019-05-21",
            "gender": "M",
            "nationality": "string"
        },
        "biometricData": [
            {
                "biometricType": "FACE",
                "biometricSubType": "UNKNOWN",
                "image": "c3RyaW5n",
                "imageRef": "https://example.com",
                "captureDate": "2019-05-21",
                "captureDevice": "string",
                "impressionType": "LIVE_SCAN_PLAIN",
                "width": 1,
                "height": 1,
                "bitdepth": 1,
                "resolution": 1,
                "compression": "NONE"
            }
        ]
    }
}

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: readResponse

POST ${request.query.callback}¶

Response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "galleries": [
        "string"
    ],
    "encounter": {
        "encounterType": "string",
        "clientData": "c3RyaW5n",
        "contextualData": {
            "date": "2019-05-21"
        },
        "biographicData": {
            "dateOfBirth": "2019-05-21",
            "gender": "M",
            "nationality": "string"
        },
        "biometricData": [
            {
                "biometricType": "FACE",
                "biometricSubType": "UNKNOWN",
                "image": "c3RyaW5n",
                "imageRef": "https://example.com",
                "captureDate": "2019-05-21",
                "captureDevice": "string",
                "impressionType": "LIVE_SCAN_PLAIN",
                "width": 1,
                "height": 1,
                "bitdepth": 1,
                "resolution": 1,
                "compression": "NONE"
            }
        ]
    }
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

PUT /v1/subjects/{subjectId}/{encounterId}¶

Update one encounter

Query Parameters:
Parameters:	subjectId (string) – the id of the subject encounterId (string) – the id of the encounter
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority algorithm (string) – Hint about the algorithm to be used
Status Codes:	202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 204 No Content – Update successful 400 Bad Request – Bad request 403 Forbidden – Update not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example request:

PUT /v1/subjects/{subjectId}/{encounterId} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "galleries": [
        "string"
    ],
    "encounter": [
        {
            "encounterType": "string",
            "clientData": "c3RyaW5n",
            "contextualData": {
                "date": "2019-05-21"
            },
            "biographicData": {
                "dateOfBirth": "2019-05-21",
                "gender": "M",
                "nationality": "string"
            },
            "biometricData": [
                {
                    "biometricType": "FACE",
                    "biometricSubType": "UNKNOWN",
                    "image": "c3RyaW5n",
                    "imageRef": "https://example.com",
                    "captureDate": "2019-05-21",
                    "captureDevice": "string",
                    "impressionType": "LIVE_SCAN_PLAIN",
                    "width": 1,
                    "height": 1,
                    "bitdepth": 1,
                    "resolution": 1,
                    "compression": "NONE"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: updateResponse

POST ${request.query.callback}¶

Response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

"OK"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

DELETE /v1/subjects/{subjectId}/{encounterId}¶

Delete one encounter

Query Parameters:
Parameters:	subjectId (string) – the id of the subject encounterId (string) – the id of the encounter
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority
Status Codes:	202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 204 No Content – Delete successful 400 Bad Request – Bad request 403 Forbidden – Delete not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: deleteResponse

POST ${request.query.callback}¶

Response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

"OK"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

POST /v1/subjects¶

Insert one encounter and generate ID for both the subject and the encounter

Query Parameters:
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority algorithm (string) – Hint about the algorithm to be used
Status Codes:	200 OK – Insertion successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 400 Bad Request – Bad request 403 Forbidden – Insertion not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/subjects HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "galleries": [
        "string"
    ],
    "encounter": [
        {
            "encounterType": "string",
            "clientData": "c3RyaW5n",
            "contextualData": {
                "date": "2019-05-21"
            },
            "biographicData": {
                "dateOfBirth": "2019-05-21",
                "gender": "M",
                "nationality": "string"
            },
            "biometricData": [
                {
                    "biometricType": "FACE",
                    "biometricSubType": "UNKNOWN",
                    "image": "c3RyaW5n",
                    "imageRef": "https://example.com",
                    "captureDate": "2019-05-21",
                    "captureDevice": "string",
                    "impressionType": "LIVE_SCAN_PLAIN",
                    "width": 1,
                    "height": 1,
                    "bitdepth": 1,
                    "resolution": 1,
                    "compression": "NONE"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "OK",
    "subjectId": "string",
    "encounterId": "string"
}

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: insertResponse

POST ${request.query.callback}¶

Response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "status": "OK",
    "subjectId": "string",
    "encounterId": "string"
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

POST /v1/subjects/{subjectId}¶

Insert one encounter and generate its ID

Query Parameters:
Parameters:	subjectId (string) – the id of the subject
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority algorithm (string) – Hint about the algorithm to be used
Status Codes:	200 OK – Insertion successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 400 Bad Request – Bad request 403 Forbidden – Insertion not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/subjects/{subjectId} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "galleries": [
        "string"
    ],
    "encounter": [
        {
            "encounterType": "string",
            "clientData": "c3RyaW5n",
            "contextualData": {
                "date": "2019-05-21"
            },
            "biographicData": {
                "dateOfBirth": "2019-05-21",
                "gender": "M",
                "nationality": "string"
            },
            "biometricData": [
                {
                    "biometricType": "FACE",
                    "biometricSubType": "UNKNOWN",
                    "image": "c3RyaW5n",
                    "imageRef": "https://example.com",
                    "captureDate": "2019-05-21",
                    "captureDevice": "string",
                    "impressionType": "LIVE_SCAN_PLAIN",
                    "width": 1,
                    "height": 1,
                    "bitdepth": 1,
                    "resolution": 1,
                    "compression": "NONE"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "OK",
    "subjectId": "string",
    "encounterId": "string"
}

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: insertResponse

POST ${request.query.callback}¶

Response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "status": "OK",
    "subjectId": "string",
    "encounterId": "string"
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

DELETE /v1/subjects/{subjectId}¶

Delete a subject and all its encounters

Query Parameters:
Parameters:	subjectId (string) – the id of the subject
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority
Status Codes:	202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 204 No Content – Delete successful 400 Bad Request – Bad request 403 Forbidden – Delete not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: deleteResponse

POST ${request.query.callback}¶

Response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

"OK"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

7.3.4.1.2. Gallery¶

GET /v1/galleries¶

Get the ID of all the galleries

Query Parameters:
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority
Status Codes:	200 OK – Operation successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 400 Bad Request – Bad request 403 Forbidden – Read not allowed 500 Internal Server Error – Unexpected error

Example request:

GET /v1/galleries HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    "string"
]

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: getGalleriesResponse

POST ${request.query.callback}¶

Response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

[
    "string"
]

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

GET /v1/galleries/{galleryId}¶

Get the content of one gallery

Query Parameters:
Parameters:	galleryId (string) – the id of the gallery
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority
Status Codes:	200 OK – Operation successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 400 Bad Request – Bad request 403 Forbidden – Read not allowed 404 Not Found – Unknown record 500 Internal Server Error – Unexpected error

Example request:

GET /v1/galleries/{galleryId} HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "subjectId": "string",
        "encounterId": "string"
    }
]

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: getGalleryContentResponse

POST ${request.query.callback}¶

Response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

[
    {
        "subjectId": "string",
        "encounterId": "string"
    }
]

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

7.3.4.1.3. Search¶

POST /v1/identify/{galleryId}¶

Biometric identification

Identification based on biometric data from one gallery

Query Parameters:
Parameters:	galleryId (string) – the id of the gallery
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority maxNbCand (integer) – the maximum number of candidates threshold (number) – the algorithm threshold accuracyLevel (string) – the accuracy level expected for this request
Status Codes:	200 OK – Request executed. Identification result is returned. 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 400 Bad Request – Bad request 403 Forbidden – Identification not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/identify/{galleryId} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "filter": {
        "dateOfBirthMin": "2019-05-21",
        "dateOfBirthMax": "2019-05-21"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2019-05-21",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "resolution": 1,
            "compression": "NONE"
        }
    ]
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "subjectId": "string",
        "rank": 1,
        "score": 1.0,
        "scoreList": [
            {
                "score": 1.0,
                "encounterId": "string",
                "biometricType": "FACE",
                "biometricSubType": "UNKNOWN"
            }
        ]
    }
]

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: identifyResponse

POST ${request.query.callback}¶

Identification response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

[
    {
        "subjectId": "string",
        "rank": 1,
        "score": 1.0,
        "scoreList": [
            {
                "score": 1.0,
                "encounterId": "string",
                "biometricType": "FACE",
                "biometricSubType": "UNKNOWN"
            }
        ]
    }
]

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

POST /v1/identify/{galleryId}/{subjectId}¶

Biometric identification

Identification based on existing data from one gallery

Query Parameters:
Parameters:	galleryId (string) – the id of the gallery subjectId (string) – the id of the subject
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority maxNbCand (integer) – the maximum number of candidates threshold (number) – the algorithm threshold accuracyLevel (string) – the accuracy level expected for this request
Status Codes:	200 OK – Request executed. Identification result is returned. 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 400 Bad Request – Bad request 403 Forbidden – Identification not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/identify/{galleryId}/{subjectId} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dateOfBirthMin": "2019-05-21",
    "dateOfBirthMax": "2019-05-21"
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "subjectId": "string",
        "rank": 1,
        "score": 1.0,
        "scoreList": [
            {
                "score": 1.0,
                "encounterId": "string",
                "biometricType": "FACE",
                "biometricSubType": "UNKNOWN"
            }
        ]
    }
]

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: identifyResponse

POST ${request.query.callback}¶

Identification response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

[
    {
        "subjectId": "string",
        "rank": 1,
        "score": 1.0,
        "scoreList": [
            {
                "score": 1.0,
                "encounterId": "string",
                "biometricType": "FACE",
                "biometricSubType": "UNKNOWN"
            }
        ]
    }
]

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

POST /v1/verify/{galleryId}/{subjectId}¶

Biometric verification

Verification of one set of biometric data and a record in the system

Query Parameters:
Parameters:	galleryId (string) – the id of the gallery subjectId (string) – the id of the subject
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority threshold (number) – the algorithm threshold accuracyLevel (string) – the accuracy level expected for this request
Status Codes:	200 OK – Verification execution successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 400 Bad Request – Bad request 404 Not Found – Unknown record 403 Forbidden – Verification not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/verify/{galleryId}/{subjectId} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2019-05-21",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "resolution": 1,
            "compression": "NONE"
        }
    ]
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "decision": true,
    "scores": [
        {
            "score": 1.0,
            "encounterId": "string",
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN"
        }
    ]
}

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: verifyResponse

POST ${request.query.callback}¶

Verification response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "decision": true,
    "scores": [
        {
            "score": 1.0,
            "encounterId": "string",
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN"
        }
    ]
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

POST /v1/verify¶

Biometric verification

Verification of two sets of biometric data

Query Parameters:
	transactionId (string) – The id of the transaction callback (string) – the callback address, where the result will be sent when available priority (integer) – the request priority threshold (number) – the algorithm threshold accuracyLevel (string) – the accuracy level expected for this request
Status Codes:	200 OK – Verification execution successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned (if no transaction ID was provided, one is generated by the server) 400 Bad Request – Bad request 403 Forbidden – Verification not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/verify HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "biometricData1": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2019-05-21",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "resolution": 1,
            "compression": "NONE"
        }
    ],
    "biometricData2": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2019-05-21",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "resolution": 1,
            "compression": "NONE"
        }
    ]
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "decision": true,
    "scores": [
        {
            "score": 1.0,
            "encounterId": "string",
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN"
        }
    ]
}

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

"123e4567-e89b-12d3-a456-426655440000"

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Callback: verifyResponse

POST ${request.query.callback}¶

Verification response callback

Query Parameters:
	transactionId (string) – The id of the transaction (Required)
Status Codes:	204 No Content – Response is received and accepted. 403 Forbidden – Forbidden access to the service 500 Internal Server Error – Unexpected error

Example request:

POST ${request.query.callback}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "decision": true,
    "scores": [
        {
            "score": 1.0,
            "encounterId": "string",
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN"
        }
    ]
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

7.3.4.2. Data Model¶

To be completed

7.3.4. Biometrics¶

7.3.4.1. Services¶

7.3.4.1.1. CRUD¶

7.3.4.1.2. Gallery¶

7.3.4.1.3. Search¶

7.3.4.2. Data Model¶

Navigation

Related Topics