7.8. ID Usage Services

7.8.1. Relying Party Services

This is version 1.1.1 of this interface.

Get the OpenAPI file: rp.yaml

Relying Party Services

verify readAttributeSet readAttributes

identify readIdentifyResult

7.8.2. Services

7.8.2.1. IDUsage

POST /v1/verify/{identifier}

Verify a set of attributes of a person.

Verify an Identity based on an identity identifier (UIN, token…) and a set of Identity Attributes. Verification is strictly matching all provided identity attributes to compute the global Boolean matching result.

Scope required: id.verify

Parameters

• identifier (string) – person identifier. Object of type string.

Query Parameters

• identifierType (string) – Type of identifier (default “uin”, “token”, “credentialNumber”, …). Object of type string.

• verificationProofRequired (boolean) – verification proof required on successful verification (default true). Object of type boolean.

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

Form Parameters

• body – A set of identity attributes associated to the identity identifier and to be verified by the system. Object of type AttributeSet.

Status Codes

• 200 OK – Verification execution successful. Object of type VerifyResult.

• 400 Bad Request – Bad Request, Validation Errors, … Object of type Error.

• 401 Unauthorized – Unauthorized.

• 403 Forbidden – Operation not allowed.

• 404 Not Found – Identifier not Found.

• 500 Internal Server Error – Internal server error. Object of type Error.

Example request:

POST /v1/verify/{identifier}?identifierType=token&verificationProofRequired=True&transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "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"
        }
    ],
    "credentialData": [
        {
            "credentialNumber": "string",
            "personId": "string",
            "credentialType": "ID_CARD",
            "issuedDate": "2022-12-16T14:49:45.696550",
            "expiryDate": "2022-12-16T14:49:45.696550",
            "serialNumber": "string",
            "issuingAuthority": "string",
            "issuingPlace": "string",
            "others": {
                "...": "..."
            }
        }
    ],
    "contactData": {
        "email": "John.Doo@osia.com",
        "phone1": "555666777",
        "phone2": "555888999",
        "...": "..."
    }
}

Example response:

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

{
    "verificationCode": 1,
    "verificationMessage": "string",
    "verificationProof": "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/attributes/{attributeSetName}/{identifier}

Read a predefined set of a person’s attributes.

Note security role must map the requested attributeSetName, e.g. id.DEFAULT_SET_01.read

Scope required: id.ATTRIBUTESETNAME.read

Parameters

• attributeSetName (string) – Predefined attribute set name describing what attributes are to be read. e.g. “DEFAULT_SET_01”, “SET_BIOM_01”, “EIDAS”, … Object of type string.

• identifier (string) – person identifier. Object of type string.

Query Parameters

• identifierType (string) – Type of identifier (default “uin”, “token”, “credentialNumber”, …). Object of type string.

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

Status Codes

• 200 OK – Operation successful, AttributeSet will contain fields as predefined by the attributeSetName and when value is available. Object of type AttributeSet.

• 400 Bad Request – Bad Request, Validation Errors, … Object of type Error.

• 401 Unauthorized – Unauthorized.

• 403 Forbidden – Operation not allowed.

• 404 Not Found – Not Found.

• 500 Internal Server Error – Internal server error. Object of type Error.

Example request:

GET /v1/attributes/{attributeSetName}/{identifier}?identifierType=token&transactionId=string HTTP/1.1
Host: example.com

Example response:

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

{
    "biographicData": {
        "firstName": "John",
        "lastName": "Doo",
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA",
        "...": "..."
    },
    "biometricData": [
        {
            "biometricType": "FINGER",
            "biometricSubType": "RIGHT_INDEX",
            "instance": "string",
            "encounterId": "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"
        }
    ],
    "credentialData": [
        {
            "credentialId": "string",
            "status": "NEW",
            "statusOther": "string",
            "credentialNumber": "string",
            "personId": "string",
            "credentialType": "ID_CARD",
            "issuedDate": "2022-12-16T14:49:45.696550",
            "expiryDate": "2022-12-16T14:49:45.696550",
            "serialNumber": "string",
            "issuingAuthority": "string",
            "issuingPlace": "string",
            "others": {
                "...": "..."
            }
        }
    ],
    "contactData": {
        "email": "John.Doo@osia.com",
        "phone1": "555666777",
        "phone2": "555888999",
        "...": "..."
    }
}

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/attributes/{identifier}

Read a variable set of a person’s attributes.

Returns value of attributes listed in the request parameter ‘OutputAttributeSet’

Scope required: id.read

Parameters

• identifier (string) – person identifier. Object of type string.

Query Parameters

• identifierType (string) – Type of identifier (default “uin”, “token”, “credentialNumber”, …). Object of type string.

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

Form Parameters

• body – A description of expected identity attributes . Object of type OutputAttributeSet.

Status Codes

• 200 OK – Operation successful, AttributeSet will contain fields as defined by parameter outputAttributeSet and when value is available. Object of type AttributeSet.

• 400 Bad Request – Bad Request, Validation Errors, … Object of type Error.

• 401 Unauthorized – Unauthorized.

• 403 Forbidden – Operation not allowed.

• 404 Not Found – Not Found.

• 500 Internal Server Error – Internal server error. Object of type Error.

Example request:

POST /v1/attributes/{identifier}?identifierType=token&transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "outputBiographicData": [
        "string"
    ],
    "outputBiometricData": [
        {
            "biometricType": "FINGER",
            "biometricSubType": "RIGHT_INDEX",
            "biometricDataFields": [
                "string"
            ]
        }
    ],
    "outputCredentialData": [
        {
            "credentialType": "ID_CARD",
            "credentialDataFields": [
                "string"
            ]
        }
    ],
    "outputContactData": [
        "string"
    ]
}

Example response:

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

{
    "biographicData": {
        "firstName": "John",
        "lastName": "Doo",
        "dateOfBirth": "1985-11-30",
        "gender": "M",
        "nationality": "FRA",
        "...": "..."
    },
    "biometricData": [
        {
            "biometricType": "FINGER",
            "biometricSubType": "RIGHT_INDEX",
            "instance": "string",
            "encounterId": "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"
        }
    ],
    "credentialData": [
        {
            "credentialId": "string",
            "status": "NEW",
            "statusOther": "string",
            "credentialNumber": "string",
            "personId": "string",
            "credentialType": "ID_CARD",
            "issuedDate": "2022-12-16T14:49:45.696550",
            "expiryDate": "2022-12-16T14:49:45.696550",
            "serialNumber": "string",
            "issuingAuthority": "string",
            "issuingPlace": "string",
            "others": {
                "...": "..."
            }
        }
    ],
    "contactData": {
        "email": "John.Doo@osia.com",
        "phone1": "555666777",
        "phone2": "555888999",
        "...": "..."
    }
}

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/identify

Identify a set of persons matching provided partial attributes

Identify possibly matching identities against an input set of attributes. Returns an array of predefined datasets as described by outputDataSetName. Note this request may be asynchronous or synchronous.

Scope required: id.identify

Query Parameters

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

Form Parameters

• body – A set of identity attributes to match and an attributeSetName to use as template for returned matching identities. Object of type IdentifyRequest.

Status Codes

• 200 OK – Identification request execution successful. Array of AttributeSet.

• 202 Accepted – Request received successfully and correct, result will be available later using the task ID returned . Object of type TaskId.

• 400 Bad Request – Bad Request, Validation Errors, … Object of type Error.

• 401 Unauthorized – Unauthorized.

• 403 Forbidden – Operation not allowed.

• 404 Not Found – Identifier not Found.

• 500 Internal Server Error – Internal server error. Object of type Error.

Example request:

POST /v1/identify?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "attributeSet": {
        "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"
            }
        ],
        "credentialData": [
            {
                "credentialNumber": "string",
                "personId": "string",
                "credentialType": "ID_CARD",
                "issuedDate": "2022-12-16T14:49:45.696550",
                "expiryDate": "2022-12-16T14:49:45.696550",
                "serialNumber": "string",
                "issuingAuthority": "string",
                "issuingPlace": "string",
                "others": {
                    "...": "..."
                }
            }
        ],
        "contactData": {
            "email": "John.Doo@osia.com",
            "phone1": "555666777",
            "phone2": "555888999",
            "...": "..."
        }
    },
    "outputAttributeSetName": "DEFAULT_SET_01"
}

Example response:

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

[
    {
        "biographicData": {
            "firstName": "John",
            "lastName": "Doo",
            "dateOfBirth": "1985-11-30",
            "gender": "M",
            "nationality": "FRA",
            "...": "..."
        },
        "biometricData": [
            {
                "biometricType": "FINGER",
                "biometricSubType": "RIGHT_INDEX",
                "instance": "string",
                "encounterId": "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"
            }
        ],
        "credentialData": [
            {
                "credentialId": "string",
                "status": "NEW",
                "statusOther": "string",
                "credentialNumber": "string",
                "personId": "string",
                "credentialType": "ID_CARD",
                "issuedDate": "2022-12-16T14:49:45.696550",
                "expiryDate": "2022-12-16T14:49:45.696550",
                "serialNumber": "string",
                "issuingAuthority": "string",
                "issuingPlace": "string",
                "others": {
                    "...": "..."
                }
            }
        ],
        "contactData": {
            "email": "John.Doo@osia.com",
            "phone1": "555666777",
            "phone2": "555888999",
            "...": "..."
        }
    }
]

Example response:

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

{
    "taskId": "123e4567-e89b-12d3-a456-426655440000",
    "others": {
        "...": "..."
    }
}

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/identify/{taskID}

Read the result of a previously sent identify request

Scope required: id.identify

Parameters

• taskID (string) – taskID to get result for. Object of type string.

Query Parameters

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

Status Codes

• 200 OK – Operation successful, array of AttributeSet is available. Array of AttributeSet.

• 204 No Content – No content, taskID is valid but identify request is still ongoing, retry later.

• 400 Bad Request – Bad Request, Validation Errors, … Object of type Error.

• 401 Unauthorized – Unauthorized.

• 403 Forbidden – Operation not allowed.

• 404 Not Found – Not Found.

• 500 Internal Server Error – Internal server error. Object of type Error.

Example request:

GET /v1/identify/{taskID}?transactionId=string HTTP/1.1
Host: example.com

Example response:

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

[
    {
        "biographicData": {
            "firstName": "John",
            "lastName": "Doo",
            "dateOfBirth": "1985-11-30",
            "gender": "M",
            "nationality": "FRA",
            "...": "..."
        },
        "biometricData": [
            {
                "biometricType": "FINGER",
                "biometricSubType": "RIGHT_INDEX",
                "instance": "string",
                "encounterId": "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"
            }
        ],
        "credentialData": [
            {
                "credentialId": "string",
                "status": "NEW",
                "statusOther": "string",
                "credentialNumber": "string",
                "personId": "string",
                "credentialType": "ID_CARD",
                "issuedDate": "2022-12-16T14:49:45.696550",
                "expiryDate": "2022-12-16T14:49:45.696550",
                "serialNumber": "string",
                "issuingAuthority": "string",
                "issuingPlace": "string",
                "others": {
                    "...": "..."
                }
            }
        ],
        "contactData": {
            "email": "John.Doo@osia.com",
            "phone1": "555666777",
            "phone2": "555888999",
            "...": "..."
        }
    }
]

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.8.3. Data Model

7.8.3.1. AttributeSet

a set of attributes used in verify

Table 7.53 AttributeSet

Attribute	Type	Description	Required
biographicData	Object of type BiographicData	The set of biographic data.
biometricData	Array of BiometricData
credentialData	Array of CredentialData
contactData	Object of type ContactData

7.8.3.2. BiographicData

The set of biographic data.

Table 7.54 BiographicData

Attribute	Type	Description	Required
*		Additional properties

Example #1:

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

7.8.3.3. ContactData

Table 7.55 ContactData

Attribute	Type	Description	Required
*		Additional properties

Example #1:

{
  "email": "John.Doo@osia.com",
  "phone1": "555666777",
  "phone2": "555888999"
}

7.8.3.4. BiometricData

Table 7.56 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.
encounterId	string	the id of the encounter owner of this biometric. Constraints: read only
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.8.3.5. MissingType

Table 7.57 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.8.3.6. CredentialData

A credential

Table 7.58 CredentialData

Attribute	Type	Description	Required
credentialId	string	The unique id for this credential. Constraints: read only
status	string	The status of the credential. Constraints: possible values are NEW, ACTIVE, SUSPENDED, REVOKED, OTHER; read only
statusOther	string	Details about the status when OTHER is used. Constraints: read only
credentialNumber	string	The number attached to the credential (ex: passport number).
personId	string	The unique id of the person that the credential request is for.
credentialType	string	Type of the credential. e.g. “PASSPORT”, “ID_CARD”, …
issuedDate	string/date-time	The date and time that this credential was issued.
expiryDate	string/date-time	The date and time that this credential expires.
serialNumber	string	the serial number of the credential.
issuingAuthority	string	The authority issuing the credential (ex: the Ministry of Interior).
issuingPlace	string	The place where the credential was issued (ex: Paris).
others.*		Additional properties

7.8.3.7. Error

Table 7.59 Error

Attribute	Type	Description	Required
code	integer/int32	Error code.	Yes
message	string	Error message.	Yes

7.8.3.8. VerifyResult

result of a successful verify request

Table 7.60 VerifyResult

Attribute	Type	Description	Required
verificationCode	integer/int64		Yes
verificationMessage	string		Yes
verificationProof	string

7.8.3.9. IdentifyRequest

a set of parameters used in identify

Table 7.61 IdentifyRequest

Attribute	Type	Description	Required
attributeSet	Object of type AttributeSet	a set of attributes used in verify.	Yes
outputAttributeSetName	string	Attribute set name describing what attributes are to be read. e.g. “DEFAULT_SET_01”, “SET_BIOM_01”, “EIDAS”, …	Yes

7.8.3.10. OutputAttributeSet

A template describing the expected attributes of a readAttributes request

Table 7.62 OutputAttributeSet

Attribute	Type	Description	Required
outputBiographicData	Array of string	list of BiographicData structure fields to include in the answer.
outputBiometricData	Array	an array of expected biometric data & fields.
outputBiometricData[].biometricType	string	Constraints: possible values are FACE, FINGER, IRIS, SIGNATURE, UNKNOWN
outputBiometricData[].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
outputBiometricData[].biometricDataFields	Array of string
outputCredentialData	Array	an array of expected credential type & fields.
outputCredentialData[].credentialType	string	Type of the credential. e.g. “PASSPORT”, “ID_CARD”, …
outputCredentialData[].credentialDataFields	Array of string
outputContactData	Array of string	list of ContactData structure fields to include in the answer.

7.8.3.11. TaskId

Information about the asynchronous result. Only the taskId is mandatory but the implementation is free to return additional details such as: expected duration, URL to monitor the task, etc.

Table 7.63 TaskId

Attribute	Type	Description	Required
taskId	string		Yes
others.*		Additional properties