7.5. Population Registry Management

This is version 1.4.1 of this interface.

Get the OpenAPI file: pr.yaml

Population Registry Services

findPersons createPerson readPerson updatePerson deletePerson mergePerson readIdentities createIdentity createIdentityWithId readIdentity

updateIdentity partialUpdateIdentity deleteIdentity moveIdentity setIdentityStatus defineReference readReference readGalleries readGalleryContent

7.5.1. Services

7.5.1.1. Person

POST /v1/persons

Query for persons

Retrieve a list of personId corresponding to the records with one identity matching the criteria.

By default, all identities are used in the search.

Scope required: pr.person.read

Query Parameters

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

• group (boolean) – Group all matching identities of one person and return only the personId. Object of type boolean.

• reference (boolean) – Limit the query to the reference identity. Object of type boolean.

• gallery (string) – Limit the query to the records belonging to this gallery. Object of type string.

• 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’s identity. Array of Expression.

Status Codes

• 200 OK – Query successful. If the group parameter was set the identityId is not included in the response. Object of type Array.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Query not allowed.

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

Example request:

POST /v1/persons?transactionId=string&group=True&reference=True&gallery=string&offset=1&limit=1 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

[
    {
        "personId": "string",
        "identityId": "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"
}

POST /v1/persons/{personId}

Create one person

Scope required: pr.person.write

Parameters

• personId (string) – the id of the person. Object of type string.

Query Parameters

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

Form Parameters

• body – Object of type Person.

Status Codes

• 201 Created – Operation successful.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Operation not allowed.

• 409 Conflict – Creation not allowed, personId already exists.

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

Example request:

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

{
    "status": "ACTIVE",
    "physicalStatus": "DEAD"
}

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/persons/{personId}

Read one person

Scope required: pr.person.read

Parameters

• personId (string) – the id of the person. Object of type string.

Query Parameters

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

Status Codes

• 200 OK – Read successful. Object of type Person.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Read not allowed.

• 404 Not Found – Unknown record.

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

Example request:

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

Example response:

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

{
    "personId": "string",
    "status": "ACTIVE",
    "physicalStatus": "DEAD"
}

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/persons/{personId}

Update one person

Scope required: pr.person.write

Parameters

• personId (string) – the id of the person. Object of type string.

Query Parameters

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

Form Parameters

• body – Object of type Person.

Status Codes

• 204 No Content – Update successful.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Update not allowed.

• 404 Not Found – Unknown record.

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

Example request:

PUT /v1/persons/{personId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "status": "ACTIVE",
    "physicalStatus": "DEAD"
}

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/persons/{personId}

Delete a person and all its identities

Scope required: pr.person.write

Parameters

• personId (string) – the id of the person. Object of type string.

Query Parameters

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

Status Codes

• 204 No Content – Delete successful.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Delete not allowed.

• 404 Not Found – Unknown record.

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

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/persons/{personIdTarget}/merge/{personIdSource}

Merge two persons

Merge two person records into a single one. Identity ID are preserved and in case of duplicates an error 409 is returned and no changes are done. If the operation is successful, the person merged is deleted.

Scope required: pr.person.write

Parameters

• personIdTarget (string) – the id of the person receiving new identities. Object of type string.

• personIdSource (string) – the id of the person giving the identities. Object of type string.

Query Parameters

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

Status Codes

• 204 No Content – Merge successful.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Merge not allowed.

• 409 Conflict – Creation not allowed, conflict of identityId.

• 404 Not Found – Unknown record.

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

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.5.1.2. Identity

GET /v1/persons/{personId}/identities

Read all the identities of a person

Scope required: pr.identity.read

Parameters

• personId (string) – the id of the person. Object of type string.

Query Parameters

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

Status Codes

• 200 OK – Operation successful. Array of Identity.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Operation not allowed.

• 404 Not Found – Unknown record.

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

Example request:

GET /v1/persons/{personId}/identities?transactionId=string HTTP/1.1
Host: example.com

Example response:

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

[
    {
        "identityId": "string",
        "identityType": "string",
        "status": "CLAIMED",
        "galleries": [
            "string"
        ],
        "clientData": "c3RyaW5n",
        "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",
                "identityId": "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"
}

POST /v1/persons/{personId}/identities

Create one identity and generate its id

Scope required: pr.identity.write

Parameters

• personId (string) – the id of the person. Object of type string.

Query Parameters

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

Form Parameters

• body – Object of type Identity.

Status Codes

• 200 OK – Insertion successful. Object of type string.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Insertion not allowed.

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

Example request:

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

{
    "identityType": "string",
    "status": "CLAIMED",
    "galleries": [
        "string"
    ],
    "clientData": "c3RyaW5n",
    "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 200 OK
Content-Type: application/json

{
    "identityId": "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"
}

POST /v1/persons/{personId}/identities/{identityId}

Create one identity

Create one new identity for a person. The provided identityId is checked for validity and used for the new identity.

Scope required: pr.identity.write

Parameters

• personId (string) – the id of the person. Object of type string.

• identityId (string) – the id of the identity. Object of type string.

Query Parameters

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

Form Parameters

• body – Object of type Identity.

Status Codes

• 201 Created – Insertion successful.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Insertion not allowed.

• 409 Conflict – Creation not allowed, identityId already exists.

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

Example request:

POST /v1/persons/{personId}/identities/{identityId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "identityType": "string",
    "status": "CLAIMED",
    "galleries": [
        "string"
    ],
    "clientData": "c3RyaW5n",
    "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/persons/{personId}/identities/{identityId}

Read one identity

Scope required: pr.identity.read

Parameters

• personId (string) – the id of the person. Object of type string.

• identityId (string) – the id of the identity. Object of type string.

Query Parameters

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

Status Codes

• 200 OK – Read successful. Object of type Identity.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Read not allowed.

• 404 Not Found – Unknown record.

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

Example request:

GET /v1/persons/{personId}/identities/{identityId}?transactionId=string HTTP/1.1
Host: example.com

Example response:

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

{
    "identityId": "string",
    "identityType": "string",
    "status": "CLAIMED",
    "galleries": [
        "string"
    ],
    "clientData": "c3RyaW5n",
    "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",
            "identityId": "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/persons/{personId}/identities/{identityId}

Update one identity

Scope required: pr.identity.write

Parameters

• personId (string) – the id of the person. Object of type string.

• identityId (string) – the id of the identity. Object of type string.

Query Parameters

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

Form Parameters

• body – Object of type Identity.

Status Codes

• 204 No Content – Update successful.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Update not allowed.

• 404 Not Found – Unknown record.

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

Example request:

PUT /v1/persons/{personId}/identities/{identityId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "identityType": "string",
    "status": "CLAIMED",
    "galleries": [
        "string"
    ],
    "clientData": "c3RyaW5n",
    "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/persons/{personId}/identities/{identityId}

Update partially one identity

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

Scope required: pr.identity.write

Parameters

• personId (string) – the id of the person. Object of type string.

• identityId (string) – the id of the identity. Object of type string.

Query Parameters

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

Form Parameters

• body – Object of type Identity.

Status Codes

• 204 No Content – Update successful.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Update not allowed.

• 404 Not Found – Unknown record.

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

Example request:

PATCH /v1/persons/{personId}/identities/{identityId}?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "galleries": [
        "G1",
        "G2"
    ],
    "biographicData": {
        "gender": null,
        "nationality": "FRA"
    }
}

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/persons/{personId}/identities/{identityId}

Delete one identity

Scope required: pr.identity.write

Parameters

• personId (string) – the id of the person. Object of type string.

• identityId (string) – the id of the identity. Object of type string.

Query Parameters

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

Status Codes

• 204 No Content – Delete successful.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Delete not allowed.

• 404 Not Found – Unknown record.

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

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/persons/{personIdTarget}/move/{personIdSource}/identities/{identityId}

Move one identity

Move one identity from the source person to the target person. Identity ID is preserved and in case of duplicate an error 409 is returned and no changes are done. The source person is not deleted, even if it was the only identity of this person.

Scope required: pr.identity.write

Parameters

• personIdTarget (string) – the id of the person receiving the identity. Object of type string.

• personIdSource (string) – the id of the person giving the identity. Object of type string.

• identityId (string) – the id of the identity. Object of type string.

Query Parameters

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

Status Codes

• 204 No Content – Move successful.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Move not allowed.

• 404 Not Found – Unknown record.

• 409 Conflict – Operation not allowed, conflict of identityId.

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

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/persons/{personId}/identities/{identityId}/status

Change the status of an identity

Scope required: pr.identity.write

Parameters

• personId (string) – the id of the person. Object of type string.

• identityId (string) – the id of the identity. Object of type string.

Query Parameters

• status (string) – The status of the identity. Object of type string. (Required)

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

Status Codes

• 204 No Content – Operation successful.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Operation not allowed.

• 404 Not Found – Unknown record.

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

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.5.1.3. Reference

PUT /v1/persons/{personId}/identities/{identityId}/reference

Define the reference

Scope required: pr.reference.write

Parameters

• personId (string) – the id of the person. Object of type string.

• identityId (string) – the id of the identity. Object of type string.

Query Parameters

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

Status Codes

• 204 No Content – Operation successful.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Operation not allowed.

• 404 Not Found – Unknown record.

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

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/persons/{personId}/reference

Read the reference

Scope required: pr.reference.read

Parameters

• personId (string) – the id of the person. Object of type string.

Query Parameters

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

Status Codes

• 200 OK – Read successful. Object of type Identity.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Read not allowed.

• 404 Not Found – Unknown record.

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

Example request:

GET /v1/persons/{personId}/reference?transactionId=string HTTP/1.1
Host: example.com

Example response:

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

{
    "identityId": "string",
    "identityType": "string",
    "status": "CLAIMED",
    "galleries": [
        "string"
    ],
    "clientData": "c3RyaW5n",
    "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",
            "identityId": "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.5.1.4. Gallery

GET /v1/galleries

Read the ID of all the galleries

Scope required: pr.gallery.read

Query Parameters

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

Status Codes

• 200 OK – Operation successful. Array of string.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Read not allowed.

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

Example request:

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

Example response:

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

[
    "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/galleries/{galleryId}

Read the content of one gallery

Scope required: pr.gallery.read

Parameters

• galleryId (string) – the id of the gallery. Object of type string.

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: 1000.

Status Codes

• 200 OK – Operation successful. Object of type Array.

• 400 Bad Request – Bad request. Object of type Error.

• 403 Forbidden – Read not allowed.

• 404 Not Found – Unknown record.

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

Example request:

GET /v1/galleries/{galleryId}?transactionId=string&offset=1&limit=1 HTTP/1.1
Host: example.com

Example response:

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

[
    {
        "personId": "string",
        "identityId": "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.5.2. Data Model

7.5.2.1. Error

Table 7.18 Error

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

7.5.2.2. Person

Person entity.

Table 7.19 Person

Attribute	Type	Description	Required
personId	string	The unique id for this person. Constraints: read only
status	string	Constraints: possible values are ACTIVE, INACTIVE	Yes
physicalStatus	string	Constraints: possible values are DEAD, ALIVE	Yes

7.5.2.3. Identity

Table 7.20 Identity

Attribute	Type	Description	Required
identityId	string	Constraints: read only	Yes
identityType	string		Yes
status	string	Constraints: possible values are CLAIMED, VALID, INVALID, REVOKED	Yes
galleries	Array of string	The list of galleries for this object. Constraints: minItems is 1; items must be unique
clientData	string/byte
contextualData	Object of type ContextualData
biographicData	Object of type BiographicData	The set of biographic data.
biometricData	Array of BiometricData
documentData	Array of DocumentData

7.5.2.4. ContextualData

Table 7.21 ContextualData

Attribute	Type	Description	Required
*		Additional properties

Example #1:

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

7.5.2.5. BiographicData

The set of biographic data.

Table 7.22 BiographicData

Attribute	Type	Description	Required
*		Additional properties

Example #1:

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

7.5.2.6. DocumentData

Table 7.23 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.5.2.7. DocumentPart

Table 7.24 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.5.2.8. BiometricData

Table 7.25 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.
identityId	string	the id of the identity 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.5.2.9. MissingType

Table 7.26 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.5.2.10. Expression

Table 7.27 Expression

Attribute	Type	Description	Required
attributeName	string		Yes
operator	string	Constraints: possible values are <, >, =, >=, <=, !=	Yes
value	One of string, integer, number, boolean		Yes

7.5.2.11. Expressions

Table 7.28 Expressions

Attribute	Type	Description	Required
N/A	Array of Expression