7.4. Enrollment

This is version 1.2.1 of this interface.

Get the OpenAPI file: enrollment.yaml

7.4.1. Services

7.4.1.1. Enrollment

POST /v1/enrollments/{enrollmentId}

Create one enrollment

Scope required: enroll.write

Parameters:
  • enrollmentId (string) – the id of the enrollment. Object of type string.

Query Parameters:
  • finalize (boolean) – Flag to indicate that data was collected (default is false). Object of type boolean.

  • transactionId (string) – The id of the transaction. Object of type string. (Required)

Form Parameters:
Status Codes:

Example request:

POST /v1/enrollments/string?finalize=true&transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "enrollmentType": "string",
    "enrollmentFlags": {
        "timeout": 3600,
        "other": "other",
        "...": "..."
    },
    "requestData": {
        "priority": 1,
        "requestType": "FIRST_ISSUANCE",
        "deliveryAddress": {
            "address1": "11 Rue des Rosiers",
            "city": "Libourne",
            "postalCode": "33500",
            "country": "France"
        },
        "...": "..."
    },
    "contextualData": {
        "enrollmentDate": "2019-01-11",
        "...": "..."
    },
    "biographicData": {
        "firstName": "John",
        "lastName": "Doo",
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA",
        "...": "..."
    },
    "biometricData": [
        {
            "biometricType": "FINGER",
            "biometricSubType": "RIGHT_INDEX",
            "instance": "string",
            "image": "c3RyaW5n",
            "imageRef": "http://imageserver.com/image?id=00003",
            "captureDate": "2019-05-21T12:00:00Z",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "mimeType": "string",
            "resolution": 1,
            "compression": "WSQ",
            "missing": [
                {
                    "biometricSubType": "RIGHT_INDEX",
                    "presence": "BANDAGED"
                }
            ],
            "metadata": "string",
            "comment": "string",
            "template": "c3RyaW5n",
            "templateRef": "http://dataserver.com/template?id=00014",
            "templateFormat": "string",
            "quality": 1,
            "qualityFormat": "string",
            "algorithm": "string",
            "vendor": "string"
        }
    ],
    "documentData": [
        {
            "documentType": "FORM",
            "documentTypeOther": "string",
            "instance": "string",
            "parts": [
                {
                    "pages": [
                        1
                    ],
                    "data": "c3RyaW5n",
                    "dataRef": "http://server.com/buffer?id=00003",
                    "width": 1,
                    "height": 1,
                    "mimeType": "string",
                    "captureDate": "2019-05-21T12:00:00Z",
                    "captureDevice": "string"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

Example response:

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

{
    "code": 1,
    "message": "string"
}
GET /v1/enrollments/{enrollmentId}

Read one enrollment

Scope required: enroll.read

Parameters:
  • enrollmentId (string) – the id of the enrollment. Object of type string.

Query Parameters:
  • transactionId (string) – The id of the transaction. Object of type string. (Required)

  • attributes (array) – The (optional) set of required attributes to retrieve. If not present all attributes will be returned. Array of string.

Status Codes:

Example request:

GET /v1/enrollments/string?transactionId=string&attributes=%5B%27string%27%5D HTTP/1.1
Host: example.com

Example response:

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

{
    "enrollmentId": "string",
    "status": "FINALIZED",
    "enrollmentType": "string",
    "enrollmentFlags": {
        "timeout": 3600,
        "other": "other",
        "...": "..."
    },
    "requestData": {
        "priority": 1,
        "requestType": "FIRST_ISSUANCE",
        "deliveryAddress": {
            "address1": "11 Rue des Rosiers",
            "city": "Libourne",
            "postalCode": "33500",
            "country": "France"
        },
        "...": "..."
    },
    "contextualData": {
        "enrollmentDate": "2019-01-11",
        "...": "..."
    },
    "biographicData": {
        "firstName": "John",
        "lastName": "Doo",
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA",
        "...": "..."
    },
    "biometricData": [
        {
            "biometricType": "FINGER",
            "biometricSubType": "RIGHT_INDEX",
            "instance": "string",
            "image": "c3RyaW5n",
            "imageRef": "http://imageserver.com/image?id=00003",
            "captureDate": "2019-05-21T12:00:00Z",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "mimeType": "string",
            "resolution": 1,
            "compression": "WSQ",
            "missing": [
                {
                    "biometricSubType": "RIGHT_INDEX",
                    "presence": "BANDAGED"
                }
            ],
            "metadata": "string",
            "comment": "string",
            "template": "c3RyaW5n",
            "templateRef": "http://dataserver.com/template?id=00014",
            "templateFormat": "string",
            "quality": 1,
            "qualityFormat": "string",
            "algorithm": "string",
            "vendor": "string"
        }
    ],
    "documentData": [
        {
            "documentType": "FORM",
            "documentTypeOther": "string",
            "instance": "string",
            "parts": [
                {
                    "pages": [
                        1
                    ],
                    "data": "c3RyaW5n",
                    "dataRef": "http://server.com/buffer?id=00003",
                    "width": 1,
                    "height": 1,
                    "mimeType": "string",
                    "captureDate": "2019-05-21T12:00:00Z",
                    "captureDevice": "string"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

Example response:

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

{
    "code": 1,
    "message": "string"
}
PUT /v1/enrollments/{enrollmentId}

Update one enrollment

Scope required: enroll.write

Parameters:
  • enrollmentId (string) – the id of the enrollment. Object of type string.

Query Parameters:
  • finalize (boolean) – Flag to indicate that data was collected (default is false). Object of type boolean.

  • transactionId (string) – The id of the transaction. Object of type string. (Required)

Form Parameters:
Status Codes:

Example request:

PUT /v1/enrollments/string?finalize=true&transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "enrollmentType": "string",
    "enrollmentFlags": {
        "timeout": 3600,
        "other": "other",
        "...": "..."
    },
    "requestData": {
        "priority": 1,
        "requestType": "FIRST_ISSUANCE",
        "deliveryAddress": {
            "address1": "11 Rue des Rosiers",
            "city": "Libourne",
            "postalCode": "33500",
            "country": "France"
        },
        "...": "..."
    },
    "contextualData": {
        "enrollmentDate": "2019-01-11",
        "...": "..."
    },
    "biographicData": {
        "firstName": "John",
        "lastName": "Doo",
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA",
        "...": "..."
    },
    "biometricData": [
        {
            "biometricType": "FINGER",
            "biometricSubType": "RIGHT_INDEX",
            "instance": "string",
            "image": "c3RyaW5n",
            "imageRef": "http://imageserver.com/image?id=00003",
            "captureDate": "2019-05-21T12:00:00Z",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "mimeType": "string",
            "resolution": 1,
            "compression": "WSQ",
            "missing": [
                {
                    "biometricSubType": "RIGHT_INDEX",
                    "presence": "BANDAGED"
                }
            ],
            "metadata": "string",
            "comment": "string",
            "template": "c3RyaW5n",
            "templateRef": "http://dataserver.com/template?id=00014",
            "templateFormat": "string",
            "quality": 1,
            "qualityFormat": "string",
            "algorithm": "string",
            "vendor": "string"
        }
    ],
    "documentData": [
        {
            "documentType": "FORM",
            "documentTypeOther": "string",
            "instance": "string",
            "parts": [
                {
                    "pages": [
                        1
                    ],
                    "data": "c3RyaW5n",
                    "dataRef": "http://server.com/buffer?id=00003",
                    "width": 1,
                    "height": 1,
                    "mimeType": "string",
                    "captureDate": "2019-05-21T12:00:00Z",
                    "captureDevice": "string"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

Example response:

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

{
    "code": 1,
    "message": "string"
}
PATCH /v1/enrollments/{enrollmentId}

Update partially one enrollment

Update partially an enrollment. Payload content is a partial enrollment object compliant with RFC7396.

Scope required: enroll.write

Parameters:
  • enrollmentId (string) – the id of the enrollment. Object of type string.

Query Parameters:
  • finalize (boolean) – Flag to indicate that data was collected (default is false). Object of type boolean.

  • transactionId (string) – The id of the transaction. Object of type string. (Required)

Form Parameters:
Status Codes:

Example request:

PATCH /v1/enrollments/string?finalize=true&transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "enrollmentType": "string",
    "enrollmentFlags": {
        "timeout": 3600,
        "other": "other",
        "...": "..."
    },
    "requestData": {
        "priority": 1,
        "requestType": "FIRST_ISSUANCE",
        "deliveryAddress": {
            "address1": "11 Rue des Rosiers",
            "city": "Libourne",
            "postalCode": "33500",
            "country": "France"
        },
        "...": "..."
    },
    "contextualData": {
        "enrollmentDate": "2019-01-11",
        "...": "..."
    },
    "biographicData": {
        "firstName": "John",
        "lastName": "Doo",
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA",
        "...": "..."
    },
    "biometricData": [
        {
            "biometricType": "FINGER",
            "biometricSubType": "RIGHT_INDEX",
            "instance": "string",
            "image": "c3RyaW5n",
            "imageRef": "http://imageserver.com/image?id=00003",
            "captureDate": "2019-05-21T12:00:00Z",
            "captureDevice": "string",
            "impressionType": "LIVE_SCAN_PLAIN",
            "width": 1,
            "height": 1,
            "bitdepth": 1,
            "mimeType": "string",
            "resolution": 1,
            "compression": "WSQ",
            "missing": [
                {
                    "biometricSubType": "RIGHT_INDEX",
                    "presence": "BANDAGED"
                }
            ],
            "metadata": "string",
            "comment": "string",
            "template": "c3RyaW5n",
            "templateRef": "http://dataserver.com/template?id=00014",
            "templateFormat": "string",
            "quality": 1,
            "qualityFormat": "string",
            "algorithm": "string",
            "vendor": "string"
        }
    ],
    "documentData": [
        {
            "documentType": "FORM",
            "documentTypeOther": "string",
            "instance": "string",
            "parts": [
                {
                    "pages": [
                        1
                    ],
                    "data": "c3RyaW5n",
                    "dataRef": "http://server.com/buffer?id=00003",
                    "width": 1,
                    "height": 1,
                    "mimeType": "string",
                    "captureDate": "2019-05-21T12:00:00Z",
                    "captureDevice": "string"
                }
            ]
        }
    ]
}

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

Example response:

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

{
    "code": 1,
    "message": "string"
}
DELETE /v1/enrollments/{enrollmentId}

Delete one enrollment

Scope required: enroll.write

Parameters:
  • enrollmentId (string) – the id of the enrollment. Object of type string.

Query Parameters:
  • transactionId (string) – The id of the transaction. Object of type string. (Required)

Status Codes:

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

Example response:

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

{
    "code": 1,
    "message": "string"
}
PUT /v1/enrollments/{enrollmentId}/finalize

Finalize one enrollment

Scope required: enroll.write

Parameters:
  • enrollmentId (string) – the id of the enrollment. Object of type string.

Query Parameters:
  • transactionId (string) – The id of the transaction. Object of type string. (Required)

Status Codes:

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

Example response:

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

{
    "code": 1,
    "message": "string"
}
POST /v1/enrollments

Retrieve a list of enrollments which match passed in search criteria

Scope required: enroll.read

Query Parameters:
  • transactionId (string) – The id of the transaction. Object of type string. (Required)

  • offset (integer) – The offset of the query (first item of the response). Object of type integer. Default: 0.

  • limit (integer) – The maximum number of items to return. Object of type integer. Default: 100.

Form Parameters:
  • body – A set of expressions on attributes of the person. Array of Expression.

Status Codes:

Example request:

POST /v1/enrollments?transactionId=string&offset=0&limit=100 HTTP/1.1
Host: example.com
Content-Type: application/json

[
    {
        "attributeName": "firstName",
        "operator": "=",
        "value": "John"
    },
    {
        "attributeName": "dateOfBirth",
        "operator": "<",
        "value": "1990-12-31"
    }
]

Example response:

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

[
    {
        "enrollmentId": "string",
        "status": "FINALIZED",
        "enrollmentType": "string",
        "enrollmentFlags": {
            "timeout": 3600,
            "other": "other",
            "...": "..."
        },
        "requestData": {
            "priority": 1,
            "requestType": "FIRST_ISSUANCE",
            "deliveryAddress": {
                "address1": "11 Rue des Rosiers",
                "city": "Libourne",
                "postalCode": "33500",
                "country": "France"
            },
            "...": "..."
        },
        "contextualData": {
            "enrollmentDate": "2019-01-11",
            "...": "..."
        },
        "biographicData": {
            "firstName": "John",
            "lastName": "Doo",
            "dateOfBirth": "1985-11-30",
            "gender": "M",
            "nationality": "FRA",
            "...": "..."
        },
        "biometricData": [
            {
                "biometricType": "FINGER",
                "biometricSubType": "RIGHT_INDEX",
                "instance": "string",
                "image": "c3RyaW5n",
                "imageRef": "http://imageserver.com/image?id=00003",
                "captureDate": "2019-05-21T12:00:00Z",
                "captureDevice": "string",
                "impressionType": "LIVE_SCAN_PLAIN",
                "width": 1,
                "height": 1,
                "bitdepth": 1,
                "mimeType": "string",
                "resolution": 1,
                "compression": "WSQ",
                "missing": [
                    {
                        "biometricSubType": "RIGHT_INDEX",
                        "presence": "BANDAGED"
                    }
                ],
                "metadata": "string",
                "comment": "string",
                "template": "c3RyaW5n",
                "templateRef": "http://dataserver.com/template?id=00014",
                "templateFormat": "string",
                "quality": 1,
                "qualityFormat": "string",
                "algorithm": "string",
                "vendor": "string"
            }
        ],
        "documentData": [
            {
                "documentType": "FORM",
                "documentTypeOther": "string",
                "instance": "string",
                "parts": [
                    {
                        "pages": [
                            1
                        ],
                        "data": "c3RyaW5n",
                        "dataRef": "http://server.com/buffer?id=00003",
                        "width": 1,
                        "height": 1,
                        "mimeType": "string",
                        "captureDate": "2019-05-21T12:00:00Z",
                        "captureDevice": "string"
                    }
                ]
            }
        ]
    }
]

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

Example response:

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

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

7.4.1.2. Buffer

POST /v1/enrollments/{enrollmentId}/buffer

Create a buffer

This service is used to send separately the buffers of the images

Scope required: enroll.buf.write

Parameters:
  • enrollmentId (string) – the id of the enrollment. Object of type string.

Query Parameters:
  • transactionId (string) – The id of the transaction. Object of type string. (Required)

Form Parameters:
  • body – The image of the request.

Request Headers:
  • Digest – the buffer digest, as defined per RFC 3230. Object of type string.

Status Codes:

Example request:

POST /v1/enrollments/string/buffer?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/*
Digest: SHA=thvDyvhfIqlvFe+A9MYgxAfm1q5=

ABCDEFG...

Example request:

POST /v1/enrollments/string/buffer?transactionId=string HTTP/1.1
Host: example.com
Content-Type: image/*
Digest: SHA=thvDyvhfIqlvFe+A9MYgxAfm1q5=

ABCDEFG...

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
    "bufferId": "string"
}

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

Example response:

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

{
    "code": 1,
    "message": "string"
}
GET /v1/enrollments/{enrollmentId}/buffer/{bufferId}

Read a buffer

This service is used to get the buffer of the images. The content type of the response is the content type used when the buffer was created.

Scope required: enroll.buf.read

Parameters:
  • enrollmentId (string) – the id of the enrollment. Object of type string.

  • bufferId (string) – the id of the buffer. Object of type string.

Query Parameters:
  • transactionId (string) – The id of the transaction. Object of type string. (Required)

Response Headers:
  • Digest – the buffer digest, as defined per RFC 3230. Object of type string.

Status Codes:

Example request:

GET /v1/enrollments/string/buffer/string?transactionId=string HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: application/*
Digest: SHA=thvDyvhfIqlvFe+A9MYgxAfm1q5=

ABCDEFG...

Example response:

HTTP/1.1 200 OK
Content-Type: image/*
Digest: SHA=thvDyvhfIqlvFe+A9MYgxAfm1q5=

ABCDEFG...

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

Example response:

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

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

7.4.2. Data Model

7.4.2.1. Error

Table 7.6 Error

Attribute

Type

Description

Required

code

integer/int32

Error code.

Yes

message

string

Error message.

Yes

7.4.2.2. Enrollment

Table 7.7 Enrollment

Attribute

Type

Description

Required

enrollmentId

string

Constraints: read only

Yes

status

string

Constraints: possible values are FINALIZED, IN_PROGRESS; read only

Yes

enrollmentType

string

Type of the enrollment (example: citizen, resident, etc.).

enrollmentFlags

Object of type EnrollmentFlags

The enrollment custom flags (i.e. the properties of the enrollment process). Can be extended.

requestData

Object of type RequestData

The data describing the request associated to the enrollment (i.e. why the enrollment is done). Can be extended.

contextualData

Object of type ContextualData

biographicData

Object of type BiographicData

The set of biographic data.

biometricData

Array of BiometricData

documentData

Array of DocumentData

7.4.2.3. RequestData

The data describing the request associated to the enrollment (i.e. why the enrollment is done). Can be extended.

Table 7.8 RequestData

Attribute

Type

Description

Required

*

Additional properties

Example #1:

{
  "priority": 1,
  "requestType": "FIRST_ISSUANCE",
  "deliveryAddress": {
    "address1": "11 Rue des Rosiers",
    "city": "Libourne",
    "postalCode": "33500",
    "country": "France"
  }
}

7.4.2.4. EnrollmentFlags

The enrollment custom flags (i.e. the properties of the enrollment process). Can be extended.

Table 7.9 EnrollmentFlags

Attribute

Type

Description

Required

*

Additional properties

Example #1:

{
  "timeout": 3600,
  "other": "other"
}

7.4.2.5. ContextualData

Table 7.10 ContextualData

Attribute

Type

Description

Required

*

Additional properties

Example #1:

{
  "enrollmentDate": "2019-01-11"
}

7.4.2.6. BiographicData

The set of biographic data.

Table 7.11 BiographicData

Attribute

Type

Description

Required

*

Additional properties

Example #1:

{
  "firstName": "John",
  "lastName": "Doo",
  "dateOfBirth": "1985-11-30",
  "gender": "M",
  "nationality": "FRA"
}

7.4.2.7. BiometricData

Table 7.12 BiometricData

Attribute

Type

Description

Required

biometricType

string

Constraints: possible values are FACE, FINGER, IRIS, SIGNATURE, UNKNOWN

Yes

biometricSubType

string

Constraints: possible values are UNKNOWN, RIGHT_THUMB, RIGHT_INDEX, RIGHT_MIDDLE, RIGHT_RING, RIGHT_LITTLE, LEFT_THUMB, LEFT_INDEX, LEFT_MIDDLE, LEFT_RING, LEFT_LITTLE, PLAIN_RIGHT_FOUR_FINGERS, PLAIN_LEFT_FOUR_FINGERS, PLAIN_THUMBS, UNKNOWN_PALM, RIGHT_FULL_PALM, RIGHT_WRITERS_PALM, LEFT_FULL_PALM, LEFT_WRITERS_PALM, RIGHT_LOWER_PALM, RIGHT_UPPER_PALM, LEFT_LOWER_PALM, LEFT_UPPER_PALM, RIGHT_OTHER, LEFT_OTHER, RIGHT_INTERDIGITAL, RIGHT_THENAR, RIGHT_HYPOTHENAR, LEFT_INTERDIGITAL, LEFT_THENAR, LEFT_HYPOTHENAR, RIGHT_INDEX_AND_MIDDLE, RIGHT_MIDDLE_AND_RING, RIGHT_RING_AND_LITTLE, LEFT_INDEX_AND_MIDDLE, LEFT_MIDDLE_AND_RING, LEFT_RING_AND_LITTLE, RIGHT_INDEX_AND_LEFT_INDEX, RIGHT_INDEX_AND_MIDDLE_AND_RING, RIGHT_MIDDLE_AND_RING_AND_LITTLE, LEFT_INDEX_AND_MIDDLE_AND_RING, LEFT_MIDDLE_AND_RING_AND_LITTLE, EYE_UNDEF, EYE_RIGHT, EYE_LEFT, EYE_BOTH, PORTRAIT, LEFT_PROFILE, RIGHT_PROFILE

instance

string

Used to separate two distincts biometric items of the same type and subtype.

image

string/byte

Base64-encoded image.

imageRef

string/uri

URI to an image.

captureDate

string/date-time

captureDevice

string

A string identifying the device used to capture the biometric.

impressionType

string

Constraints: possible values are LIVE_SCAN_PLAIN, LIVE_SCAN_ROLLED, NONLIVE_SCAN_PLAIN, NONLIVE_SCAN_ROLLED, LATENT_IMPRESSION, LATENT_TRACING, LATENT_PHOTO, LATENT_LIFT, LIVE_SCAN_SWIPE, LIVE_SCAN_VERTICAL_ROLL, LIVE_SCAN_PALM, NONLIVE_SCAN_PALM, LATENT_PALM_IMPRESSION, LATENT_PALM_TRACING, LATENT_PALM_PHOTO, LATENT_PALM_LIFT, LIVE_SCAN_OPTICAL_CONTACTLESS_PLAIN, OTHER, UNKNOWN

width

integer

the width of the image.

height

integer

the height of the image.

bitdepth

integer

mimeType

string

the nature and format of the image. The mime type definitions should be in compliance with RFC 6838.

resolution

integer

the image resolution (in DPI).

compression

string

Constraints: possible values are NONE, WSQ, JPEG, JPEG2000, PNG

missing

Array of MissingType

Optional properties indicating if a part of the biometric data is missing.

metadata

string

An optional string used to convey information vendor-specific.

comment

string

A comment about the biometric data.

template

string/byte

Base64-encoded template.

templateRef

string/uri

URI to the template when it is managed in a dedicated data server.

templateFormat

string

Format of the template. One of ISO_19794_2, ISO_19794_2_NS, ISO_19794_2_CS, ISO_19794_2_2011, ANSI_378_2009 or ANSI_378. Can be extended to include additional proprietary template format

quality

integer/int64

Quality, as a number, of the biometric.

qualityFormat

string

Format of the quality. One of ISO_19794, NFIQ, or NFIQ2. Can be extended to include additional proprietary quality format

algorithm

string

vendor

string

7.4.2.8. MissingType

Table 7.13 MissingType

Attribute

Type

Description

Required

biometricSubType

string

Constraints: possible values are UNKNOWN, RIGHT_THUMB, RIGHT_INDEX, RIGHT_MIDDLE, RIGHT_RING, RIGHT_LITTLE, LEFT_THUMB, LEFT_INDEX, LEFT_MIDDLE, LEFT_RING, LEFT_LITTLE, PLAIN_RIGHT_FOUR_FINGERS, PLAIN_LEFT_FOUR_FINGERS, PLAIN_THUMBS, UNKNOWN_PALM, RIGHT_FULL_PALM, RIGHT_WRITERS_PALM, LEFT_FULL_PALM, LEFT_WRITERS_PALM, RIGHT_LOWER_PALM, RIGHT_UPPER_PALM, LEFT_LOWER_PALM, LEFT_UPPER_PALM, RIGHT_OTHER, LEFT_OTHER, RIGHT_INTERDIGITAL, RIGHT_THENAR, RIGHT_HYPOTHENAR, LEFT_INTERDIGITAL, LEFT_THENAR, LEFT_HYPOTHENAR, RIGHT_INDEX_AND_MIDDLE, RIGHT_MIDDLE_AND_RING, RIGHT_RING_AND_LITTLE, LEFT_INDEX_AND_MIDDLE, LEFT_MIDDLE_AND_RING, LEFT_RING_AND_LITTLE, RIGHT_INDEX_AND_LEFT_INDEX, RIGHT_INDEX_AND_MIDDLE_AND_RING, RIGHT_MIDDLE_AND_RING_AND_LITTLE, LEFT_INDEX_AND_MIDDLE_AND_RING, LEFT_MIDDLE_AND_RING_AND_LITTLE, EYE_UNDEF, EYE_RIGHT, EYE_LEFT, EYE_BOTH, PORTRAIT, LEFT_PROFILE, RIGHT_PROFILE

presence

string

Constraints: possible values are BANDAGED, AMPUTATED, DAMAGED

7.4.2.9. DocumentPart

Table 7.14 DocumentPart

Attribute

Type

Description

Required

pages

Array of integer

The pages included in this part. Can be a single page number, or a list. Constraints: minItems is 1

data

string/byte

Base64-encoded data of the document.

dataRef

string/uri

URI to the data.

width

integer

the width of the image in pixels.

height

integer

the height of the image in pixels.

mimeType

string

the nature and format of the document. The mime type definitions should be in compliance with RFC 6838.

captureDate

string/date-time

captureDevice

string

A string identifying the device used to capture the document part.

7.4.2.10. DocumentData

Table 7.15 DocumentData

Attribute

Type

Description

Required

documentType

string

Type of document. Constraints: possible values are ID_CARD, PASSPORT, INVOICE, BIRTH_CERTIFICATE, FORM, OTHER

Yes

documentTypeOther

string

Details about the type of document when OTHER is used.

instance

string

Used to separate two distincts documents of the same type (ex: two passports).

parts

Array of DocumentPart

Constraints: minItems is 1

Yes

7.4.2.11. Expression

Table 7.16 Expression

Attribute

Type

Description

Required

attributeName

string

Yes

operator

string

Constraints: possible values are <, >, =, >=, <=, !=

Yes

value

One of string, integer, number, boolean

Yes

7.4.2.12. Expressions

Table 7.17 Expressions

Attribute

Type

Description

Required

N/A

Array of Expression