7.5. Population Registry Management¶
This is version 1.4.1 of this interface.
Get the OpenAPI file: pr.yaml
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
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
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
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
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¶
Attribute |
Type |
Description |
Required |
---|---|---|---|
|
integer/int32 |
Error code. |
Yes |
|
string |
Error message. |
Yes |
7.5.2.2. Person¶
Person entity.
Attribute |
Type |
Description |
Required |
---|---|---|---|
|
string |
The unique id for this person. Constraints: read only |
|
|
string |
Constraints: possible values are |
Yes |
|
string |
Constraints: possible values are |
Yes |
7.5.2.3. Identity¶
Attribute |
Type |
Description |
Required |
---|---|---|---|
|
string |
Constraints: read only |
Yes |
|
string |
Yes |
|
|
string |
Constraints: possible values are |
Yes |
|
Array of string |
The list of galleries for this object. Constraints: minItems is 1; items must be unique |
|
|
string/byte |
||
|
Object of type ContextualData |
||
|
Object of type BiographicData |
The set of biographic data. |
|
|
Array of BiometricData |
||
|
Array of DocumentData |
7.5.2.4. ContextualData¶
Attribute |
Type |
Description |
Required |
---|---|---|---|
|
Additional properties |
Example #1:
{
"enrollmentDate": "2019-01-11"
}
7.5.2.5. BiographicData¶
The set of biographic data.
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¶
Attribute |
Type |
Description |
Required |
---|---|---|---|
|
string |
Type of document. Constraints: possible values are |
Yes |
|
string |
Details about the type of document when OTHER is used. |
|
|
string |
Used to separate two distincts documents of the same type (ex: two passports). |
|
|
Array of DocumentPart |
Constraints: minItems is 1 |
Yes |
7.5.2.7. DocumentPart¶
Attribute |
Type |
Description |
Required |
---|---|---|---|
|
Array of integer |
The pages included in this part. Can be a single page number, or a list. Constraints: minItems is 1 |
|
|
string/byte |
Base64-encoded data of the document. |
|
|
string/uri |
URI to the data. |
|
|
integer |
the width of the image in pixels. |
|
|
integer |
the height of the image in pixels. |
|
|
string |
the nature and format of the document. The mime type definitions should be in compliance with RFC 6838. |
|
|
string/date-time |
||
|
string |
A string identifying the device used to capture the document part. |
7.5.2.8. BiometricData¶
Attribute |
Type |
Description |
Required |
---|---|---|---|
|
string |
Constraints: possible values are |
Yes |
|
string |
Constraints: possible values are |
|
|
string |
Used to separate two distincts biometric items of the same type and subtype. |
|
|
string |
the id of the identity owner of this biometric. Constraints: read only |
|
|
string/byte |
Base64-encoded image. |
|
|
string/uri |
URI to an image. |
|
|
string/date-time |
||
|
string |
A string identifying the device used to capture the biometric. |
|
|
string |
Constraints: possible values are |
|
|
integer |
the width of the image. |
|
|
integer |
the height of the image. |
|
|
integer |
||
|
string |
the nature and format of the image. The mime type definitions should be in compliance with RFC 6838. |
|
|
integer |
the image resolution (in DPI). |
|
|
string |
Constraints: possible values are |
|
|
Array of MissingType |
Optional properties indicating if a part of the biometric data is missing. |
|
|
string |
An optional string used to convey information vendor-specific. |
|
|
string |
A comment about the biometric data. |
|
|
string/byte |
Base64-encoded template. |
|
|
string/uri |
URI to the template when it is managed in a dedicated data server. |
|
|
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. |
|
|
integer/int64 |
Quality, as a number, of the biometric. |
|
|
string |
Format of the quality. One of ISO_19794, NFIQ, or NFIQ2. Can be extended to include additional proprietary quality format. |
|
|
string |
||
|
string |
7.5.2.9. MissingType¶
Attribute |
Type |
Description |
Required |
---|---|---|---|
|
string |
Constraints: possible values are |
|
|
string |
Constraints: possible values are |
7.5.2.10. Expression¶
Attribute |
Type |
Description |
Required |
---|---|---|---|
|
string |
Yes |
|
|
string |
Constraints: possible values are |
Yes |
|
One of string, integer, number, boolean |
Yes |
7.5.2.11. Expressions¶
Attribute |
Type |
Description |
Required |
---|---|---|---|
N/A |
Array of Expression |