7.3.6. Biometrics¶

Get the OpenAPI file for this interface: abis.yaml

7.3.6.1. Services¶

7.3.6.1.1. CRUD¶

POST /v1/persons¶

Create one encounter and generate ID for both the person and the encounter

Scope required: abis.encounter.write

Query Parameters:
	transactionId (string) – The id of the transaction (Required) 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 – Operation successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned. 400 Bad Request – Bad request 403 Forbidden – Operation not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/persons?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

{
    "encounterId": "string",
    "status": "ACTIVE",
    "encounterType": "string",
    "galleries": [
        "string"
    ],
    "clientData": "c3RyaW5n",
    "contextualData": {
        "date": "2019-01-11"
    },
    "biographicData": {
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "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

{
    "personId": "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: createResponse

POST ${request.query.callback}¶

Create one encounter and generate both IDs 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

{
    "personId": "string",
    "encounterId": "string"
}

Example request:

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

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

Example response:

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

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

POST /v1/persons/{personId}/encounters¶

Create one encounter and generate its ID

Create one encounter in the person identified by his/her id. If the person does not yet exist, it is created automatically.

Scope required: abis.encounter.write

Query Parameters:
Parameters:	personId (string) – the id of the person
	transactionId (string) – The id of the transaction (Required) 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 – creation successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned 400 Bad Request – Bad request 403 Forbidden – Creation not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/persons/{personId}/encounters?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

{
    "encounterId": "string",
    "status": "ACTIVE",
    "encounterType": "string",
    "galleries": [
        "string"
    ],
    "clientData": "c3RyaW5n",
    "contextualData": {
        "date": "2019-01-11"
    },
    "biographicData": {
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "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

{
    "personId": "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: createResponse

POST ${request.query.callback}¶

Create one encounter and generate its ID 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

{
    "personId": "string",
    "encounterId": "string"
}

Example request:

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

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

Example response:

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

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

GET /v1/persons/{personId}/encounters¶

Read all encounters of one person

Scope required: abis.encounter.read

Query Parameters:
Parameters:	personId (string) – the id of the person
	transactionId (string) – The id of the transaction (Required) 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 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/persons/{personId}/encounters?transactionId=string HTTP/1.1
Host: example.com
Authorization: Bearer cn389ncoiwuencr

Example response:

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

[
    {
        "encounterId": "string",
        "status": "ACTIVE",
        "encounterType": "string",
        "galleries": [
            "string"
        ],
        "clientData": "c3RyaW5n",
        "contextualData": {
            "date": "2019-01-11"
        },
        "biographicData": {
            "dateOfBirth": "1985-11-30",
            "gender": "M",
            "nationality": "FRA"
        },
        "biometricData": [
            {
                "biometricType": "FACE",
                "biometricSubType": "UNKNOWN",
                "image": "c3RyaW5n",
                "imageRef": "https://example.com",
                "captureDate": "2020-07-01",
                "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: readAllResponse

POST ${request.query.callback}¶

Read all encounters 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

[
    {
        "encounterId": "string",
        "status": "ACTIVE",
        "encounterType": "string",
        "galleries": [
            "string"
        ],
        "clientData": "c3RyaW5n",
        "contextualData": {
            "date": "2019-01-11"
        },
        "biographicData": {
            "dateOfBirth": "1985-11-30",
            "gender": "M",
            "nationality": "FRA"
        },
        "biometricData": [
            {
                "biometricType": "FACE",
                "biometricSubType": "UNKNOWN",
                "image": "c3RyaW5n",
                "imageRef": "https://example.com",
                "captureDate": "2020-07-01",
                "captureDevice": "string",
                "impressionType": "LIVE_SCAN_PLAIN",
                "width": 1,
                "height": 1,
                "bitdepth": 1,
                "resolution": 1,
                "compression": "NONE"
            }
        ]
    }
]

Example request:

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

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

Example response:

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

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

POST /v1/persons/{personId}/encounters/{encounterId}¶

Create one encounter

Create one encounter in the person identified by his/her id. If the person does not yet exist, it is created automatically.

If the encounter already exists, an error 403 is returned.

Scope required: abis.encounter.write

Query Parameters:
Parameters:	personId (string) – the id of the person encounterId (string) – the id of the encounter
	transactionId (string) – The id of the transaction (Required) 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 – Creation successful 202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned 400 Bad Request – Bad request 403 Forbidden – Creation not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/persons/{personId}/encounters/{encounterId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

{
    "encounterId": "string",
    "status": "ACTIVE",
    "encounterType": "string",
    "galleries": [
        "string"
    ],
    "clientData": "c3RyaW5n",
    "contextualData": {
        "date": "2019-01-11"
    },
    "biographicData": {
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "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: createResponse

POST ${request.query.callback}¶

Create one encounter 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

{
    "personId": "string",
    "encounterId": "string"
}

Example request:

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

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

Example response:

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

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

GET /v1/persons/{personId}/encounters/{encounterId}¶

Read one encounter

Scope required: abis.encounter.read

Query Parameters:
Parameters:	personId (string) – the id of the person encounterId (string) – the id of the encounter
	transactionId (string) – The id of the transaction (Required) 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 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/persons/{personId}/encounters/{encounterId}?transactionId=string HTTP/1.1
Host: example.com
Authorization: Bearer cn389ncoiwuencr

Example response:

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

{
    "encounterId": "string",
    "status": "ACTIVE",
    "encounterType": "string",
    "galleries": [
        "string"
    ],
    "clientData": "c3RyaW5n",
    "contextualData": {
        "date": "2019-01-11"
    },
    "biographicData": {
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "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}¶

Read one encounter 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

{
    "encounterId": "string",
    "status": "ACTIVE",
    "encounterType": "string",
    "galleries": [
        "string"
    ],
    "clientData": "c3RyaW5n",
    "contextualData": {
        "date": "2019-01-11"
    },
    "biographicData": {
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "resolution": 1,
            "compression": "NONE"
        }
    ]
}

Example request:

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

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

Example response:

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

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

PUT /v1/persons/{personId}/encounters/{encounterId}¶

Update one encounter

Scope required: abis.encounter.write

Query Parameters:
Parameters:	personId (string) – the id of the person encounterId (string) – the id of the encounter
	transactionId (string) – The id of the transaction (Required) 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 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/persons/{personId}/encounters/{encounterId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

{
    "encounterId": "string",
    "status": "ACTIVE",
    "encounterType": "string",
    "galleries": [
        "string"
    ],
    "clientData": "c3RyaW5n",
    "contextualData": {
        "date": "2019-01-11"
    },
    "biographicData": {
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "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}¶

Update one encounter 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 request:

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

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

Example response:

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

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

DELETE /v1/persons/{personId}/encounters/{encounterId}¶

Delete one encounter

Delete one encounter from the person identified by his/her id. If this is the last encounter in the person, the person is also deleted.

Scope required: abis.encounter.write

Query Parameters:
Parameters:	personId (string) – the id of the person encounterId (string) – the id of the encounter
	transactionId (string) – The id of the transaction (Required) 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 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}¶

Delete one encounter 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 request:

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

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

Example response:

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

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

POST /v1/persons/{personIdTarget}/merge/{personIdSource}¶

Merge two sets of encounters

Merge two sets of encounters into a single set. Merging a set of N encounters with a set of M encounters will result in a single set of N+M encounters. Encounter ID are preserved and in case of duplicates an error is returned and no changes are done.

Scope required: abis.encounter.write

Query Parameters:
Parameters:	personIdTarget (string) – the id of the person receiving new encounters personIdSource (string) – the id of the person giving the encounters
	transactionId (string) – The id of the transaction (Required) 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 204 No Content – Merge successful 400 Bad Request – Bad request 403 Forbidden – Merge 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: mergeResponse

POST ${request.query.callback}¶

Merge two persons 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 request:

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

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

Example response:

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

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

PUT /persons/{personId}/encounters/{encounterId}/status¶

Update status of an encounter

Scope required: abis.encounter.write

Query Parameters:
Parameters:	personId (string) – the id of the person encounterId (string) – the id of the encounter
	status (string) – New status of encounter (Required) transactionId (string) – The id of the transaction (Required) callback (string) – the callback address, where the result will be sent when available
Status Codes:	202 Accepted – Request received successfully and correct, result will be returned through the callback. The transaction ID is returned 204 No Content – Status has been updated 400 Bad Request – Bad request 403 Forbidden – Encounter status update not allowed 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: updateEncounterStatusResponse

POST ${request.query.callback}¶

Update encounter status 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 request:

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

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

Example response:

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

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

GET /v1/persons/{personId}/encounters/{encounterId}/templates¶

Read biometrics templates

Scope required: abis.encounter.read

Query Parameters:
Parameters:	personId (string) – the id of the person 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 (Required) 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 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/persons/{personId}/encounters/{encounterId}/templates?transactionId=string HTTP/1.1
Host: example.com
Authorization: Bearer cn389ncoiwuencr

Example response:

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

[
    {
        "biometricType": "FACE",
        "biometricSubType": "UNKNOWN",
        "template": "c3RyaW5n",
        "templateFormat": "string",
        "quality": 1,
        "qualityFormat": "string",
        "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: readTemplateResponse

POST ${request.query.callback}¶

Read biometrics templates 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": "string",
        "quality": 1,
        "qualityFormat": "string",
        "vendor": "string",
        "algorithm": "string"
    }
]

Example request:

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

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

Example response:

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

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

DELETE /v1/persons/{personId}¶

Delete a person and all its encounters

Scope required: abis.encounter.write

Query Parameters:
Parameters:	personId (string) – the id of the person
	transactionId (string) – The id of the transaction (Required) 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 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}¶

Delete a person 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 request:

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

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

Example response:

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

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

7.3.6.1.2. Search¶

POST /v1/identify/{galleryId}¶

Biometric identification

Identification based on biometric data from one gallery

Scope required: abis.identify

Query Parameters:
Parameters:	galleryId (string) – the id of the gallery
	transactionId (string) – The id of the transaction (Required) 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 400 Bad Request – Bad request 403 Forbidden – Identification not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/identify/{galleryId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

{
    "filter": {
        "dateOfBirthMin": "1980-01-01",
        "dateOfBirthMax": "2019-12-31"
    },
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "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

[
    {
        "personId": "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}¶

Biometric 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

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

Example request:

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

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

Example response:

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

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

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

Biometric identification based on existing data

Identification based on existing data from one gallery

Scope required: abis.identify

Query Parameters:
Parameters:	galleryId (string) – the id of the gallery personId (string) – the id of the person
	transactionId (string) – The id of the transaction (Required) 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 400 Bad Request – Bad request 403 Forbidden – Identification not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/identify/{galleryId}/{personId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

{
    "dateOfBirthMin": "1980-01-01",
    "dateOfBirthMax": "2019-12-31"
}

Example response:

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

[
    {
        "personId": "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}¶

Biometric identification based on existing data 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

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

Example request:

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

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

Example response:

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

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

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

Biometric verification

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

Scope required: abis.verify

Query Parameters:
Parameters:	galleryId (string) – the id of the gallery personId (string) – the id of the person
	transactionId (string) – The id of the transaction (Required) 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 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}/{personId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

{
    "biometricData": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "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}¶

Biometric 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 request:

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

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

Example response:

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

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

POST /v1/verify¶

Biometric verification with two sets of data

Verification of two sets of biometric data

Scope required: abis.verify

Query Parameters:
	transactionId (string) – The id of the transaction (Required) 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 400 Bad Request – Bad request 403 Forbidden – Verification not allowed 500 Internal Server Error – Unexpected error

Example request:

POST /v1/verify?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json
Authorization: Bearer cn389ncoiwuencr

{
    "biometricData1": [
        {
            "biometricType": "FACE",
            "biometricSubType": "UNKNOWN",
            "image": "c3RyaW5n",
            "imageRef": "https://example.com",
            "captureDate": "2020-07-01",
            "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": "2020-07-01",
            "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}¶

Biometric verification with two sets of data 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 request:

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

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

Example response:

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

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

7.3.6.1.3. Gallery¶

GET /v1/galleries¶

Read the ID of all the galleries

Scope required: abis.gallery.read

Query Parameters:
	transactionId (string) – The id of the transaction (Required) 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 400 Bad Request – Bad request 403 Forbidden – Read not allowed 500 Internal Server Error – Unexpected error

Example request:

GET /v1/galleries?transactionId=string HTTP/1.1
Host: example.com
Authorization: Bearer cn389ncoiwuencr

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: readGalleriesResponse

POST ${request.query.callback}¶

Read the ID of all the galleries 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 request:

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

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

Example response:

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

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

GET /v1/galleries/{galleryId}¶

Read the content of one gallery

Scope required: abis.gallery.read

Query Parameters:
Parameters:	galleryId (string) – the id of the gallery
	transactionId (string) – The id of the transaction (Required) 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 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}?transactionId=string HTTP/1.1
Host: example.com
Authorization: Bearer cn389ncoiwuencr

Example response:

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

[
    {
        "personId": "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: readGalleryContentResponse

POST ${request.query.callback}¶

Read the content of one gallery 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

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

Example request:

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

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

Example response:

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

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

7.3.6.2. Data Model¶

To be completed

7.3.6. Biometrics¶

7.3.6.1. Services¶

7.3.6.1.1. CRUD¶

7.3.6.1.2. Search¶

7.3.6.1.3. Gallery¶

7.3.6.2. Data Model¶

Navigation

Related Topics