1. Overview
Copyright © 2015-2025 IDnow - All Rights Reserved
1.1. Version information
Version : 2.49.0
1.2. Contact information
Contact : IDnow
Contact Email : support@idnow.io
1.3. URI scheme
Host : localhost:1443
BasePath : /
Schemes : HTTPS
1.4. Tags
-
Auth : Authenticated user information
-
Document : Document management
-
Event : Event log management
-
File : File management
-
Health : Health indicator
-
Realm : Realm management. Requires admin privileges
-
Task : Asynchronous task management
2. Compatibility policy
Wherever possible, REST resources and their representations will be maintained in a backwards compatible manner.
If it is necessary to change a representation in a way that is not backwards compatible, a new resource (or media type) will be created using the new representation, and the old resource (or media type) will be maintained in accordance with the deprecation policy, attached at the end of this document.
The behaviour of an API may change without warning if the existing behaviour is incorrect or constitutes a security vulnerability.
2.1. Backwards compatibility
An API is Backwards Compatible if a program written against one version of that API will continue to work the same way, without modification, against future versions of the API.
Stable URIs
If a resource exists at a particular URI, that same resource will continue to exist with the same meaning in future versions. This means:
-
The meaning of HTTP response codes can be trusted. If a URI that used to 200 now returns a 404, you know it is because the resource cannot be found, not because the resource has moved to another location
-
A resource MAY support additional query parameters in future versions but they WILL NOT be mandatory. The absence of a value or a default value (as appropriate) will maintain prior behaviour
-
If a resource accepts a representation (e.g. via POST or PUT), it will continue to accept the same representation in future versions. Any additional properties that are recognised in a resource WILL NOT be mandatory, and the default value assumed in their absence will be chosen to maintain the previous meaning of the resource
-
A resource MAY be modified to return a "redirection" response code (e.g. 301, 302) instead of directly returning the resource. Clients MUST handle HTTP-level redirects, and respect HTTP headers (e.g. Location)
-
The canonical URI of a resource used in "self links" or used by other resources to point to the resource MAY change
2.1.1. Stable representations
If the resource at a URI is documented as being available in a specific media type (e.g. via the Content-Type header), that media type will be maintained. If a resource returns a default media type in the absence of content negotiation, that default will be maintained.
2.1.2. Structured representations (application/json)
Resources with a media type of application/json have additional stability guarantees.
If a property exists in a JSON object returned by the REST API, it will continue to be returned with the same name, and the same value type (i.e. String, number, array or object). If that value is an array, the type of the contents of the array will not change. If the value is an object, that object will satisfy the same compatibility guarantees as the document as a whole:
-
If a property has a primitive type and the API documentation does not explicitly limit its possible values, clients MUST NOT assume the values are constrained to a particular set of possible responses
-
If a property of an object is not explicitly declared as mandatory in the API, clients MUST NOT assume it will be present
-
New properties MAY be added to a representation at any time, but a new property MUST NOT alter the meaning of an existing property
-
If a property of an object is a URI, then the resource identified by that URI MUST maintain the same compatibility guarantee
2.1.3. Resource/rate limits and paging
Resource and rate limits, and the default and maximum sizes of paged data ARE NOT considered part of the API and may change (possibly dynamically). It is the responsibility of the client to read the road signs and obey the speed limit.
2.2. API versioning
Responses will not be tagged with the version of the API. Clients should be aware that the deployed API version might change without notice, even between requests. The recommended way for a client to proactively determine if a particular capability is available in the API is to request it and see if it is there, and handle failure gracefully if that capability becomes unavailable during an interaction.
2.3. Forward compatibility
An API is Forwards Compatible if a program written against one version of the API will also work the same way, without modification, against previous versions of the API.
We make no guarantee of Forwards Compatibility in our REST APIs, but we provide the following non-normative guidelines about our approach to forwards compatibility.
Postel’s Law Be conservative in what you do, be liberal in what you accept from others
Where possible, we follow the Robustness Principle above. This means that the API will determine what to do with a request based only on the parts of that it recognises.
-
Request query parameters that are not recognised by the server will be ignored
-
Properties of structured (i.e. JSON) data submitted via mutative requests that are not recognised by the server will be ignored
3. API Endpoints
The CIS API involves two distinct endpoints :
-
The authentication service. It is an OpendID Connect server whom token endpoint has to be used to gain access to the main CIS API
-
The main CIS API, protected with OpendID Connect
3.1. Credentials
To connect to the authentication endpoint, you will need the following elements:
-
User login
-
User password
-
Client Id ("cis-api-client" unless explicitly mentioned)
-
Realm name
Connecting to the CIS main API requires
-
A token generated on the authentication endpoint
-
Realm name
3.2. URLs
3.2.1. Sandbox
For testing purpose, AriadNEXT provides a dedicated platform that can be accessed at the following URLs:
Authentication URL
https://api.idcheck-sandbox.ariadnext.io/auth/realms/customer-identity/protocol/openid-connect/token
CIS API base URL
https://api.idcheck-sandbox.ariadnext.io/gw/cis/
For example, searching the files in the "testing" realm is possible via a request to the URL:
https://api.idcheck-sandbox.ariadnext.io/gw/cis/rest/v1/testing/file/search
3.2.2. Production
Authentication URL
https://api.idcheck.ariadnext.io/auth/realms/customer-identity/protocol/openid-connect/token
CIS API base URL
https://api.idcheck.ariadnext.io/gw/cis
For example, searching the files in the "testing" realm is possible via a request to the URL:
https://api.idcheck.ariadnext.io/gw/cis/rest/v1/testing/file/search
4. Resources
4.1. Auth
Authenticated user information
4.1.1. Get user info
GET /rest/v1/{realm}/auth/userInfo
Description
Get user info
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
realm |
Realm name |
string |
Consumes
-
application/json
Produces
-
application/json
4.2. Document
Document management
4.2.1. Create document
POST /rest/v1/{realm}/document
Description
Create document
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Query |
fileUid |
File identifier |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Body |
request |
Document request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created (synchronous mode) |
|
202 |
Accepted (asynchronous mode) |
Consumes
-
application/json
Produces
-
application/json
4.2.2. Create and check document
POST /rest/v1/{realm}/document/check
Description
Create and check document (not allowed for documents of type "DATA")
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
realm |
Realm name |
string |
Query |
fileUid |
File identifier |
string |
Body |
request |
Document request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
Consumes
-
application/json
Produces
-
application/json
4.2.3. Search documents
GET /rest/v1/{realm}/document/search
Description
Search documents matching given criteria
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Query |
direction |
Direction |
enum (asc, desc) |
|
Query |
evidenceKey |
EvidenceKey |
string |
|
Query |
fileUid |
File uid |
string |
|
Query |
fromCreationDate |
From creation date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
fromExpirationDate |
From expiration date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
fromLastUpdateDate |
From last update date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
isFromUI |
Is this request performed from cis backoffice interface |
boolean |
|
Query |
lastAnalysisStatuses |
Last analysis statuses |
< enum (OK, IN_PROGRESS, MANUAL_IN_PROGRESS, LIVENESS_IN_PROGRESS, EMRTD_IN_PROGRESS, VIDEOSCAN_IN_PROGRESS, CORRELATION_SEARCH_IN_PROGRESS, EXTRA_ANALYSIS_IN_PROGRESS, ERROR) > array(multi) |
|
Query |
lastReportStatuses |
Last report statuses |
< enum (NONE, OK, WARN, ERROR, OBSOLETE) > array(multi) |
|
Query |
limit |
Number of documents returned (1 to 50) |
integer (int32) |
|
Query |
locations |
Locations |
< string > array(multi) |
|
Query |
offset |
Offset |
integer (int32) |
|
Query |
order |
Order |
enum (lastReportStatus, creationDate, lastUpdateDate, expirationDate) |
|
Query |
owner |
Owner |
string |
|
Query |
toCreationDate |
To creation date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
toExpirationDate |
To expiration date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
toLastUpdateDate |
To last update date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
totalOnly |
Return only the number of results found |
boolean |
|
Query |
types |
Document types |
< enum (ID, IBAN, CHEQUE, TAX_SHEET, PAY_SLIP, ADDRESS_PROOF, CREDIT_CARD, PORTRAIT, LEGAL_ENTITY, CAR_REGISTRATION, LIVENESS, DATA) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.2.4. Get document
GET /rest/v1/{realm}/document/{uid}
Description
Get document with the given uid
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
realm |
Realm name |
string |
Path |
uid |
Document uid |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.2.5. Update document
PUT /rest/v1/{realm}/document/{uid}
Description
Update document
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
Document uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Body |
updateRequest |
Update request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK (synchronous mode) |
|
202 |
Accepted (asynchronous mode) |
Consumes
-
application/json
Produces
-
application/json
4.2.6. Delete document
DELETE /rest/v1/{realm}/document/{uid}
Description
Delete document with the given uid
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
Document uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted (asynchronous mode) |
|
204 |
No content (synchronous mode) |
object |
Consumes
-
application/json -
*/*
Produces
-
application/json
4.2.7. Add images to document
POST /rest/v1/{realm}/document/{uid}/addImages
Description
Add images to document
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
Document uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Body |
images |
Image requests |
< ImageRequest > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK (synchronous mode) |
< ImageResponse > array |
202 |
Accepted (asynchronous mode) |
Consumes
-
application/json
Produces
-
application/json
4.2.8. Check document
POST /rest/v1/{realm}/document/{uid}/check
Description
Check document with given uid
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
Document uid |
string |
|
Query |
disableManualAnalysis |
Deprecated - use manualAnalysis = DISABLE instead |
boolean |
|
Query |
forceDocumentAnalysis |
Force document analysis |
boolean |
|
Query |
manualAnalysis |
Manage manual analysis (FORCE or DISABLE) |
enum (DISABLE, FORCE) |
|
Query |
synchronous |
Synchronous (Required to set to "false" for analysis type = "DATA") |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK (synchronous mode) |
|
202 |
Accepted (asynchronous mode) |
|
204 |
No content (synchronous mode) |
object |
Consumes
-
application/json -
*/*
Produces
-
application/json
4.2.9. Get document check report
GET /rest/v1/{realm}/document/{uid}/check/{checkUid}
Description
Get document check report with the given uid
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
checkUid |
check report uid |
string |
Path |
realm |
Realm name |
string |
Path |
uid |
Document uid |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.2.10. Clone document
POST /rest/v1/{realm}/document/{uid}/clone
Description
Clone document
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
uid |
string |
|
Query |
fileUid |
fileUid |
string |
|
Query |
synchronous |
Synchronous |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Cloned file |
|
201 |
Task accepted |
Consumes
-
*/*
Produces
-
application/json
4.2.11. Get image
GET /rest/v1/{realm}/document/{uid}/image/{imageUid}
Description
Get image with the given uid
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
imageUid |
Image uid |
string |
|
Path |
realm |
Realm name |
string |
|
Path |
uid |
Document uid |
string |
|
Query |
doWatermarking |
Force image watermarking if user has enough privileges |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string (byte) |
Consumes
-
application/json
Produces
-
*/*
4.2.12. Delete image
DELETE /rest/v1/{realm}/document/{uid}/image/{imageUid}
Description
Delete image with the given uid
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
imageUid |
Image uid |
string |
|
Path |
realm |
Realm name |
string |
|
Path |
uid |
Document uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted (asynchronous mode) |
|
204 |
No content (synchronous mode) |
object |
Consumes
-
application/json -
*/*
Produces
-
application/json
4.2.13. Get image thumbnail
GET /rest/v1/{realm}/document/{uid}/image/{imageUid}/thumbnail
Description
Get image thumbnail corresponding to the given image uid
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
imageUid |
Image uid |
string |
|
Path |
realm |
Realm name |
string |
|
Path |
uid |
Document uid |
string |
|
Query |
doWatermarking |
Force image watermarking if user has enough privileges |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string (byte) |
Consumes
-
application/json
Produces
-
*/*
4.2.14. Get PDF report
GET /rest/v1/{realm}/document/{uid}/report
Description
Get PDF document report for the given document uid
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
Document uid |
string |
|
Query |
doWatermarking |
Force PDF watermarking if user has enough privileges |
boolean |
|
Query |
pdfaCompliance |
PDF report will be PDF/A-3 compliant |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string (byte) |
Consumes
-
application/json
Produces
-
*/*
4.2.15. Get document preview
GET /rest/v1/{realm}/document/{uid}/thumbnail
Description
Get thumbnail for the given document uid
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
Document uid |
string |
|
Query |
doWatermarking |
Force thumbnail watermarking if user has enough privileges |
boolean |
|
Query |
part |
Document part |
enum (RECTO, VERSO, OTHER) |
|
Query |
type |
Image type |
enum (DL, IR, UV) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string (byte) |
Consumes
-
application/json
Produces
-
*/*
4.3. Event
Event log management
4.3.1. Search events
GET /rest/v1/{realm}/events
Description
Search events matching given criteria
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Query |
direction |
Direction |
enum (asc, desc) |
|
Query |
eventStatus |
Event status |
enum (OK, KO) |
|
Query |
eventTypes |
Event types |
< enum (CREATE_FILE, CLONE_FILE, UPDATE_FILE, REMOVE_FILE, CHECK_FILE, LINK_DOCUMENT, UNLINK_DOCUMENT, ADD_COMMENT, UPDATE_COMMENT, REMOVE_COMMENT, ADD_ATTACHMENT, UPDATE_ATTACHMENT, REMOVE_ATTACHMENT, CREATE_DOCUMENT, CLONE_DOCUMENT, UPDATE_DOCUMENT, REMOVE_DOCUMENT, CHECK_DOCUMENT, FASTCHECK_DOCUMENT, ADD_IMAGE, REMOVE_IMAGE, START_MANUAL_ANALYSIS, MANUAL_ANALYSIS_RESULT, START_LIVENESS, LIVENESS_ANALYSIS_RESULT, START_CORRELATION_SEARCH, CORRELATION_SEARCH_RESULT, START_STOLEN_LOST_DOCUMENTS_VERIFICATION, STOLEN_LOST_DOCUMENTS_RESULT, START_IBAN_OWNERSHIP_VERIFICATION, IBAN_OWNERSHIP_VERIFICATION_RESULT, START_EMRTD, EMRTD_READING, START_VIDEOSCAN, VIDEOSCAN_RESULT, START_CPF_VERIFICATION, CPF_VERIFICATION_RESULT) > array(multi) |
|
Query |
fromEventDate |
From event date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
isFromUI |
Is this request performed from cis backoffice interface |
boolean |
|
Query |
limit |
Number of events returned (1 to 200) |
integer (int32) |
|
Query |
offset |
Offset |
integer (int32) |
|
Query |
order |
Order |
enum (eventDate, eventStatus, eventType) |
|
Query |
owner |
Owner |
string |
|
Query |
toEventDate |
To event date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
totalOnly |
Return only the number of results found |
boolean |
|
Query |
uid |
uid |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.4. File
File management
4.4.1. Create file
POST /rest/v1/{realm}/file
Description
Create file
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Body |
request |
File request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created (synchronous mode) |
|
202 |
Accepted (asynchronous mode) |
Consumes
-
application/json
Produces
-
application/json
4.4.2. Search files
GET /rest/v1/{realm}/file/search
Description
Search files matching search criteria
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Query |
direction |
Direction |
enum (asc, desc) |
|
Query |
fromCreationDate |
From creation date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
fromLastUpdateDate |
From last update date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
isFromUI |
Is this request performed from cis backoffice interface |
boolean |
|
Query |
lastAnalysisStatuses |
Last analysis statuses |
< enum (OK, IN_PROGRESS, MANUAL_IN_PROGRESS, LIVENESS_IN_PROGRESS, EMRTD_IN_PROGRESS, VIDEOSCAN_IN_PROGRESS, CORRELATION_SEARCH_IN_PROGRESS, EXTRA_ANALYSIS_IN_PROGRESS, ERROR) > array(multi) |
|
Query |
lastReportStatuses |
Last report statuses |
< enum (NONE, OK, WARN, ERROR, OBSOLETE) > array(multi) |
|
Query |
limit |
Number of files returned (1 to 50) |
integer (int32) |
|
Query |
locations |
Locations |
< string > array(multi) |
|
Query |
name |
Name |
string |
|
Query |
offset |
Offset |
integer (int32) |
|
Query |
order |
Order |
enum (creationDate, lastReportStatus, lastUpdateDate) |
|
Query |
owner |
Owner |
string |
|
Query |
states |
states |
< string > array(multi) |
|
Query |
tag |
Tag |
string |
|
Query |
toCreationDate |
To creation date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
toLastUpdateDate |
To last update date (format RFC-339 date or date-time) |
string (date-time) |
|
Query |
totalOnly |
Return only the number of results found |
boolean |
|
Query |
type |
Type |
string |
|
Query |
uid |
file uid |
string |
|
Query |
validities |
Validities |
< enum (VALID, INVALID, NOT_VALIDATED) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.4.3. Get file
GET /rest/v1/{realm}/file/{uid}
Description
Get file with the given uid
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
realm |
Realm name |
string |
Path |
uid |
file uid |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.4.4. Update file
PUT /rest/v1/{realm}/file/{uid}
Description
Update file
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
file uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Body |
request |
file Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK (synchronous mode) |
|
202 |
Accepted (asynchronous mode) |
Consumes
-
application/json
Produces
-
application/json
4.4.5. Delete file
DELETE /rest/v1/{realm}/file/{uid}
Description
Delete file with the given uid
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
File uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted (asynchronous mode) |
|
204 |
No content (synchronous mode) |
object |
Consumes
-
application/json -
*/*
Produces
-
application/json
4.4.6. Add attachment to file
POST /rest/v1/{realm}/file/{uid}/attachment
Description
Add attachment to file
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
file uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Body |
attachment |
Attachment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK (synchronous mode) |
|
202 |
Accepted (asynchronous mode) |
Consumes
-
application/json
Produces
-
application/json
4.4.7. Get attachment
GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}
Description
Get attachment
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
attachmentUid |
Attachment uid |
string |
Path |
realm |
Realm name |
string |
Path |
uid |
file uid |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.4.8. Update attachment
PUT /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}
Description
Update attachment
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
attachmentUid |
Attachment uid |
string |
|
Path |
realm |
Realm name |
string |
|
Path |
uid |
file uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Body |
attachment |
Attachment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK (synchronous mode) |
|
202 |
Accepted (asynchronous mode) |
Consumes
-
application/json
Produces
-
application/json
4.4.9. Delete attachment
DELETE /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}
Description
Delete attachment
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
attachmentUid |
Attachment uid |
string |
|
Path |
realm |
Realm name |
string |
|
Path |
uid |
file uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted (asynchronous mode) |
|
204 |
No content (synchronous mode) |
object |
Consumes
-
application/json -
*/*
Produces
-
application/json
4.4.10. Download attachment
GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}/download
Description
Download attachment
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
attachmentUid |
Attachment uid |
string |
Path |
realm |
Realm name |
string |
Path |
uid |
file uid |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string (byte) |
Consumes
-
application/json
Produces
-
*/*
4.4.11. Download attachment thumbnail
GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}/thumbnail
Description
Download attachment thumbnail
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
attachmentUid |
Attachment uid |
string |
Path |
realm |
Realm name |
string |
Path |
uid |
file uid |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string (byte) |
Consumes
-
application/json
Produces
-
*/*
4.4.12. Check file
POST /rest/v1/{realm}/file/{uid}/check
Description
Check file with given uid
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
File uid |
string |
|
Query |
disableManualAnalysis |
Deprecated - use manualAnalysis = DISABLE instead |
boolean |
|
Query |
forceDocumentAnalysis |
Force document analysis |
boolean |
|
Query |
manualAnalysis |
Manage manual analysis (FORCE or DISABLE) |
enum (DISABLE, FORCE) |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK (synchronous mode) |
|
202 |
Accepted (asynchronous mode) |
|
204 |
No content (synchronous mode) |
object |
Consumes
-
application/json -
*/*
Produces
-
application/json
4.4.13. Get file check report
GET /rest/v1/{realm}/file/{uid}/check/{checkUid}
Description
Get file check report with the given uid
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
checkUid |
Check report uid |
string |
Path |
realm |
Realm name |
string |
Path |
uid |
file uid |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.4.14. Clone file
POST /rest/v1/{realm}/file/{uid}/clone
Description
Clone file
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
uid |
string |
|
Query |
newFileUid |
newFileUid |
string |
|
Query |
synchronous |
Synchronous |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Cloned file |
|
201 |
Task accepted |
Consumes
-
*/*
Produces
-
application/json
4.4.15. Add comment to file
POST /rest/v1/{realm}/file/{uid}/comment
Description
Add comment to file
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
file uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Body |
comment |
Comment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK (synchronous mode) |
|
202 |
Accepted (asynchronous mode) |
Consumes
-
application/json
Produces
-
application/json
4.4.16. Update comment
PUT /rest/v1/{realm}/file/{uid}/comment/{commentUid}
Description
Update comment
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
commentUid |
Comment uid |
string |
|
Path |
realm |
Realm name |
string |
|
Path |
uid |
file uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Body |
comment |
Comment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK (synchronous mode) |
|
202 |
Accepted (asynchronous mode) |
Consumes
-
application/json
Produces
-
application/json
4.4.17. Delete comment
DELETE /rest/v1/{realm}/file/{uid}/comment/{commentUid}
Description
Delete comment
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
commentUid |
Comment uid |
string |
|
Path |
realm |
Realm name |
string |
|
Path |
uid |
file uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted (asynchronous mode) |
|
204 |
No content (synchronous mode) |
object |
Consumes
-
application/json -
*/*
Produces
-
application/json
4.4.18. Link document to file
POST /rest/v1/{realm}/file/{uid}/link/{documentUid}
Description
Link document to file
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
documentUid |
Document uid |
string |
|
Path |
realm |
Realm name |
string |
|
Path |
uid |
file uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted (asynchronous mode) |
|
204 |
No content (synchronous mode) |
object |
Consumes
-
application/json -
*/*
Produces
-
application/json
4.4.19. Unlink document from file
DELETE /rest/v1/{realm}/file/{uid}/link/{documentUid}
Description
Unlink document from file
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
documentUid |
Document uid |
string |
|
Path |
realm |
Realm name |
string |
|
Path |
uid |
file uid |
string |
|
Query |
synchronous |
Synchronous mode |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
202 |
Accepted (asynchronous mode) |
|
204 |
No content (synchronous mode) |
object |
Consumes
-
application/json -
*/*
Produces
-
application/json
4.4.20. Get PDF report
GET /rest/v1/{realm}/file/{uid}/report
Description
Get PDF file report for the given file uid
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
uid |
file uid |
string |
|
Query |
doWatermarking |
Force PDF watermarking if user has enough privileges |
boolean |
|
Query |
pdfaCompliance |
PDF report will be PDF/A-3 compliant |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string (byte) |
Consumes
-
application/json
Produces
-
*/*
4.5. Health
Health indicator
4.5.1. Get health
GET /rest/health
Description
Get health
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.6. Realm
Realm management. Requires admin privileges
4.6.1. Get realm
GET /rest/v1/realm/{realm}
Description
Get realm with given name
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
realm |
Realm name |
string |
Consumes
-
application/json
Produces
-
application/json
4.6.2. Update realm
PUT /rest/v1/realm/{realm}
Description
Update realm
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
realm |
Realm name |
string |
Body |
realmRequest |
Realm request |
Consumes
-
application/json
Produces
-
application/json
4.6.3. Create a notification endpoint
POST /rest/v1/realm/{realm}/endpoint
Description
Create a notification endpoint
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
realm |
realm |
string |
Body |
request |
request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.6.4. Get a notification endpoint
GET /rest/v1/realm/{realm}/endpoint/{clientId}
Description
Get a notification endpoint
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
clientId |
clientId |
string |
Path |
realm |
realm |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.6.5. Update a notification endpoint
PUT /rest/v1/realm/{realm}/endpoint/{clientId}
Description
Update a notification endpoint
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
clientId |
clientId |
string |
Path |
realm |
realm |
string |
Body |
request |
Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.6.6. Delete notification endpoint
DELETE /rest/v1/realm/{realm}/endpoint/{clientId}
Description
Delete notification endpoint
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
clientId |
clientId |
string |
Path |
realm |
realm |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
Consumes
-
*/*
Produces
-
application/json
4.6.7. Create a notification event
POST /rest/v1/realm/{realm}/endpoint/{clientId}/event
Description
Create a notification event
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
clientId |
endpoint clientId |
string |
Path |
realm |
realm |
string |
Body |
request |
request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
4.6.8. Delete a notification event
DELETE /rest/v1/realm/{realm}/endpoint/{clientId}/event
Description
Delete a notification event
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
clientId |
clientId |
string |
Path |
realm |
realm |
string |
Query |
kind |
kind |
enum (FILE, DOCUMENT) |
Query |
method |
method |
enum (CREATE, UPDATE, DELETE) |
Query |
operation |
operation |
enum (DEFAULT, CLONE, STATE, VALIDITY, CHECK, CHECK_DOCUMENT, START_MANUAL_ANALYSIS, START_MANUAL_ANALYSIS_DOCUMENT, START_CORRELATION_SEARCH, START_CORRELATION_SEARCH_DOCUMENT, START_STOLEN_LOST_DOCUMENTS_VERIFICATION, START_STOLEN_LOST_DOCUMENTS_VERIFICATION_DOCUMENT, START_IBAN_OWNERSHIP_VERIFICATION, START_IBAN_OWNERSHIP_VERIFICATION_DOCUMENT, ADD_DOCUMENT, REMOVE_DOCUMENT, ADD_IMAGE, REMOVE_IMAGE, ADD_COMMENT, UPDATE_COMMENT, REMOVE_COMMENT, ADD_ATTACHMENT, UPDATE_ATTACHMENT, REMOVE_ATTACHMENT, START_CPF_VERIFICATION) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
Consumes
-
*/*
Produces
-
application/json
4.6.9. Get notification endpoints
GET /rest/v1/realm/{realm}/endpoints
Description
Get notification endpoints
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
realm |
realm |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< NotificationEndpoint > array |
Consumes
-
application/json
Produces
-
application/json
4.7. Task
Asynchronous task management
4.7.1. Get task
GET /rest/v1/{realm}/task/{taskId}
Description
Get task with the given uid
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
realm |
Realm name |
string |
|
Path |
taskId |
Task uid |
string |
|
Query |
waitTime |
Wait time (in msec) |
integer (int64) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
application/json
5. Security
5.1. OAuth2
Type : oauth2
Flow : application
Token URL : https://api.ariadnext.com/auth/realms/customer-identity/protocol/openid-connect/token
| Name | Description |
|---|---|
secured |
Resource is secured, user needs to be authenticated to access it. |
6. Definitions
6.1. AttachmentRequest
| Name | Description | Schema |
|---|---|---|
contentBase64 |
base64 content |
string |
description |
Description |
string |
fileName |
file name |
string |
technicalData |
Technical data |
< MapItem > array |
title |
Title |
string |
type |
Type. Max. length: 45 |
string |
6.2. AttachmentResponse
| Name | Description | Schema |
|---|---|---|
date |
creation date |
string (date-time) |
description |
description |
string |
fileName |
file name |
string |
fileUid |
file identifier |
string |
technicalData |
Technical data |
< MapItem > array |
title |
title |
string |
type |
type |
string |
uid |
attachment identifier |
string |
6.3. AttachmentSummary
| Name | Description | Schema |
|---|---|---|
date |
creation date |
string (date-time) |
description |
description |
string |
fileName |
file name |
string |
mediaType |
media type |
string |
title |
title |
string |
type |
type |
string |
uid |
attachment identifier |
string |
6.4. AttachmentUpdateRequest
| Name | Description | Schema |
|---|---|---|
description |
Description |
string |
technicalData |
Technical data |
< MapItem > array |
title |
Title |
string |
type |
Type. Max length: 45 |
string |
6.5. Check
| Name | Description | Schema |
|---|---|---|
dataReferences |
Data references |
< DataReference > array |
documentUid |
Document uid |
string |
errorCause |
Error cause |
|
fileUid |
File uid |
string |
identifier |
Check identifier |
string |
message |
Complete message |
string |
status |
Check status |
enum (NONE, OK, WARN, ERROR, OBSOLETE) |
subChecks |
Sub checks |
< Check > array |
title |
Title |
string |
type |
Check type |
enum (DOCUMENT_VALIDITY, DOCUMENT_ACCEPTABILITY, DATA_ACCEPTABILITY, DATA_CONSISTENCY, FILE_COMPLETENESS, OTHER, UNKNOWN) |
6.6. CustomerIdentity
| Name | Description | Schema |
|---|---|---|
addressData |
Address data |
|
chequeData |
Cheque data |
|
creationDate |
Creation date |
string (date-time) |
documentUids |
Bound documents |
< string > array |
extraDocuments |
Extra documents |
< ExtraDocuments > array |
financeData |
Finance data |
|
identityData |
Identity data |
|
jobData |
Job data |
|
legalEntityData |
Legal entity data |
|
role |
Role |
|
uid |
Unique identifier |
string |
vehicleData |
Vehicle data |
6.7. DataReference
| Name | Description | Schema |
|---|---|---|
expectedReference |
Expected reference |
string |
expectedValue |
Expected value |
string |
givenReference |
Given reference |
string |
givenValue |
Given value |
string |
6.8. DeviceInfo
| Name | Description | Schema |
|---|---|---|
model |
Device model |
string |
nfcAvailable |
NFC is available on the device |
boolean |
osVersion |
Device OS version |
string |
sdk |
SDK used for capturing this document |
string |
sdkEmrtdActivated |
SDK is configured to read NFC chips |
boolean |
sdkVersion |
SDK version embedded on the device |
string |
sdkVideoScanActivated |
SDK is configured to do a video of ID documents |
boolean |
sensorLabel |
Name of the camera used during the capture |
string |
6.9. DocumentCustomer
| Name | Description | Schema |
|---|---|---|
customers |
List of generated customers |
< string > array |
documentUid |
Document identifier |
string |
6.10. DocumentInputData
| Name | Description | Schema |
|---|---|---|
clientData |
Client data |
|
infoData |
Info data |
|
persons |
Persons |
< InputPerson > array |
6.11. DocumentReference
| Name | Description | Schema |
|---|---|---|
evidenceKey |
Evidence key |
string |
subType |
Document sub type |
enum (ID, PASSPORT, RESIDENCE_PERMIT, DRIVING_LICENSE, HEALTH_CARD, VISA, IBAN, CHEQUE, ADDRESS, TAX, PAY, CREDIT_CARD, PORTRAIT, COMPANY, COMPANY_REG_CERT, CAR_REGISTRATION, LIVENESS, DATA, UNKNOWN) |
type |
Document type |
enum (ID, IBAN, CHEQUE, TAX_SHEET, PAY_SLIP, ADDRESS_PROOF, CREDIT_CARD, PORTRAIT, LEGAL_ENTITY, CAR_REGISTRATION, LIVENESS, DATA) |
uid |
Document identifier |
string |
6.12. DocumentReport
| Name | Description | Schema |
|---|---|---|
backendResultId |
backend result id |
string |
checks |
Performed checks |
< Check > array |
clientData |
Client data |
|
fromManualAnalysis |
true if this report is built from a manual analysis |
boolean |
generationDate |
Report generation date |
string (date-time) |
globalStatus |
report global status |
enum (NONE, OK, WARN, ERROR, OBSOLETE) |
info |
Info |
|
issuance |
Document issuance |
|
persons |
Persons |
< DocumentReportPerson > array |
referenceValues |
Reference values |
|
uid |
Report identifier |
string |
6.13. DocumentReportInfo
| Name | Description | Schema |
|---|---|---|
cardAccessNumber |
Card access number |
|
documentNumber |
Document number |
|
documentType |
Document type |
|
expirationDate |
Expiration date |
|
expirationDay |
Expiration day (deprecated since CIS 2.3. Use expirationDate.day instead) |
|
expirationMonth |
Expiration month (deprecated since CIS 2.3. Use expirationDate.month instead) |
|
expirationYear |
Expiration year (deprecated since CIS 2.3. Use expirationDate.year instead) |
|
extra |
Extra |
< ReportDataMapItem > array |
personalNumber |
Personal number |
|
readExpirationDate |
Read expiration date |
|
sidesIssue |
Sides issue. One of MISSING_VERSO, INVALID_VERSO, MISSING_RECTO or INVALID_RECTO |
6.14. DocumentReportIssuance
| Name | Description | Schema |
|---|---|---|
extra |
Extra |
< ReportDataMapItem > array |
issueDate |
Issue date |
|
issueDay |
Issue day (deprecated since CIS 2.3. Use issueDate.day instead) |
|
issueMonth |
Issue month (deprecated since CIS 2.3. Use issueDate.month instead) |
|
issueYear |
Issue year (deprecated since CIS 2.3. Use issueDate.year instead) |
|
issuingAuthority |
Issuing authority |
|
issuingCountry |
Issuing country |
6.15. DocumentReportPerson
| Name | Description | Schema |
|---|---|---|
addressData |
Address data |
|
chequeData |
cheque data |
|
consumptionData |
Consumption address data |
|
financeData |
Finance data |
|
identityData |
Identity data |
|
jobData |
Job data |
|
legalEntityData |
Legal entity data |
|
role |
Role |
|
vehicleData |
Vehicle data |
6.16. DocumentRequest
| Name | Description | Schema |
|---|---|---|
biometricConsent |
Consent for Data processing of biometric documents. Mandatory for biometric documents |
boolean |
country |
Country (Alpha2 or Alpha3 code) as defined in ISO 3166-1 |
string |
enableNotifications |
Enable callback notifications, default false |
boolean |
evidenceKey |
Evidence key. Must be unique per file. Max. length: 100 |
string |
images |
Images |
< ImageRequest > array |
inputData |
Input data |
|
location |
Document location. Max. length: 512 |
string |
technicalData |
Technical data |
< MapItem > array |
type |
Document type |
enum (ID, IBAN, CHEQUE, TAX_SHEET, PAY_SLIP, ADDRESS_PROOF, CREDIT_CARD, PORTRAIT, LEGAL_ENTITY, CAR_REGISTRATION, LIVENESS, DATA) |
6.17. DocumentResponse
| Name | Description | Schema |
|---|---|---|
biometricConsent |
Consent for Data processing of biometric documents |
boolean |
classId |
Class identifier |
string |
country |
Country (Alpha3 code) as defined in ISO 3166-1 |
string |
creationDate |
Creation date |
string (date-time) |
enableNotifications |
Enable callback notifications |
boolean |
evidenceKey |
Evidence key. Must be unique per file |
string |
extraData |
Additional data |
|
fileUid |
File identifier (in case the document is part of a file) |
string |
images |
Images |
< ImageResponse > array |
inputData |
Input data |
|
lastAnalysisStatus |
last analysis status |
enum (OK, IN_PROGRESS, MANUAL_IN_PROGRESS, LIVENESS_IN_PROGRESS, EMRTD_IN_PROGRESS, VIDEOSCAN_IN_PROGRESS, CORRELATION_SEARCH_IN_PROGRESS, EXTRA_ANALYSIS_IN_PROGRESS, ERROR) |
lastReport |
Last report generated for this document |
|
lastUpdateDate |
Last update date |
string (date-time) |
location |
Location |
string |
owner |
Owner |
string |
prettyName |
Pretty name |
string |
qualityIssues |
Image quality issues |
< ImageQualityIssues > array |
reports |
All reports generated for this document |
< ReportSummary > array |
subType |
Subtype |
enum (ID, PASSPORT, RESIDENCE_PERMIT, DRIVING_LICENSE, HEALTH_CARD, VISA, IBAN, CHEQUE, ADDRESS, TAX, PAY, CREDIT_CARD, PORTRAIT, COMPANY, COMPANY_REG_CERT, CAR_REGISTRATION, LIVENESS, DATA, UNKNOWN) |
technicalData |
Technical data |
< MapItem > array |
type |
Type |
enum (ID, IBAN, CHEQUE, TAX_SHEET, PAY_SLIP, ADDRESS_PROOF, CREDIT_CARD, PORTRAIT, LEGAL_ENTITY, CAR_REGISTRATION, LIVENESS, DATA) |
uid |
Document identifier |
string |
6.18. DocumentSearchResponse
| Name | Description | Schema |
|---|---|---|
rows |
Matching documents |
< DocumentSummary > array |
total |
Total number of matching documents |
integer (int32) |
6.19. DocumentSummary
| Name | Description | Schema |
|---|---|---|
creationDate |
Creation date |
string (date-time) |
enableNotifications |
Enable callback notifications |
boolean |
evidenceKey |
Evidence key. Must be unique per file |
string |
fileUid |
File identifier (in case the document is part of a file) |
string |
lastAnalysisStatus |
Last analysis status |
enum (OK, IN_PROGRESS, MANUAL_IN_PROGRESS, LIVENESS_IN_PROGRESS, EMRTD_IN_PROGRESS, VIDEOSCAN_IN_PROGRESS, CORRELATION_SEARCH_IN_PROGRESS, EXTRA_ANALYSIS_IN_PROGRESS, ERROR) |
lastReportStatus |
Last report status for this document |
enum (NONE, OK, WARN, ERROR, OBSOLETE) |
lastUpdateDate |
Last update date |
string (date-time) |
owner |
Owner |
string |
type |
Type |
enum (ID, IBAN, CHEQUE, TAX_SHEET, PAY_SLIP, ADDRESS_PROOF, CREDIT_CARD, PORTRAIT, LEGAL_ENTITY, CAR_REGISTRATION, LIVENESS, DATA) |
uid |
Document identifier |
string |
6.20. DocumentUpdateRequest
| Name | Description | Schema |
|---|---|---|
country |
Country (Alpha2 or Alpha3 code) as defined in ISO 3166-1 |
string |
enableNotifications |
Enable notifications |
boolean |
evidenceKey |
Evidence key. Must be unique per file. Max length: 100 |
string |
inputData |
Input data |
|
location |
Document location. Max. length: 512 |
string |
technicalData |
Technical data |
< MapItem > array |
6.21. EMRTDData
| Name | Description | Schema |
|---|---|---|
deviceCompatible |
Device is compatible with eMRTD (not blacklisted) |
boolean |
errorMessage |
Error message if eMRTD session is FINISHED_ERROR |
string |
nfcAuthorized |
User accepted NFC activation |
boolean |
sessionStatus |
Status of the eMRTD reading session |
enum (IN_PROGRESS, FINISHED_OK, FINISHED_ERROR) |
6.22. EventResponse
| Name | Description | Schema |
|---|---|---|
documentUid |
Event document uid |
string |
entityDetail |
Event entity detail |
string |
entityType |
Event entity type |
enum (FILE, DOCUMENT, IMAGE) |
entityUid |
Event entity uid |
string |
eventDate |
Event date |
string (date-time) |
eventId |
Event identifier |
integer (int64) |
eventMessage |
Event message |
string |
eventMessageKey |
Event message key |
string |
eventStatus |
Event status |
enum (OK, KO) |
eventType |
Event type |
enum (CREATE_FILE, CLONE_FILE, UPDATE_FILE, REMOVE_FILE, CHECK_FILE, LINK_DOCUMENT, UNLINK_DOCUMENT, ADD_COMMENT, UPDATE_COMMENT, REMOVE_COMMENT, ADD_ATTACHMENT, UPDATE_ATTACHMENT, REMOVE_ATTACHMENT, CREATE_DOCUMENT, CLONE_DOCUMENT, UPDATE_DOCUMENT, REMOVE_DOCUMENT, CHECK_DOCUMENT, FASTCHECK_DOCUMENT, ADD_IMAGE, REMOVE_IMAGE, START_MANUAL_ANALYSIS, MANUAL_ANALYSIS_RESULT, START_LIVENESS, LIVENESS_ANALYSIS_RESULT, START_CORRELATION_SEARCH, CORRELATION_SEARCH_RESULT, START_STOLEN_LOST_DOCUMENTS_VERIFICATION, STOLEN_LOST_DOCUMENTS_RESULT, START_IBAN_OWNERSHIP_VERIFICATION, IBAN_OWNERSHIP_VERIFICATION_RESULT, START_EMRTD, EMRTD_READING, START_VIDEOSCAN, VIDEOSCAN_RESULT, START_CPF_VERIFICATION, CPF_VERIFICATION_RESULT) |
fileUid |
Event file uid |
string |
owner |
Event owner |
string |
6.23. EventSearchResponse
| Name | Description | Schema |
|---|---|---|
rows |
Rows |
< EventResponse > array |
total |
Total number of rows |
integer (int32) |
6.24. ExtraData
| Name | Description | Schema |
|---|---|---|
deviceInfo |
Info about the device that captured documents |
|
emrtdData |
eMRTD analysis related data (NFC chip embedded in some documents) |
|
envelopeKeys |
Available envelope keys |
< string > array |
livenessData |
Liveness data (biometric liveness) |
|
videoScanData |
Videoscan related data |
6.25. ExtraDocuments
| Name | Description | Schema |
|---|---|---|
available |
number of available documents |
integer (int32) |
missing |
number of missing documents |
integer (int32) |
type |
document type |
string |
unwanted |
number of unwanted documents |
integer (int32) |
6.26. FileComment
| Name | Description | Schema |
|---|---|---|
comment |
Comment value |
string |
commentDate |
Comment creation date |
string (date-time) |
issuer |
Issuer |
string |
type |
Comment type |
string |
uid |
Comment identifier |
string |
6.27. FileCommentRequest
| Name | Description | Schema |
|---|---|---|
comment |
Comment value |
string |
type |
Comment type. Max. length: 100 |
string |
6.28. FileInputData
| Name | Description | Schema |
|---|---|---|
clientData |
Client data |
|
persons |
Persons |
< InputPerson > array |
pluginConfiguration |
Plugin configuration |
< MapItem > array |
6.29. FileReport
file report
| Name | Description | Schema |
|---|---|---|
checks |
Performed checks |
< Check > array |
clientData |
Client data |
|
customerIdentities |
Customer identities |
< CustomerIdentity > array |
documents |
Documents |
< DocumentCustomer > array |
generationDate |
Generation date of the report |
string (date-time) |
globalStatus |
Global report status |
enum (NONE, OK, WARN, ERROR, OBSOLETE) |
referenceValues |
Reference values |
|
uid |
Report identifier |
string |
6.30. FileRequest
| Name | Description | Schema |
|---|---|---|
enableNotifications |
enable notifications, default false |
boolean |
inputData |
Input data |
|
location |
Location |
string |
state |
State. Max. length: 45 |
string |
tags |
Tags. Total max. length: 200 |
< string > array |
technicalData |
Technical data |
< MapItem > array |
type |
Type. Max. length: 45 |
string |
uid |
file identifier. Max. length: 45 |
string |
validity |
Validity |
enum (VALID, INVALID, NOT_VALIDATED) |
6.31. FileResponse
| Name | Description | Schema |
|---|---|---|
attachments |
Attachment |
< AttachmentSummary > array |
comments |
Comments |
< FileComment > array |
creationDate |
file creation date |
string (date-time) |
documents |
List of all bound documents |
< DocumentReference > array |
enableNotifications |
Enable callback notifications |
boolean |
inputData |
Input data |
|
lastAnalysisStatus |
file last analysis status |
enum (OK, IN_PROGRESS, MANUAL_IN_PROGRESS, LIVENESS_IN_PROGRESS, EMRTD_IN_PROGRESS, VIDEOSCAN_IN_PROGRESS, CORRELATION_SEARCH_IN_PROGRESS, EXTRA_ANALYSIS_IN_PROGRESS, ERROR) |
lastReport |
Last report generated for this file |
|
lastReportStatus |
file last report status |
enum (NONE, OK, WARN, ERROR, OBSOLETE) |
lastUpdateDate |
file update date |
string (date-time) |
location |
file location |
string |
owner |
file owner |
string |
reports |
List of generated reports |
< ReportSummary > array |
state |
State |
string |
tags |
Tags |
< string > array |
technicalData |
Technical data |
< MapItem > array |
type |
Type |
string |
uid |
file identifier |
string |
validity |
Validity |
enum (VALID, INVALID, NOT_VALIDATED) |
verdict |
Verdict |
6.32. FileSearchResponse
| Name | Description | Schema |
|---|---|---|
rows |
Matching files |
< FileSummary > array |
total |
Total number of matching files |
integer (int32) |
6.33. FileSummary
| Name | Description | Schema |
|---|---|---|
creationDate |
Creation date |
string (date-time) |
enableNotifications |
Enable callback notifications |
boolean |
lastAnalysisStatus |
file last analysis status |
enum (OK, IN_PROGRESS, MANUAL_IN_PROGRESS, LIVENESS_IN_PROGRESS, EMRTD_IN_PROGRESS, VIDEOSCAN_IN_PROGRESS, CORRELATION_SEARCH_IN_PROGRESS, EXTRA_ANALYSIS_IN_PROGRESS, ERROR) |
lastReportStatus |
Last report status |
enum (NONE, OK, WARN, ERROR, OBSOLETE) |
lastUpdateDate |
Update date |
string (date-time) |
owner |
file owner |
string |
state |
state |
string |
uid |
file identifier |
string |
validity |
Validity |
enum (VALID, INVALID, NOT_VALIDATED) |
6.34. HealthResponse
| Name | Description | Schema |
|---|---|---|
apiVersion |
API version |
string |
serverStatus |
Server status (UP/DOWN) |
string |
serverVersion |
Server version |
string |
6.35. ImageQualityIssues
| Name | Description | Schema |
|---|---|---|
imageUid |
Image uid |
string |
issues |
Quality issues associated to this image |
< enum (TRUNCATED_MRZ, HETEROGENEOUS_MRZ, TRUNCATED_DOCUMENT, PICTURE_RESOLUTION_INSUFFICIENT_OCR, PICTURE_BLURRED_WARN, PICTURE_BLURRED_ERROR, PICTURE_COLOR_GREY_OR_BW, PICTURE_FROM_SCREEN_CAPTURE) > array |
6.36. ImageRequest
| Name | Description | Schema |
|---|---|---|
data |
Image data (base64 encoded) |
string |
documentPart |
Image part (default value RECTO). For ID documents (incl. PASSPORT, DRIVING LICENCE, RESIDENCE PERMIT…), send RECTO or VERSO. For other document types, any value is accepted. |
enum (RECTO, VERSO, OTHER) |
type |
Image lightning type (default value DL). IR and UV images are only accepted for IDs. |
enum (DL, IR, UV) |
6.37. ImageResponse
| Name | Description | Schema |
|---|---|---|
documentPart |
Image part |
enum (RECTO, VERSO, OTHER) |
origin |
Image origin |
string |
source |
Image source |
enum (ORIGINAL, CROPPED) |
sourceImageUid |
Source image uid for cropped images |
string |
type |
Image lightning type |
enum (DL, IR, UV) |
uid |
Image identifier |
string |
6.38. InputAddressData
Input address data
| Name | Description | Schema |
|---|---|---|
city |
City |
string |
extra |
Extra |
< MapItem > array |
lines |
Address lines |
< string > array |
zipCode |
Zip code |
string |
6.39. InputClientData
Input client data
| Name | Description | Schema |
|---|---|---|
extra |
Extra |
< MapItem > array |
reference |
Client reference |
string |
6.40. InputFinanceData
Input finance data
| Name | Description | Schema |
|---|---|---|
accountKey |
Account key |
string |
accountNumber |
Account number |
string |
accountOwner |
Account owner |
string |
accountOwnerAddress |
Account owner address |
string |
bankAddress |
Bank address |
string |
bankAddressLines |
Bank address lines (deprecated since CIS 2.31.95. Use bankAddress instead) |
string |
bankCode |
Bank code |
string |
bankName |
Branch name |
string |
bic |
Bic |
string |
branchCode |
Branch code |
string |
extra |
Extra |
< MapItem > array |
iban |
Iban |
string |
ibanCountry |
Iban country |
string |
6.41. InputIdentityData
Input identity data
| Name | Description | Schema |
|---|---|---|
birthDay |
Birth day |
string |
birthDepartment |
Birth department |
string |
birthMonth |
Birth month |
string |
birthPlace |
Birth place |
string |
birthYear |
Birth year |
string |
extra |
Extra |
< MapItem > array |
firstNames |
First names |
< string > array |
fullName |
Full name |
string |
gender |
Gender |
string |
lastName |
Last name |
string |
nationality |
Nationality |
string |
personalNumber |
Personal number |
string |
ssn |
Social security number |
string |
usageName |
Usage name |
string |
6.42. InputInfoData
Input info data
| Name | Description | Schema |
|---|---|---|
documentNumber |
Document number |
string |
documentType |
Document type |
string |
expirationDay |
Expiration day |
string |
expirationMonth |
Expiration month |
string |
expirationYear |
Expiration year |
string |
extra |
Extra |
< MapItem > array |
personalNumber |
Personal number |
string |
readExpirationDay |
Read expiration day |
string |
readExpirationMonth |
Read expiration month |
string |
readExpirationYear |
Read expiration year |
string |
referenceDocument |
Reference document uid |
string |
6.43. InputJobData
Input job data
| Name | Description | Schema |
|---|---|---|
employer |
Employer name |
string |
extra |
Extra |
< MapItem > array |
income |
Income |
string |
siret |
Siret/Siren |
string |
6.44. InputLegalEntityData
Input legal entity data
| Name | Description | Schema |
|---|---|---|
uid |
Siret/Siren |
string |
6.45. InputPerson
Input person
| Name | Description | Schema |
|---|---|---|
addressData |
Address data |
|
financeData |
Finance data |
|
identityData |
Identity data |
|
jobData |
Job data |
|
legalEntityData |
Legal entity data |
|
pluginConfiguration |
Plugin configuration |
< MapItem > array |
role |
Role |
string |
6.46. LivenessData
| Name | Description | Schema |
|---|---|---|
livenessReadiness |
If document meets the requirements as a reference document to start a liveness |
enum (LIVENESS_READY, OTHER_SIDE_NEEDED, NO_FACE_DETECTED, LIVENESS_NOT_ALLOWED) |
6.47. LocalizedValueOfstring
| Name | Description | Schema |
|---|---|---|
identifier |
Identifier |
enum (DEVICE_ISSUE, DOCUMENT_ISSUE, NETWORK_ISSUE, TECHNICAL_ISSUE, USER_ISSUE, USER_CANCEL, MODEL_NFC_PROTOCOL_DEVICE_LIMITATION, BIOMETRIC_CONSENT, BAD_REFERENCE, MISSING_DATA, NO_FACE, TOO_MANY_FACES, FACE_MASK, FACE_TECHNICAL_ISSUE, OTHER_QA, CUT_CORNER, BLACKLISTED_CAMERA, INJECTION_ATTACK, CHALLENGES_NOT_PERFORMED, BARCODE_NOT_FOUND, ISSUER_TYPE_MATCH, BARCODE_TEST, SUPPORT_LEVEL_BASIC, SUPPORT_LEVEL_STANDARD, VISIBLE_FIELDS_READING_FAILED, MODEL_FIELDS_MISSING, FIELDS_EXTRACTION_FAILED, BLACKLIST_MATCH, WHITELIST_NOT_MATCH, PICTURE_COLOR_GREY_OR_BW, CORRELATION_WITH_DIFFERENT_IDENTITY, MISSING_IDENTITY_DATA, PAID_ONLY, NOT_AVAILABLE, INTERNAL_VERIFICATION, EXTERNAL_VERIFICATION, FORBIDDEN_WORDS_FOUND, MULTIPLE_DOCUMENTS_DETECTED, AGE_INFERIOR, AGE_SUPERIOR, BAD_CONFIGURATION, SUSPENDED, DECEASED_HOLDER, REGULARIZATION_PENDING, CANCELED_MULTIPLICITY, FRAUD_DETECTED, CANCELED_CRAFT, MINOR, NUMBER_NOT_FOUND, INVALID_NUMBER, SERVICE_ERROR, SERVICE_TIMEOUT, OWNER_NAME_NOT_MATCH, OWNER_BIRTHDATE_NOT_MATCH, NONEXISTENT_OR_CLOSED_ACCOUNT, INCORRECT_HOLDER_TYPE, OWNER_NAME_AND_BIRTHDATE_NOT_MATCH, BANK_DETAILS_NOT_ELIGIBLE, ADDITIONAL_IDENTITIES_NOT_MATCH_BARCODE) |
key |
key |
string |
message |
Localized message |
string |
parameters |
parameters |
< string > array |
6.48. MapItem
| Name | Description | Schema |
|---|---|---|
key |
key |
string |
value |
value |
string |
6.49. Menu
| Name | Description | Schema |
|---|---|---|
includeDefaultMenu |
include default menu |
boolean |
items |
menu items |
< MenuItem > array |
6.50. MenuItem
| Name | Description | Schema |
|---|---|---|
icon |
Icon (fontawesome or glyphicon css classes) |
string |
label |
Label |
string |
target |
Target |
enum (_self, _blank) |
tooltip |
ToolTip |
string |
url |
Url |
string |
6.51. NotificationEndpoint
| Name | Description | Schema |
|---|---|---|
active |
Optional activation field. |
boolean |
clientId |
Client id, unique for each endpoint |
string |
events |
event |
< NotificationEvent > array |
secret |
secret. |
string |
securityHeaderField |
Security header field |
|
supportEmail |
Email used to send warnings when there are callbacks issue. For example if your callback server is not available or throws an error. Works with new notifications format only. |
string |
url |
URL |
string |
6.52. NotificationEndpointRequest
| Name | Description | Schema |
|---|---|---|
active |
Optional activation field. Default: true |
boolean |
clientId |
Client id. Max. length: 100 |
string |
secret |
Secret. Max. length: 100. Deprecated: prefer SecurityHeaderField for more flexibility. |
string |
securityHeaderField |
Security header field |
|
supportEmail |
Email used to send warnings when there are callbacks issue. For example if your callback server is not available or throws an error. Works with new notifications format only. Max. length: 100 |
string |
url |
URL. Max. length: 255 |
string |
6.53. NotificationEvent
| Name | Description | Schema |
|---|---|---|
eventKind |
event kind |
enum (FILE, DOCUMENT) |
method |
event method |
enum (CREATE, UPDATE, DELETE) |
operation |
event operation |
enum (DEFAULT, CLONE, STATE, VALIDITY, CHECK, CHECK_DOCUMENT, START_MANUAL_ANALYSIS, START_MANUAL_ANALYSIS_DOCUMENT, START_CORRELATION_SEARCH, START_CORRELATION_SEARCH_DOCUMENT, START_STOLEN_LOST_DOCUMENTS_VERIFICATION, START_STOLEN_LOST_DOCUMENTS_VERIFICATION_DOCUMENT, START_IBAN_OWNERSHIP_VERIFICATION, START_IBAN_OWNERSHIP_VERIFICATION_DOCUMENT, ADD_DOCUMENT, REMOVE_DOCUMENT, ADD_IMAGE, REMOVE_IMAGE, ADD_COMMENT, UPDATE_COMMENT, REMOVE_COMMENT, ADD_ATTACHMENT, UPDATE_ATTACHMENT, REMOVE_ATTACHMENT, START_CPF_VERIFICATION) |
6.54. NotificationEventRequest
| Name | Description | Schema |
|---|---|---|
eventKind |
Event kind. |
enum (FILE, DOCUMENT) |
method |
Event method. |
enum (CREATE, UPDATE, DELETE) |
operation |
Event operation. |
enum (DEFAULT, CLONE, STATE, VALIDITY, CHECK, CHECK_DOCUMENT, START_MANUAL_ANALYSIS, START_MANUAL_ANALYSIS_DOCUMENT, START_CORRELATION_SEARCH, START_CORRELATION_SEARCH_DOCUMENT, START_STOLEN_LOST_DOCUMENTS_VERIFICATION, START_STOLEN_LOST_DOCUMENTS_VERIFICATION_DOCUMENT, START_IBAN_OWNERSHIP_VERIFICATION, START_IBAN_OWNERSHIP_VERIFICATION_DOCUMENT, ADD_DOCUMENT, REMOVE_DOCUMENT, ADD_IMAGE, REMOVE_IMAGE, ADD_COMMENT, UPDATE_COMMENT, REMOVE_COMMENT, ADD_ATTACHMENT, UPDATE_ATTACHMENT, REMOVE_ATTACHMENT, START_CPF_VERIFICATION) |
6.55. Realm
| Name | Description | Schema |
|---|---|---|
backOfficeMenu |
Menu for back office application |
|
description |
Realm description |
string |
documentTtlDays |
Unlinked documents time to live in days, default value 30 days |
integer (int32) |
enableNotificationsByDefault |
Enable callback notifications (callbacks) by default, default value false |
boolean |
enableOtherAlphabet |
boolean |
|
eventTtlDays |
Events time to live in days, default value 30 days |
integer (int32) |
fileTtlDays |
file time to live in days, default value 30 days |
integer (int32) |
locale |
Realm locale, default value FR |
enum (FR, EN) |
name |
Realm name |
string |
newNotificationFormat |
New notification format, default value false |
boolean |
signFeature |
Sign feature, default value false |
boolean |
states |
Validity states |
< StateWorkFlowStep > array |
useHeaderLocaleForMessages |
Use HTTP header 'Accept-Language' to localize error messages, default value true |
boolean |
6.56. ReportAddressData
| Name | Description | Schema |
|---|---|---|
city |
City |
|
country |
Country |
|
extra |
Extra |
< ReportDataMapItem > array |
fullAddress |
Full address lines as read on document |
|
lane |
Lane |
|
laneNumber |
Lane number |
|
zipCode |
Zip code |
6.57. ReportAdministratorData
| Name | Description | Schema |
|---|---|---|
birthDate |
birthDate |
|
name |
Name |
string |
title |
Title |
string |
6.58. ReportChequeData
| Name | Description | Schema |
|---|---|---|
chequeNumber |
cheque number |
|
cmc7 |
cmc7 |
|
cmc7Raw |
cmc7 (read value) |
|
extra |
Extra |
< ReportDataMapItem > array |
rlmc |
rlmc |
|
zib |
zib |
|
zin |
zin |
6.59. ReportClientData
| Name | Description | Schema |
|---|---|---|
extra |
Extra |
< ReportDataMapItem > array |
reference |
Client reference |
6.60. ReportDataItem
| Name | Description | Schema |
|---|---|---|
extraAlphabetValues |
Extra Alphabet Value |
< string, string > map |
label |
Label |
string |
origin |
Origin |
enum (DOCUMENT_INPUT, FILE_INPUT, DOCUMENT) |
originUid |
Origin uid |
string |
value |
Value |
string |
valueLabel |
Labeled value |
string |
6.61. ReportDataListItem
| Name | Description | Schema |
|---|---|---|
extraAlphabetValues |
Extra Alphabet Value |
object |
label |
Label |
string |
origin |
Origin |
enum (DOCUMENT_INPUT, FILE_INPUT, DOCUMENT) |
originUid |
Origin uid |
string |
values |
Values |
< string > array |
6.62. ReportDataMapItem
| Name | Description | Schema |
|---|---|---|
extraAlphabetValues |
Extra Alphabet Values |
< string, string > map |
key |
key |
string |
label |
Label |
string |
origin |
Origin |
enum (DOCUMENT_INPUT, FILE_INPUT, DOCUMENT) |
originUid |
Origin uid |
string |
value |
Value |
string |
valueLabel |
Labeled value |
string |
6.63. ReportDateItem
| Name | Description | Schema |
|---|---|---|
day |
Day |
integer (int32) |
label |
Label |
string |
month |
Month |
integer (int32) |
origin |
Origin |
enum (DOCUMENT_INPUT, FILE_INPUT, DOCUMENT) |
originUid |
Origin uid |
string |
value |
Value |
string |
year |
Year |
integer (int32) |
6.64. ReportFinanceData
| Name | Description | Schema |
|---|---|---|
accountKey |
Account key |
|
accountNumber |
Account number |
|
accountOwner |
Account owner |
|
accountOwnerAddress |
Account owner address. Deprecated, use accountOwnerAddressLines instead |
|
accountOwnerAddressLines |
Account owner address |
|
bankAddressLines |
Bank address lines |
|
bankCode |
Bank code |
|
bankName |
Branch name |
|
bic |
Bic |
|
branchCode |
Branch code |
|
extra |
Extra |
< ReportDataMapItem > array |
iban |
Iban |
|
ibanCountry |
Iban country |
6.65. ReportIdentityData
| Name | Description | Schema |
|---|---|---|
birthDate |
Birth date |
|
birthDay |
Birth day (deprecated since CIS 2.3. Use birthDate.day instead) |
|
birthDepartment |
Birth department |
|
birthMonth |
Birth month (deprecated since CIS 2.3. Use birthDate.month instead) |
|
birthPlace |
Birth place |
|
birthPlaceCity |
Birth place city |
|
birthPlaceCountry |
Birth place country |
|
birthYear |
Birth year (deprecated since CIS 2.3. Use birthDate.year instead) |
|
extra |
Extra |
< ReportDataMapItem > array |
faceUrl |
face URL |
|
firstNames |
First names |
|
fullName |
Full name |
|
gender |
Gender |
|
lastName |
Last name |
|
nationalRegistrationNumber |
National registration number |
|
nationality |
Nationality |
|
ssn |
Social security number |
|
usageName |
Usage name |
6.66. ReportJobData
| Name | Description | Schema |
|---|---|---|
employer |
Employer name |
|
employerAddress |
Employer address |
|
extra |
Extra |
< ReportDataMapItem > array |
income |
Income |
|
siret |
Employer identifier. Deprecated since 2.8, use field 'uid' instead |
|
uid |
Employer identifier |
6.67. ReportLegalEntityData
| Name | Description | Schema |
|---|---|---|
activity |
activity |
|
activityCode |
activity code |
|
addressLines |
address lines |
|
administrators |
administrators |
< ReportAdministratorData > array |
capitalAmount |
capital amount |
|
capitalCurrency |
capital current |
|
capitalType |
capital type |
|
city |
city |
|
commercialName |
commercial name |
|
country |
country |
|
directors |
directors (deprecated since 2.28. Use administrators instead) |
|
extra |
extra |
< string, ReportDataItem > map |
headOfficeUid |
company head office uid |
|
legalForm |
legal form |
|
name |
company name |
|
registrationDate |
registration date |
|
uid |
company uid |
|
zipCode |
zip code |
6.68. ReportReferenceValues
| Name | Description | Schema |
|---|---|---|
references |
References |
< ReportDataMapItem > array |
6.69. ReportSummary
| Name | Description | Schema |
|---|---|---|
generationDate |
Report generation date |
string (date-time) |
globalStatus |
Report global status |
enum (NONE, OK, WARN, ERROR, OBSOLETE) |
uid |
Report UID |
string |
6.70. ReportVehicleData
| Name | Description | Schema |
|---|---|---|
bodyType |
body type |
|
brand |
brand |
|
extra |
extra |
< string, ReportDataItem > map |
firstRegistrationDate |
first registation date |
|
model |
model |
|
plateNum |
extra |
|
type |
type |
|
vin |
vehicle identification number |
6.71. SecurityHeaderField
| Name | Description | Schema |
|---|---|---|
name |
Name of the header. |
string |
value |
Value of the header. |
string |
6.72. StateWorkFlowStep
| Name | Description | Schema |
|---|---|---|
attachable |
Attachable. If false, attachments cannot be modified for all files with this state. |
boolean |
checkable |
Checkable. If false, all files with this state cannot be checked. |
boolean |
initial |
Initial step. If no state is specified at creation, file is initiated with this state. Only one 'initial' step is allowed. |
boolean |
label |
Label |
string |
name |
Name |
string |
next |
Available next steps. Each steps must exist. |
< string > array |
updatable |
Updatable. If false, all files with this state cannot be updated. |
boolean |
6.73. TaskResponse
| Name | Description | Schema |
|---|---|---|
endDate |
Ended task date |
string (date-time) |
handledUid |
Identifier for handled object |
string |
issuerType |
issuer type |
string |
issuerUid |
issuer uid |
string |
message |
Message |
string |
startDate |
Started task date |
string (date-time) |
status |
Task status |
enum (SUBMITTED, STARTED, MANUAL_ANALYSIS_STARTED, LIVENESS_STARTED, EMRTD_STARTED, VIDEOSCAN_STARTED, CORRELATION_SEARCH_STARTED, EXTRA_ANALYSIS_STARTED, ENDED, FAILED) |
uid |
Task identifier |
string |
6.74. UserInfo
| Name | Description | Schema |
|---|---|---|
locations |
User locations |
< string > array |
login |
User login |
string |
menu |
Menu |
|
privileges |
User privileges |
< string > array |
states |
States |
< StateWorkFlowStep > array |
6.75. Verdict
| Name | Description | Schema |
|---|---|---|
causeOfRejection |
Cause of rejection |
enum (DATA_NOT_MATCH, DOC_FIELDS_UNREADABLE, MISSING_SIDE, DOC_NOT_ORIGINAL, DOC_EXPIRED, DOC_NOT_ACCEPTED, NFC_ISSUE, VIDEO_QUALITY, MANUAL_TREATMENT_TIMEOUT, CHALLENGES_NOT_PERFORMED) |
errorCauseMessage |
Error cause message |
string |
status |
verdict status |
enum (SUCCESS, REJECTED, FRAUDULENT_IDENTITY_SUSPICION, INTERNAL_ERROR, NOT_COMPLETE) |
6.76. VideoScanData
| Name | Description | Schema |
|---|---|---|
errorMessage |
Error message if one of videoScan sessions is FINISHED_ERROR |
string |
sessionRectoStatus |
Status of the videoScan Recto side reading session |
enum (IN_PROGRESS, FINISHED_OK, FINISHED_ERROR) |
sessionVersoStatus |
Status of the videoScan Verso side reading session |
enum (IN_PROGRESS, FINISHED_OK, FINISHED_ERROR) |
7. Asynchronous mode
In asynchronous mode, response body contains the task status:
{
"uid": "dfdf3201-81bb-4255-99bc-e693a0ff8f68",
"status": "STARTED",
"startDate": "2020-01-21T10:24:48+0200"
}Use Get task to view last task status.
8. Configuration
8.1. Identity completeness configuration
When submitting a file, identity completeness can be defined in "pluginConfiguration" section using "IDENTITY_COMPLETENESS" key.
-
inputData/pluginConfiguration/IDENTITY_COMPLETENESS: default completeness for all generated identities
-
inputData/persons[i]/pluginConfiguration/IDENTITY_COMPLETENESS: completeness for identity corresponding to this person
{
"uid": "123456789",
"inputData": {
"persons": [
{
"role" : "PERSON_1",
"pluginConfiguration" : [
{
"key" : "IDENTITY_COMPLETENESS",
"value" : "ID=0,1;PAY_SLIP=1,*"
}
]
...
},
{
"role" : "PERSON_2"
...
}
],
"pluginConfiguration" : [
{
"key" : "IDENTITY_COMPLETENESS",
"value" : "ID=0,2;PAY_SLIP=3,5"
}
]
}
...
}"IDENTITY_COMPLETENESS" is a semicolon separated list of key/value pairs:
-
key corresponds to document types (see Document request for available values)
-
value defines the minimum and maximum number of documents required.
-
*character means "any number of times"
For example:
-
ID=*means any number of ID document (even 0) -
ID=1;PAY_SLIP=1,*means exactly 1 ID document and minimum 1 pay slip -
ID=0,1;PAY_SLIP=1,*means between 0 and 1 ID document and minimum 1 pay slip -
ID=0,2;PAY_SLIP=3,5means up to 2 IDs and 3 to 5 pay slips -
ID=0,2;PAY_SLIP,IBAN=3,5means up to 2 IDs and 3 to 5 pay slips or ibans
We can also define document subtype(s) for each type of document: they are defined between [ and ] and separated by |.
For example:
-
ID[PASSPORT]=1means one PASSPORT document is required -
ID[VISA|PASSPORT]=1means a VISA or a PASSPORT document is required (not both, not other ID document subtype)
The result of identity completeness is stored in extraDocuments section of each generated customer identities
If "IDENTITY_COMPLETENESS" is not defined, extracDocuments is null.
Control returns:
-
OK: identity is complete -
WARNING: identity contains extra documents -
ERROR: some documents are missing
8.2. Callbacks configuration
Only users with realm_management or notification_management privilege can create endpoints and notifications.
8.2.1. Callback definition
A callback is defined by its endpoint.
Each endpoint is defined by
-
a clientId (identifier)
-
an activation property (defaults to true)
-
an URL. Notifications will be sent to this URL.
-
a security header field composed of a name and a value. If used, both name and value have to be set. The header will be sent "as is".
-
a secret. This secret will be sent as an "X-Request-ID" header, with its value set to: clientId:secret encoded in base64.
-
a set of events. Each time this event is raised, notification is launched.
Note that only one of "Security Header Field" or "secret" is allowed.
To subscribe to an event, you have to define its kind, method(s) and operation(s).
To subscribe to all events concerning files just set event kind to "FILE" (no method, no operation), to subscribe to all events concerning file updates just set kind to "FILE" and method to "UPDATE" (no operation), and so on…
| Kind | Method | Operation | Event description |
|---|---|---|---|
FILE |
CREATE |
DEFAULT |
File has been created |
CLONE |
File has been cloned |
||
DELETE |
DEFAULT |
File has been deleted |
|
UPDATE |
DEFAULT |
File has been updated using update method |
|
STATE |
File state has changed |
||
VALIDITY |
File validity has changed |
||
CHECK |
File has been checked |
||
CHECK_DOCUMENT |
Document has been checked during a file check |
||
START_MANUAL_ANALYSIS_DOCUMENT |
Document is sent to manual analysis during a file check |
||
START_CORRELATION_SEARCH_DOCUMENT |
Document is sent to correlation search during a file check |
||
ADD_DOCUMENT |
Document has been added to file |
||
REMOVE_DOCUMENT |
Document has been removed from file |
||
ADD_COMMENT |
Comment has been added to file |
||
REMOVE_COMMENT |
Comment has been removed from file |
||
ADD_ATTACHMENT |
Attachment has been added file |
||
UPDATE_ATTACHMENT |
Attachment has been updated |
||
REMOVE_ATTACHMENT |
Attachment has been removed from file |
||
DOCUMENT |
CREATE |
DEFAULT |
Document has been created |
DELETE |
DEFAULT |
Document has been deleted |
|
UPDATE |
DEFAULT |
Document has been updated user update method |
|
CHECK |
Document has been checked |
||
START_MANUAL_ANALYSIS |
Document is sent to manual analysis |
||
START_CORRELATION_SEARCH |
Document is sent to correlation search |
||
ADD_IMAGE |
Image has been added to document |
||
REMOVE_IMAGE |
Image has been removed from document |
8.2.2. Callback activation
To activate notification, "enableNotifications" field has to be set to "true" in each file or document.
If "enableNotifications" is not set, "enableNotificationsByDefault" realm parameter is used.
There is 2 formats for notification. First (defined as "old notification format") lets the CIS send itself the notification. Second (defined as "new format") uses a dedicated service that manages notifications. In order to activate the new notification format, "newNotificationFormat" needs to be set to true in realm update request.
Note that "old notification format" is deprecated and should not be used for new customers.
8.2.3. Callback notification
When a notification is fired, a json object is sent to endpoint URL using POST.
JSON object may contain the following fields (depending on event):
|
Tip
|
Fields marked by (*) must be set. Others are optional. When two fields name are specified, the name depends weather it’s the "old notification format" or the "new notification format". |
-
(*) "date" (old) or "eventDate" (new): event date
-
(*) "realm": realm name
-
(*) "issuer" (old) or "accountId" (new): issuer
-
(*) "event_kind" (old) or "resourceType" (new): event kind, see Notification event
-
(*) "method" (old): event method, see Notification event
-
(*) "operation" (old): event operation, see Notification event
-
(*) "event" (new): the concatenation of "event method" and "event operation" (whith underscore separator).
-
(*) "event_status": event status ("OK" if everything went well, otherwise, an error message, or "KO" is no error message is available)
-
"check_status": enum (NONE, OK, WARNING, ERROR, OBSOLETE)
-
"file_uid": file UID
-
"new_state": new file state
-
"old_state": old file state
-
"new_validity": new file validity
-
"old_validity": old file validity
-
"document_uid": document UID
-
"document_type": enum (ID, IBAN, CHEQUE, TAX, PAY, ADDRESS, CREDIT_CARD, PORTRAIT, LEGAL_ENTITY, CAR_REGISTRATION, LIVENESS)
-
"image_uid": image UID
-
"image_side": image side enum (RECTO, VERSO, OTHER)
Example:
When a file check ends, the following request is sent to the endPoint defined in the notification:
{
"date" : "2019-01-01T11:11:11+0100",
"realm" : "MyCompany",
"issuer" : "sarah connor",
"event_kind" : "FILE",
"method" : "UPDATE",
"operation" : "CHECK",
"event_status" : "OK",
"file_uid" : "SOME_FILE_UID",
"check_status" : "OK"
}If new notification format is used, a part of the previous JSON object corresponds to the "eventData" sub-object of the following exemple
(note that some fields won’t be present as they are already in the main object of the response: "event_kind", "method", "operation", "date" and "issuer")
{
"accountId": "sarah connor",
"appId": "CIS-SERVER",
"resourceId": "SOME_FILE_UID",
"resourceType": "FILE",
"event": "UPDATE_CHECK",
"eventDate": "2019-01-01T11:11:11+0100",
"eventData": {
"realm" : "MyCompany",
"event_status" : "OK",
"file_uid" : "SOME_FILE_UID",
"check_status" : "OK"
},
"_links": [{
}]
}The endPoint should respond with Http status OK (code 200).
It should also treat the callback asynchronously so that the HTTP connection is not held too long.
Note that if the return code isn’t 2XX or if the endpoint is not responding, retries will be performed a few times before warning our teams that the endpoint has an issue.
8.3. File states configuration
Each file comes with a "state" field.
States workflow is defined at realm level and can be modified with Update realm method.
States workflow is also returned in Get user info method.
Default state workflow:
[
{
"name": "INITIAL",
"label": "Initial",
"next": [
"IN_PROGRESS",
"FINAL"
],
"initial": true,
"updatable" : true,
"checkable" : true,
"attachable" : true
},
{
"name": "IN_PROGRESS",
"label": "In progress",
"next": [
"INITIAL",
"FINAL"
],
"updatable" : true,
"checkable" : true,
"attachable" : true
},
{
"name": "FINAL",
"label": "Final",
"next": [
"INITIAL",
"IN_PROGRESS"
],
"updatable" : true,
"checkable" : true,
"attachable" : true
}
]9. Error codes
When an error occurs, message body contains an error code, an error message and optionally some parameters.
Response is formatted in JSON.
{
"errorCode": "CIS_DOCUMENT_UNKNOWN",
"errorMessage": "Unknown document [someDocument]",
"parameters": {
"documentUid": "someDocument"
}
}9.1. Available error codes
| Error code | Cause | Http code |
|---|---|---|
CIS_API_BAD_REQUEST |
Generic 400 error |
400 |
CIS_API_FORBIDDEN |
Generic 403 error |
403 |
CIS_API_NOT_FOUND |
Generic 404 error |
404 |
CIS_API_INTERNAL_ERROR |
Generic 500 error |
500 |
CIS_NOT_IMPLEMENTED |
Method not implemented |
501 |
CIS_IMAGE_TOO_LARGE |
Submitted image is too large (max. 4Mb) |
413 |
CIS_ATTACHMENT_TOO_LARGE |
Submitted attachment is too large (max. 10 Mb) |
413 |
CIS_INVALID_CONTENT |
An input data field is invalid |
415 |
CIS_CUSTOMER_FILE_UNKNOWN |
Unknown customer file [{fileUid}] |
404 |
CIS_CUSTOMER_FILE_INVALID |
Invalid customer file [{fileUid}] |
400 |
CIS_CUSTOMER_FILE_FORMAT_INVALID |
Invalid customer file format [{fileUid}] |
400 |
CIS_CUSTOMER_FILE_NO_DOCUMENT |
No document linked to customer file [{fileUid}] |
400 |
CIS_CUSTOMER_FILE_NO_REPORT |
No report for customer file [{fileUid}] |
400 |
CIS_CUSTOMER_FILE_REQUIRED |
Customer file is required |
400 |
CIS_CUSTOMER_FILE_EMAIL_REQUIRED |
Email is required for customer file [{fileUid}] |
400 |
CIS_CUSTOMER_FILE_EMAIL_FORMAT_INVALID |
Email format is customer file [{fileEmail}] |
400 |
CIS_CUSTOMER_FILE_PASSWORD_REQUIRED |
Password is required for customer file [{fileUid}] |
400 |
CIS_CUSTOMER_FILE_ALREADY_EXISTS |
Customer file [{fileUid}] already exists |
409 |
CIS_CUSTOMER_FILE_EMAIL_ALREADY_USED |
Email [{fileEmail}] is already used |
409 |
CIS_CUSTOMER_FILE_COMMENT_UNKNOWN |
Unknown comment [{commentUid}] for customer file [{fileUid}] |
404 |
CIS_CUSTOMER_FILE_COMMENT_INVALID |
Invalid comment [{commentUid}] for customer file [{fileUid}] |
400 |
CIS_CUSTOMER_FILE_ATTACHMENT_UNKNOWN |
Unknown attachment [{attachmentUid}] for customer file [{fileUid}] |
404 |
CIS_CUSTOMER_FILE_ATTACHMENT_INVALID |
Invalid attachment [{attachmentUid}] for customer file [{fileUid}] |
400 |
CIS_CUSTOMER_FILE_STATE_UNKNOWN |
Unknown value for state [{state}] |
400 |
CIS_CUSTOMER_FILE_STATE_INVALID |
Cannot update state to [{state}] |
400 |
CIS_CUSTOMER_FILE_NOT_UPDATABLE |
Customer file [{fileUid}] is locked and cannot be updated |
400 |
CIS_CUSTOMER_FILE_NOT_CHECKABLE |
Customer file [{fileUid}] is locked and cannot be checked |
400 |
CIS_CUSTOMER_FILE_NOT_ATTACHABLE |
Attachments on customer file [{fileUid}] cannot be modified |
400 |
CIS_CUSTOMER_FILE_MAX_DOCUMENTS_REACHED |
Max. number of documents reached for customer file [{fileUid}] |
400 |
CIS_CUSTOMER_FILE_MAX_ATTACHMENTS_REACHED |
Max. number of attachments reached for customer file [{fileUid}] |
400 |
CIS_THUMBNAIL_INVALID_REQUEST |
Thumbnail is available only for images and PDF attachments |
400 |
CIS_CUSTOMER_TAG_INVALID |
Tag must not contain ',' character |
400 |
CIS_DOCUMENT_UNKNOWN |
Unknown document [{documentUid}] |
404 |
CIS_DOCUMENT_INVALID |
Invalid document [{documentUid}] |
400 |
CIS_DOCUMENT_UNKNOWN_FOR_REALM |
Unknown document [{documentUid}] for this realm [{realm}] |
400 |
CIS_DOCUMENT_NOT_LINKED |
Document [{documentUid}] not linked to customer file [{fileUid}] |
400 |
CIS_DOCUMENT_ALREADY_LINKED |
Document [{documentUid}] already linked to customer file [{fileUid}] |
409 |
CIS_DOCUMENT_ALREADY_LINKED_OTHER |
Document [{documentUid}] already linked to another customer file |
409 |
CIS_DOCUMENT_NO_REPORT |
No report for document [{documentUid}] |
400 |
CIS_DOCUMENT_INVALID_EVIDENCE_KEY |
Evidence key already exists for customer file [{fileUid}] |
409 |
CIS_DOCUMENT_INVALID_REFERENCE |
Invalid reference document [{documentUid}] |
400 |
CIS_DOCUMENT_NO_BIOMETRIC_REFERENCE |
Reference document [{documentUid}] cannot be used for biometric analysis |
400 |
CIS_DOCUMENT_COUNTRY_NOT_SUPPORTED |
This country is not supported for this kind of document |
400 |
CIS_IMAGE_UNKNOWN |
Unknown image [{imageUid}] for realm [{realm}] |
404 |
CIS_IMAGE_CONTENT_REQUIRED |
Image content is required |
400 |
CIS_IMAGE_SIDE_REQUIRED |
Image side is required |
400 |
CIS_IMAGE_TYPE_REQUIRED |
Image type is required |
400 |
CIS_IMAGE_REQUIRED |
Image is required |
400 |
CIS_IMAGE_LIST_NOT_EMPTY |
Image list must not be empty |
400 |
CIS_IMAGE_DOCUMENT_INVALID |
Image [{imageUid}] does not belong to document [{documentUid}] |
400 |
CIS_CHECK_CONFLICT |
Check conflict on document [{documentUid}]. Newer analysis is available |
409 |
CIS_CHECK_REPORT_UNKNOWN |
Unknown check report [{checkReportUid}] |
404 |
CIS_CHECK_REPORT_INVALID_FOR_REALM |
Unknown check report [{checkReportUid}] for realm [{realm}] |
400 |
CIS_CHECK_REPORT_CUSTOMER_FILE_REQUIRED |
Customer file is required |
400 |
CIS_CHECK_REPORT_DOCUMENT_REQUIRED |
ONBOARDING_ID header is required for SDKs calls |
400 |
CIS_CHECK_REPORT_ISSUER_REQUIRED |
Issuer is required |
400 |
CIS_CHECK_REPORT_ISSUER_TYPE_REQUIRED |
Issuer type is required |
400 |
CIS_TASK_UNKNOWN |
Unknown task [{taskUid}] |
404 |
CIS_BACKEND_IMAGE_TYPE_INVALID |
Request does not contain required image types (DL or DL + IR + UV) |
400 |
CIS_BACKEND_NO_RECTO_OR_VERSO |
Request must contain at least a RECTO and/or a VERSO image |
400 |
CIS_BACKEND_NO_DL |
Request must contain at least a daylight image |
400 |
CIS_BACKEND_DOCUMENT_TYPE_INCOMPATIBLE |
Document type [{documentType}] returned by backend analysis is incompatible with category [{documentCategory}] |
400 |
CIS_REALM_UNKNOWN |
Unknown realm [{realm}] |
404 |
CIS_REALM_INVALID |
Invalid realm [{realm}] |
400 |
CIS_REALM_PARAMETER_VALUE_INVALID |
Invalid value for parameter [{realmParameter}] |
400 |
CIS_REALM_ALREADY_EXISTS |
The realm [{realm}] already exists |
409 |
CIS_REALM_READ_ONLY |
The realm [{realm}] contains data and cannot be modified or deleted |
400 |
CIS_REALM_ENDPOINT_UNKNOWN |
Unknown endpoint [{clientId}] |
404 |
CIS_REALM_ENDPOINT_INVALID |
Invalid endpoint [{clientId}] |
400 |
CIS_REALM_ENDPOINT_CLIENT_ID_INVALID |
Invalid endpoint client id [{clientId}] |
400 |
CIS_REALM_ENDPOINT_CLIENT_ID_ALREADY_EXISTS |
Endpoint with client id [{clientId}] already exists |
400 |
CIS_REALM_ENDPOINT_URL_INVALID |
Endpoint URL cannot be null |
400 |
CIS_DOCUMENT_MANUAL_ANALYSIS_IN_PROGRESS |
Cannot check document [{documentUid}], manual analysis in progress |
409 |
CIS_DOCUMENT_LIVENESS_IN_PROGRESS |
Cannot check document [{documentUid}], liveness analysis in progress |
409 |
CIS_DOCUMENT_EMRTD_IN_PROGRESS |
Cannot check document [{documentUid}], a NFC reading is in progress |
409 |
CIS_DOCUMENT_VIDEOSCAN_IN_PROGRESS |
Cannot check document [{documentUid}], a video capture is in progress |
409 |
CIS_DOCUMENT_OPERATION_IN_PROGRESS |
Cannot update document [{documentUid}], an operation is in progress |
409 |
CIS_LIVENESS_NO_REFERENCE |
Document [{documentUid}] does not contain liveness reference document |
400 |
CIS_LIVENESS_NO_PORTRAIT |
Document [{documentUid}] does not contain portrait |
400 |
CIS_LIVENESS_CANNOT_CREATE_DOCUMENT |
Creation of liveness documents is not allowed. Please use "startLiveness" method to start session |
405 |
CIS_LIVENESS_INVALID_FILE |
File [{fileUid}] is different from reference document file |
409 |
CIS_ONE_LIVENESS_BY_FILE |
The file [{fileUid}] already contains a liveness document. |
400 |
CIS_LIVENESS_CANNOT_CREATE_DOCUMENT |
Creation of liveness documents is not allowed. Please use "startLiveness" method to start session |
405 |
CIS_LIVENESS_CANNOT_UPDATE_DOCUMENT |
Update of liveness documents is not allowed. Please use "startLiveness" method to start session |
405 |
CIS_LIVENESS_CANNOT_CHECK_DOCUMENT |
Check of liveness documents is not allowed. Please use "startLiveness" method to start session |
406 |
CIS_LIVENESS_INVALID_FILE |
File [{fileUid}] is different from reference document file |
409 |
CIS_SYNCHRONOUS_CHECK_NOT_AVAILABLE |
Synchronous check is not available for document [{documentUid}] |
400 |
CIS_CONCURRENT_FILE_CHECK |
A check for the file [{fileUid}] is already running |
406 |
CIS_CONCURRENT_DOCUMENT_CHECK |
A check for the document [{documentUid}] is already running |
406 |
CIS_INTERNAL_ERROR |
Internal server error |
500 |
CIS_BAD_REQUEST |
Bad request |
400 |
CIS_FORBIDDEN |
Forbidden |
403 |
CIS_NOT_FOUND |
Not found |
404 |
CIS_PDF_DIMENSIONS_INVALID |
The PDF contains pages with dimensions that exceed the allowed limits or fall below the minimum required size. |
400 |
9.2. Message parameters
| Error code | Description |
|---|---|
realm |
Realm name |
fileUid |
File identifier |
fileEmail |
File email |
documentUid |
Document identifier |
documentType |
Document type |
documentCategory |
Document category |
checkReportUid |
Check report identifier |
imageUid |
Image identifier |
commentUid |
Comment identifier |
attachmentUid |
Attachment identifier |
taskUid |
Task identifier |
clientId |
Endpoint client id |
state |
File state |
10. Changelog
10.1. 2.41 to 2.41.1
-
PoA firstnames and lastnames matches improvements
-
New error cause: ADDITIONAL_IDENTITIES_NOT_MATCH_BARCODE
-
10.2. 2.39 to 2.40
-
IBAN Ownership Verification
10.3. 2.38 to 2.39
-
Technical improvements
-
Add PDF_REPORT_CHECK_AUTHORIZED_STATUS to realm configuration
-
New events types :
-
New notification operation :
-
Add personalNumber to InputInfoData
10.5. 2.36 to 2.37
-
IBAN - Bank Ownership Verification
-
New error codes : SERVICE_ERROR, FRAUD, POTENTIALLY_FRAUD, SERVICE_TIMEOUT
-
New event types : START_IBAN_OWNERSHIP_VERIFICATION, IBAN_OWNERSHIP_VERIFICATION_RESULT
-
New task status : EXTRA_ANALYSIS_STARTED
-
New notification operations : START_IBAN_OWNERSHIP_VERIFICATION, START_IBAN_OWNERSHIP_VERIFICATION_DOCUMENT
-
10.7. 2.34 to 2.35
-
Technical improvements
10.8. 2.33 to 2.34
-
Technical improvements
10.9. 2.32 to 2.33
-
Technical improvements
10.10. 2.31 to 2.32
-
Technical improvements
10.11. 2.30 to 2.31
-
Add "CIS_NOT_IMPLEMENTED" error code.
-
Add an option to download a PDF/A compliant PDF of report.
-
Add "CORRELATION_SEARCH_STARTED" task status, "CORRELATION_SEARCH_IN_PROGRESS" analysis status and "START_CORRELATION_SEARCH" and "CORRELATION_SEARCH_RESULT" events enum values.
-
Remove "CIS_CUSTOMER_FILE_UID_REQUIRED" error code.
-
Make uid field as optional in the FileRequest definition.
-
Some changes on the bank and account owner addresses
-
Fix missing mapping for PICTURE_COLOR_GREY_OR_BW errorCause
-
Extend REQUIRED_FIELDS_EXTRACTION scope (ID documents)
-
Generate PDF report in the PDF/A standard
-
Remove usage of realm parameters for analyses timeouts
-
[SLD] Handle CIS calls to SLD
-
Manage forbidden words for unstructured document - add FORBIDEN_WORDS_FOUND control
-
Handle new fields for ID documents (birthPlaceCity, birthPlaceCountry)
-
Handle new cause for barcode on unstructured documents
-
Handle the new cause from FIFRAUD: MISSING_IDENTITY_DATA
-
Map REGISTRATION_STATUS control from Brazilian CPF call
-
Add missing error cause (NUMBER_NOT_FOUND)
-
Add a new RND_ARCHIVING parameter in CIS realm
-
Detect overlapped documents
-
Add "update_all" right to role ROLE_SUPERVISOR
10.14. 2.27 to 2.28
-
errorCause "identifier" field marked as deprecated
-
Add "key" field in errorCause
-
Add "administrators" field in ReportLegalEntityData and mark "directors" as deprecated
10.15. 2.26 to 2.27
-
Add "securityHeaderField" field in NotificationEndpoint to add flexibility to notification callback security headers
10.16. 2.25 to 2.26
-
Add "sdk" field in DeviceInfo
10.18. 2.23 to 2.24
-
Remove PICTURE_RESOLUTION_INSUFFISCIENT_OCR quality issue value (typo), replaced by PICTURE_RESOLUTION_INSUFFICIENT_OCR
10.20. 2.21 to 2.22
-
Add "prettyName" field to DocumentResponse
-
Put "REFERENCE_FACE" for liveness reference face instead of "ORIGINAL"
-
Add LivenessData object to document’s ExtraData
10.22. 2.19 to 2.20
-
Add new 'CHECK_DOCUMENT' and 'START_MANUAL_ANALYSIS_DOCUMENT' notifications in file check mode.
-
Add 'disableManualAnalysis' parameter to StartLiveness request.
10.23. 2.18 to 2.19
-
Add 'forceDocumentAnalysis' parameter on check document request.
10.25. 2.16 to 2.17
-
Add 'readExpirationDate' field to DocumentReportInfo.
-
Add 'fromManualAnalysis' field to documentReport.
-
Add new 'START_MANUAL_ANALYSIS' notification.
10.27. 2.14 to 2.15
-
Add 'options' to StartLivenessRequest for internal tweeking of OCR layers
-
Add 'errorCause' to Check to add a level of info on some controls with ERROR status (available only for EMRTD Controls at the moment)
-
ReportAddressData 'lines' field has been removed.
10.28. 2.13 to 2.14
-
Add 'extraData' to DocumentResponse.
-
Add 'cardAccessNumber' field to DocumentReportInfo.
-
Notification URL max size is set from 100 to 255 characters.
10.29. 2.12 to 2.13
-
Possibility to deactivate a notification endpoint.
10.31. 2.10 to 2.11
-
Add a thumbnail endpoint to get a preview of any image of a document.
10.32. 2.9 to 2.10
-
'dataProcessingConsent' field in startLiveness has been removed, use required field 'biometricConsent' instead.
-
Date fields marked as deprecated since CIS 2.3 should not be used anymore.
They will be removed within the next two releases. -
ReportJobData 'siret' field marked as deprecated since CIS 2.8 should not be used anymore.
It will be removed in a future release. -
ReportAddressData 'lines' field is now deprecated and should be removed in a future release.
Use fullAddress instead.
10.33. 2.8 to 2.9
-
Add "classId" field to DocumentResponse
-
Add "CIS_DOCUMENT_NO_BIOMETRIC_REFERENCE" error code.
10.34. 2.7 to 2.8
-
Add Technical data map to File, Document, Attachment (read and write of this data need permission), useful for storing data related to the object.
-
Add a request parameter to force documents watermarking
10.35. 2.6 to 2.7
-
Add "CIS_DOCUMENT_INVALID_REFERENCE", "CIS_DOCUMENT_COUNTRY_NOT_SUPPORTED", "CIS_CHECK_CONFLICT", "CIS_LIVENESS_INVALID_FILE", "CIS_ONE_LIVENESS_BY_FILE", "CIS_LIVENESS_CANNOT_CREATE_DOCUMENT", "CIS_LIVENESS_CANNOT_UPDATE_DOCUMENT", "CIS_LIVENESS_CANNOT_CHECK_DOCUMENT" error codes.
-
Add support for portuguese IBAN analysis
-
Add support for italian and spanish address proof analysis
-
Add biometric consent for face recognition analysis
10.36. 2.5 to 2.6
-
Add liveness management
-
New document type/subtype "LIVENESS" in DocumentRequest and DocumentResponse
-
Add "CIS_CUSTOMER_FILE_REQUIRED", "CIS_DOCUMENT_LIVENESS_IN_PROGRESS", "CIS_FILE_LIVENESS_IN_PROGRESS", "CIS_LIVENESS_NO_REFERENCE", "CIS_LIVENESS_NO_PORTRAIT", "CIS_SYNCHRONOUS_CHECK_NOT_AVAILABLE", "CIS_LIVENESS_INVALID_FILE", "CIS_LIVENESS_CANNOT_CREATE_DOCUMENT", "CIS_CONCURRENT_FILE_CHECK", "CIS_CONCURRENT_DOCUMENT_CHECK" error codes.
-
-
Add new service to create and check document on the same request
-
Check files and documents : add parameter to disable manual analysis
10.37. 2.4 to 2.5
-
Add "fullName" to document response and request
-
Add "evidenceKey" to document (create, read, update, search).
Document evidence key should be unique per file. -
Add "CIS_DOCUMENT_INVALID_EVIDENCE_KEY" error code.
-
Add Clone document method.
10.38. 2.3 to 2.4
-
Add support for "cheque" document type.
-
New document type/subtype "CHEQUE" in DocumentRequest and DocumentResponse
-
New object ReportChequeData in CustomerIdentity and DocumentReportPerson
-
-
Add new callback on file validity changes.
See Callback definition -
Add "CIS_CUSTOMER_FILE_MAX_DOCUMENTS_REACHED", "CIS_CUSTOMER_FILE_MAX_ATTACHMENTS_REACHED" error codes.
-
Add national registration number field to ReportIdentityData
-
Enhance identity completeness
10.39. 2.2 to 2.3
-
Add support for "legal entity" document type.
-
Add support for "car registration" document type.
10.40. 2.1 to 2.2
-
Add identity completeness management.
-
Add callback management.
-
Add state field to file.
-
Add method to clone file.
-
Add methods to manage some realm parameters
-
Check submitted images and attachments.
See "CIS_IMAGE_TOO_LARGE", "CIS_ATTACHMENT_TOO_LARGE", "CIS_INVALID_CONTENT" error codes. -
Add "CIS_CUSTOMER_FILE_STATE_UNKNOWN", "CIS_CUSTOMER_FILE_STATE_INVALID", "CIS_CUSTOMER_FILE_NOT_UPDATABLE", "CIS_CUSTOMER_FILE_NOT_CHECKABLE", "CIS_CUSTOMER_FILE_NOT_ATTACHABLE" error codes.
10.41. 2.0 to 2.1
10.41.1. Attachment management
-
Add AttachmentSummary to FileResponse.
-
Add "Add attachment", "Get attachment", "Download attachment" , "Update attachment" and "Delete attachment" resources.
-
Add "CIS_CUSTOMER_FILE_ATTACHMENT_UNKNOWN", "CIS_CUSTOMER_FILE_ATTACHMENT_INVALID" and "CIS_THUMBNAIL_INVALID_REQUEST" error codes.