1. References

Developer guide: A quick reference to get started is available here.
Swagger: The swagger.json of the openapi documentation is available here.

2. Endpoints

2.1. Document

01. Create document

POST /rest/v1/{realm}/document

Create a new document

Description

Create a new document.
You can provide the images within this request, or call additional path later to add images.
This is a fast operation, we recommend using synchronous mode.
If the UID of an existing file is provided, the document will be immediately linked to that file.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null
Body Parameter
Name Description Required Type Default Format

DocumentRequest

✓

DocumentRequest
Query Parameters
Name Description Required Type Default Format

fileUid

UID of the file you want to link.

-

String

null

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 1. HTTP Response Codes
Code Message Datatype

201

Created (synchronous mode)

DocumentSummary

202

Accepted (asynchronous mode)

TaskResponse

02. Create document and check

POST /rest/v1/{realm}/document/check

Create a document and immediately check.

Description

Create a new document and immediately start the analysis flow.
Image must be included in the request for the analysis to be possible.
As the UID of the document can not be retrieved, this operation is synchronous only.
This is a time consuming operation, the use of this endpoint is strongly discouraged.
If the UID of an existing file is provided, the document will be immediately linked to that file.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null
Body Parameter
Name Description Required Type Default Format

DocumentRequest

✓

DocumentRequest
Query Parameters
Name Description Required Type Default Format

fileUid

UID of the file you want to link.

-

String

null
Return Type
Content Type

  • application/json

Responses
Table 2. HTTP Response Codes
Code Message Datatype

201

Created

DocumentResponse

03. Get document

GET /rest/v1/{realm}/document/{uid}

Retrieve a document by its UID.

Description

Retrieve the content of a document by its UID.
This endpoint will return the document, its metadata (e.g., images, input data) and the last analysis report associated.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the document to retrieve.

✓

String

null
Return Type
Content Type

  • application/json

Responses
Table 3. HTTP Response Codes
Code Message Datatype

200

Document retrieved successfully

DocumentResponse

04. Update document

PUT /rest/v1/{realm}/document/{uid}

Update an existing document by its UID.

Description

Update the content of a document based on the provided UID.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the document to update.

✓

String

null
Body Parameter
Name Description Required Type Default Format

DocumentUpdateRequest

✓

DocumentUpdateRequest
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 4. HTTP Response Codes
Code Message Datatype

200

OK (synchronous mode)

DocumentSummary

202

Accepted (asynchronous mode)

TaskResponse

05. Delete document

DELETE /rest/v1/{realm}/document/{uid}

Delete an existing document by its UID.

Description

Delete a document based on the provided UID.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the document to delete.

✓

String

null
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

Responses
Table 5. HTTP Response Codes
Code Message Datatype

204

No content (synchronous mode)

202

Accepted (asynchronous mode)

TaskResponse

06. Clone document

POST /rest/v1/{realm}/document/{uid}/clone

Clone an existing document by its UID.

Description

Clone a document by creating a new entry.
If the document to clone is part of a file, the new cloned document will be linked to that file.
The cloned document will contains all metadata (e.g., images, input data) but also the analysis, reports, and so on.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

Document unique identifier

✓

String

null
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false

fileUid

New file unique identifier

-

String

null
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 6. HTTP Response Codes
Code Message Datatype

201

Task accepted

TaskResponse

200

Cloned file

DocumentSummary

07. Check document

POST /rest/v1/{realm}/document/{uid}/check

Start the analysis flow of a document by its UID.

Description

Start the analysis flow of a document.
This flow will perform multiple analysis depending on its type and the configuration.
This is a time consuming operation, it is recommended to work in an asynchronous mode. Synchronous mode is strongly discouraged.
If you still want to work in a synchronous mode, only the main analysis will be performed to reduce the operation time. Manual analysis and other extra analysis will be disabled.
Also note that the 'DATA' type of document is not compatible with the synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the document to check.

✓

String

null
Query Parameters
Name Description Required Type Default Format

forceDocumentAnalysis

If the content of the document did not change since the last analysis, only the report will be generated. Setting this parameter to true will force the start of all the analysis flow.

-

Boolean

false

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false

disableManualAnalysis (DEPRECATED)

Deprecated - use manualAnalysis = DISABLE instead

-

Boolean

false

manualAnalysis

This parameter overrides the manual analysis trigger mechanism for this analysis flow.

-

Enum: [DISABLE, FORCE]

null
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 7. HTTP Response Codes
Code Message Datatype

200

OK (synchronous mode)

DocumentReport

202

Accepted (asynchronous mode)

TaskResponse

08. Get document report

GET /rest/v1/{realm}/document/{uid}/check/{checkUid}

This endpoint is DEPRECATED.

Get a document check report based on their UIDs.

Description

Retrieve the check report of a document by their UIDs.
Note that this feature is deprecated as only the last report exists now.
The UID of a check report is present in the response of the '03. Get document' operation.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the document holding the report.

✓

String

null

checkUid

UID of the check report.

✓

String

null
Return Type
Content Type

  • application/json

Responses
Table 8. HTTP Response Codes
Code Message Datatype

200

Document check report retrieved successfully

DocumentReport

09. Get PDF report

GET /rest/v1/{realm}/document/{uid}/report

Get the PDF version of the last report for the document by its UID.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the document.

✓

String

null
Query Parameters
Name Description Required Type Default Format

doWatermarking

Watermarks are applied by default for all users. If it is not the case for your account, you can force watermarking by setting this parameter to true.

-

Boolean

false

pdfaCompliance

PDF report will be PDF/A-3 compliant.

-

Boolean

false
Return Type

  • byte[]

Content Type

  • */*

Responses
Table 9. HTTP Response Codes
Code Message Datatype

200

PDF report retrieved successfully

byte[]

10. Get document preview

GET /rest/v1/{realm}/document/{uid}/thumbnail

Retrieve the preview of a document by its UID.

Description

Retrieve the preview of a document. This preview is built based on the images present inside that document.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

Document unique identifier

✓

String

null
Query Parameters
Name Description Required Type Default Format

part

Document part to generate thumbnail for

-

Enum: [RECTO, VERSO, OTHER]

null

type

Image type

-

String

null

doWatermarking

Watermarks are applied by default for all users. If it is not the case for your account, you can force watermarking by setting this parameter to true.

-

Boolean

false
Return Type

  • byte[]

Content Type

  • */*

Responses
Table 10. HTTP Response Codes
Code Message Datatype

200

Document thumbnail retrieved successfully

byte[]

11. Search documents

GET /rest/v1/{realm}/document/search

Search for documents based on multiple criteria’s.

Description

Search for documents matching given criteria’s.
This operation can be heavy, and we strongly discourage to use this endpoint outside of a graphic user interface.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null
Query Parameters
Name Description Required Type Default Format

fileUid

UID of the file linked to documents.

-

String

null

types

Types of documents.

-

List[Enum: [ID, IBAN, CHEQUE, TAX_SHEET, PAY_SLIP, ADDRESS_PROOF, CREDIT_CARD, PORTRAIT, LEGAL_ENTITY, CAR_REGISTRATION, LIVENESS, DATA]]

null

lastReportStatuses

Statuses of the last report of documents.

-

List[Enum: [NONE, OK, WARN, ERROR, OBSOLETE]]

null

lastAnalysisStatuses

Statuses of the last analysis of documents.

-

List[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]]

null

fromCreationDate

From creation date (format RFC-339 date or date-time).

-

Date

null

date-time

toCreationDate

To creation date (format RFC-339 date or date-time).

-

Date

null

date-time

fromLastUpdateDate

From last update date (format RFC-339 date or date-time).

-

Date

null

date-time

toLastUpdateDate

To last update date (format RFC-339 date or date-time).

-

Date

null

date-time

fromExpirationDate

From expiration date (format RFC-339 date or date-time).

-

Date

null

date-time

toExpirationDate

To expiration date (format RFC-339 date or date-time).

-

Date

null

date-time

owner

Owner of documents.

-

String

null

locations

Locations of documents.

-

List[String]

null

evidenceKey

Evidence key of documents.

-

String

null

businessUid

Custom business UID of documents.

-

String

null

limit

Number of documents returned (1 to 50).

-

Integer

10

int32 Min: 1. Max: 50.

offset

Offset for pagination.

-

Integer

0

int32 Min: 0.

order

Sort order field.

-

Enum: [lastReportStatus, creationDate, lastUpdateDate, expirationDate]

creationDate

direction

Sort direction.

-

Enum: [asc, desc]

desc

totalOnly

If set to true, returns only the total count of records; no result items are included.

-

Boolean

false
Return Type
Content Type

  • application/json

Responses
Table 11. HTTP Response Codes
Code Message Datatype

200

Documents found successfully

DocumentSearchResponse

2.2. DocumentImage

01. Add images

POST /rest/v1/{realm}/document/{uid}/addImages

Add images to a document by its UID.

Description

Add at least one image to an existing document by its UID.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the document to add images to.

✓

String

null
Body Parameter
Name Description Required Type Default Format

ImageRequest

✓

List[ImageRequest]
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 12. HTTP Response Codes
Code Message Datatype

200

OK (synchronous mode)

List[ImageResponse]

202

Accepted (asynchronous mode)

TaskResponse

02. Download image

GET /rest/v1/{realm}/document/{uid}/image/{imageUid}

Download the image of a document by their UIDs.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

imageUid

UID of the image.

✓

String

null

uid

UID of the document.

✓

String

null
Query Parameters
Name Description Required Type Default Format

doWatermarking

Watermarks are applied by default for all users. If it is not the case for your account, you can force watermarking by setting this parameter to true.

-

Boolean

false
Return Type

  • byte[]

Content Type

  • */*

Responses
Table 13. HTTP Response Codes
Code Message Datatype

200

Image retrieved successfully

byte[]

03. Get image thumbnail

GET /rest/v1/{realm}/document/{uid}/image/{imageUid}/thumbnail

Get the thumbnail of the image of a document by their UIDs.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

imageUid

UID of the image.

✓

String

null

uid

UID of the document.

✓

String

null
Query Parameters
Name Description Required Type Default Format

doWatermarking

Watermarks are applied by default for all users. If it is not the case for your account, you can force watermarking by setting this parameter to true.

-

Boolean

false
Return Type

  • byte[]

Content Type

  • */*

Responses
Table 14. HTTP Response Codes
Code Message Datatype

200

Image thumbnail retrieved successfully

byte[]

04. Delete image

DELETE /rest/v1/{realm}/document/{uid}/image/{imageUid}

Delete the image of a document by their UIDs.

Description

Delete an existing image from an existing document by their UIDs.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the document.

✓

String

null

imageUid

UID of the image.

✓

String

null
Query Parameters
Name Description Required Type Default Format

synchronous

Synchronous mode

-

Boolean

false
Return Type
Content Type

  • application/json

Responses
Table 15. HTTP Response Codes
Code Message Datatype

204

No content (synchronous mode)

202

Accepted (asynchronous mode)

TaskResponse

2.3. Event

01. Search events

GET /rest/v1/{realm}/events

Search for events based on multiple criteria’s.

Description

Search for events matching given criteria’s.
This operation can be heavy, and we strongly discourage to use this endpoint outside of a graphic user interface.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null
Query Parameters
Name Description Required Type Default Format

uid

UID of the entity linked to events: file or document.

-

String

null

owner

Owner of events.

-

String

null

eventStatus

Status of events.

-

Enum: [OK, KO]

null

eventTypes

Types of events.

-

List[EventType]

null

fromEventDate

From event date (format RFC-339 date or date-time).

-

Date

null

date-time

toEventDate

To event date (format RFC-339 date or date-time).

-

Date

null

date-time

limit

Number of events returned (1 to 200).

-

Integer

50

int32 Min: 1. Max: 200.

offset

Offset for pagination.

-

Integer

0

int32 Min: 0.

order

Sort order field.

-

Enum: [eventDate, eventStatus, eventType]

eventDate

direction

Sort direction.

-

Enum: [asc, desc]

desc

totalOnly

If set to true, returns only the total count of records; no result items are included.

-

Boolean

false
Return Type
Content Type

  • application/json

Responses
Table 16. HTTP Response Codes
Code Message Datatype

200

OK

EventSearchResponse

2.4. File

01. Create file

POST /rest/v1/{realm}/file

Create a file

Description

Create an empty file.
It is possible to specify a custom UID. This UID is unique in the database so it may be rejected. If no UID is provided, a default one is generated.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null
Body Parameter
Name Description Required Type Default Format

FileRequest

✓

FileRequest
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 17. HTTP Response Codes
Code Message Datatype

201

Created (synchronous mode)

FileSummary

202

Accepted (asynchronous mode)

TaskResponse

02. Get file

GET /rest/v1/{realm}/file/{uid}

Get a file by its UID.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file to retrieve.

✓

String

null
Return Type
Content Type

  • application/json

Responses
Table 18. HTTP Response Codes
Code Message Datatype

200

File retrieved successfully

FileResponse

03. Update file

PUT /rest/v1/{realm}/file/{uid}

Update a file by its UID.

Description

Update an existing file by its UID.
It is possible to specify a custom UID. This UID is unique in the database so it may be rejected. If no UID is provided, the old one is kept.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file to update.

✓

String

null
Body Parameter
Name Description Required Type Default Format

FileRequest

✓

FileRequest
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 19. HTTP Response Codes
Code Message Datatype

200

OK (synchronous mode)

FileSummary

202

Accepted (asynchronous mode)

TaskResponse

04. Delete file

DELETE /rest/v1/{realm}/file/{uid}

Delete a file by its UID.

Description

Delete an existing file by its UID.
The file and all its associated resources will be removed.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file to delete.

✓

String

null
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

Responses
Table 20. HTTP Response Codes
Code Message Datatype

204

No content (synchronous mode)

202

Accepted (asynchronous mode)

TaskResponse

05. Clone file

POST /rest/v1/{realm}/file/{uid}/clone

Clone a file by its UID.

Description

Clone a file by creating an new entry.
It is possible to specify a custom UID for the clone. This UID is unique in the database so it may be rejected. If no UID is provided, a default one is generated.
The cloned file will contains all metadata, documents, analysis, reports and so on.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file to clone.

✓

String

null
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

✓

Boolean

false

newFileUid

UID of the new file.

-

String

null
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 21. HTTP Response Codes
Code Message Datatype

201

Task accepted

TaskResponse

200

Cloned file

FileSummary

06. Link document

POST /rest/v1/{realm}/file/{uid}/link/{documentUid}

Link a document to a file by their UIDs.

Description

Link an existing document to an existing file by their UIDs.
The document will be included in the file.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file to link the document to.

✓

String

null

documentUid

UID of the document to link.

✓

String

null
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

Responses
Table 22. HTTP Response Codes
Code Message Datatype

204

No content (synchronous mode)

202

Accepted (asynchronous mode)

TaskResponse

07. Unlink document

DELETE /rest/v1/{realm}/file/{uid}/link/{documentUid}

Unlink a document from a file by their UIDs.

Description

Unlink an existing document from an existing file by their UIDs.
The document will be removed from the file. But the document itself will not be removed.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file to unlink the document from.

✓

String

null

documentUid

UID of the document to unlink.

✓

String

null
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

Responses
Table 23. HTTP Response Codes
Code Message Datatype

204

No content (synchronous mode)

202

Accepted (asynchronous mode)

TaskResponse

08. Check file

POST /rest/v1/{realm}/file/{uid}/check

Start the analysis flow of a file by its UID.

Description

Start the analysis flow of a file. All documents will be analysed and a global report will be generated.
This flow will perform multiple analysis per documents depending on the type and the configuration.
This is a time consuming operation, it is recommended to work in an asynchronous mode. Synchronous mode is strongly discouraged.
If you still want to work in a synchronous mode, only the main analysis will be performed to reduce the operation time. Manual analysis and other extra analysis will be disabled.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file to check.

✓

String

null
Query Parameters
Name Description Required Type Default Format

forceDocumentAnalysis

If the content of the file did not change since the last analysis, only the report will be generated. Setting this parameter to true will force the start of all the analysis flow.

-

Boolean

false

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false

disableManualAnalysis (DEPRECATED)

Deprecated - use manualAnalysis = DISABLE instead

-

Boolean

false

manualAnalysis

This parameter overrides the manual analysis trigger mechanism for this analysis flow.

-

Enum: [DISABLE, FORCE]

null
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 24. HTTP Response Codes
Code Message Datatype

200

OK (synchronous mode)

FileReport

202

Accepted (asynchronous mode)

TaskResponse

09. Get file report

GET /rest/v1/{realm}/file/{uid}/check/{checkUid}

This endpoint is DEPRECATED.

Get the check report of a file by their UIDs.

Description

Retrieve the check report of a file by their UIDs.

Note that this feature is deprecated as only the last report exists now.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file holding the report.

✓

String

null

checkUid

UID of the check report.

✓

String

null
Return Type
Content Type

  • application/json

Responses
Table 25. HTTP Response Codes
Code Message Datatype

200

File check report retrieved successfully

FileReport

10. Get PDF report

GET /rest/v1/{realm}/file/{uid}/report

Get the PDF version of the last report for the file by its UID.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file.

✓

String

null
Query Parameters
Name Description Required Type Default Format

doWatermarking

Watermarks are applied by default for all users. If it is not the case for your account, you can force watermarking by setting this parameter to true.

-

Boolean

false

pdfaCompliance

PDF report will be PDF/A-3 compliant.

-

Boolean

false
Return Type

  • byte[]

Content Type

  • */*

Responses
Table 26. HTTP Response Codes
Code Message Datatype

200

PDF report generated successfully

byte[]

11. Search files

GET /rest/v1/{realm}/file/search

Search for files based on multiple criteria’s.

Description

Search for files matching given criteria’s.
This operation can be heavy, and we strongly discourage to use this endpoint outside of a graphic user interface.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null
Query Parameters
Name Description Required Type Default Format

uid

UID of the file. To check the existence of a file, it is better to use the Get File operation.

-

String

null

fromCreationDate

From creation date (format RFC-339 date or date-time).

-

Date

null

date-time

toCreationDate

To creation date (format RFC-339 date or date-time).

-

Date

null

date-time

fromLastUpdateDate

From last update date (format RFC-339 date or date-time).

-

Date

null

date-time

toLastUpdateDate

To last update date (format RFC-339 date or date-time).

-

Date

null

date-time

owner

Owner of files.

-

String

null

locations

Locations of files.

-

List[String]

null

lastReportStatuses

Statuses of the last report of files.

-

List[Enum: [NONE, OK, WARN, ERROR, OBSOLETE]]

null

lastAnalysisStatuses

Statuses of the last analysis of files.

-

List[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]]

null

validities

List of validity of files.

-

List[Enum: [VALID, INVALID, NOT_VALIDATED]]

null

states

States of files.

-

List[String]

null

type

Type of file.

-

String

null

tag

Tag associated to files.

-

String

null

name

Name of files.

-

String

null

businessUid

Custom business UID of files.

-

String

null

limit

Number of files returned (1 to 50).

-

Integer

10

int32 Min: 1. Max: 50.

offset

Offset for pagination.

-

Integer

0

int32 Min: 0.

order

Sort order field.

-

Enum: [creationDate, lastReportStatus, lastUpdateDate]

creationDate

direction

Sort direction.

-

Enum: [asc, desc]

desc

totalOnly

If set to true, returns only the total count of records; no result items are included.

-

Boolean

false
Return Type
Content Type

  • application/json

Responses
Table 27. HTTP Response Codes
Code Message Datatype

200

Files search completed successfully

FileSearchResponse

2.5. FileAttachment

01. Add attachment

POST /rest/v1/{realm}/file/{uid}/attachment

Add an attachment to file.

Description

Add an attachment and link it to an existing file.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file to link the attachment to.

✓

String

null
Body Parameter
Name Description Required Type Default Format

AttachmentRequest

✓

AttachmentRequest
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 28. HTTP Response Codes
Code Message Datatype

200

OK (synchronous mode)

AttachmentResponse

202

Accepted (asynchronous mode)

TaskResponse

02. Get attachment

GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}

Retrieve an attachment metadata of a file by their UIDs.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file the attachment is linked to.

✓

String

null

attachmentUid

UID of the attachment.

✓

String

null
Return Type
Content Type

  • application/json

Responses
Table 29. HTTP Response Codes
Code Message Datatype

200

Attachment retrieved successfully

AttachmentResponse

03. Update attachment

PUT /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}

Update an attachment of a file by their UIDs.

Description

Update an existing attachment of an existing file by their UIDs.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file the attachment is linked to.

✓

String

null

attachmentUid

UID of the attachment to update.

✓

String

null
Body Parameter
Name Description Required Type Default Format

AttachmentUpdateRequest

✓

AttachmentUpdateRequest
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 30. HTTP Response Codes
Code Message Datatype

200

OK (synchronous mode)

AttachmentResponse

202

Accepted (asynchronous mode)

TaskResponse

04. Delete attachment

DELETE /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}

Delete an attachment from a file by their UIDs.

Description

Delete an existing attachment of an existing file by their UIDs.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Realm name

✓

String

null

uid

file uid

✓

String

null

attachmentUid

Attachment uid

✓

String

null
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

Responses
Table 31. HTTP Response Codes
Code Message Datatype

204

No content (synchronous mode)

202

Accepted (asynchronous mode)

TaskResponse

05. Download attachment

GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}/download

Download an attachment of a file by their UIDs.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Realm name

✓

String

null

uid

file uid

✓

String

null

attachmentUid

Attachment uid

✓

String

null
Return Type

  • byte[]

Content Type

  • */*

Responses
Table 32. HTTP Response Codes
Code Message Datatype

200

Attachment downloaded successfully

byte[]

06. Download thumbnail attachment

GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}/thumbnail

Download the thumbnail of an attachment by their UIDs.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Realm name

✓

String

null

uid

file uid

✓

String

null

attachmentUid

Attachment uid

✓

String

null
Return Type

  • byte[]

Content Type

  • */*

Responses
Table 33. HTTP Response Codes
Code Message Datatype

200

Attachment thumbnail downloaded successfully

byte[]

2.6. FileComment

01. Add comment

POST /rest/v1/{realm}/file/{uid}/comment

Add a comment to a file by its UID.

Description

Create a comment and add it to an existing file.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file to link the comment to.

✓

String

null
Body Parameter
Name Description Required Type Default Format

FileCommentRequest

✓

FileCommentRequest
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 34. HTTP Response Codes
Code Message Datatype

200

OK (synchronous mode)

FileComment

202

Accepted (asynchronous mode)

TaskResponse

02. Update comment

PUT /rest/v1/{realm}/file/{uid}/comment/{commentUid}

Update the comment of a file by their UIDs.

Description

Update an existing comment of an existing file by their UIDs.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file the comment is linked to.

✓

String

null

commentUid

UID of the comment.

✓

String

null
Body Parameter
Name Description Required Type Default Format

FileCommentRequest

✓

FileCommentRequest
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

  • application/json

Responses
Table 35. HTTP Response Codes
Code Message Datatype

200

OK (synchronous mode)

FileComment

202

Accepted (asynchronous mode)

TaskResponse

03. Delete comment

DELETE /rest/v1/{realm}/file/{uid}/comment/{commentUid}

Delete the comment of a file by their UIDs.

Description

Delete an existing comment of an existing file by their UIDs.
This is a fast operation, we recommend using synchronous mode.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

uid

UID of the file the comment is linked to.

✓

String

null

commentUid

UID of the comment to delete.

✓

String

null
Query Parameters
Name Description Required Type Default Format

synchronous

Whether to process the request synchronously (true) or asynchronously (false).

-

Boolean

false
Return Type
Content Type

  • application/json

Responses
Table 36. HTTP Response Codes
Code Message Datatype

204

No content (synchronous mode)

202

Accepted (asynchronous mode)

TaskResponse

2.7. Health

01. Get health

GET /rest/health

Get the health status of the service.

Description
Parameters
Return Type
Content Type

  • application/json

Responses
Table 37. HTTP Response Codes
Code Message Datatype

200

OK

HealthResponse

2.8. NotificationEndpoint

01. Create endpoint

POST /rest/v1/realm/{realm}/endpoint

Create an endpoint to receive notifications.

Description

Create a new notification endpoint that will receive notifications of steps reach or terminated during analysis flows.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null
Body Parameter
Name Description Required Type Default Format

NotificationEndpointRequest

✓

NotificationEndpointRequest
Return Type
Content Type

  • application/json

Responses
Table 38. HTTP Response Codes
Code Message Datatype

200

OK

NotificationEndpoint

02. Get endpoints

GET /rest/v1/realm/{realm}/endpoints

Retrieve all your endpoints.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null
Return Type
Content Type

  • application/json

Responses
Table 39. HTTP Response Codes
Code Message Datatype

200

OK

List[NotificationEndpoint]

03. Get endpoint

GET /rest/v1/realm/{realm}/endpoint/{clientId}

Retrieve one endpoint by its user-readable ID.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

clientId

User-readable ID of the endpoint to retrieve.

✓

String

null
Return Type
Content Type

  • application/json

Responses
Table 40. HTTP Response Codes
Code Message Datatype

200

OK

NotificationEndpoint

04. Update endpoint

PUT /rest/v1/realm/{realm}/endpoint/{clientId}

Update an existing endpoint by its user-readable ID.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

clientId

User-readable ID of the endpoint to update.

✓

String

null
Body Parameter
Name Description Required Type Default Format

NotificationEndpointRequest

✓

NotificationEndpointRequest
Return Type
Content Type

  • application/json

Responses
Table 41. HTTP Response Codes
Code Message Datatype

200

OK

NotificationEndpoint

05. Delete endpoint

DELETE /rest/v1/realm/{realm}/endpoint/{clientId}

Delete an existing endpoint by its user-readable ID.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

clientId

User-readable ID of the endpoint to update.

✓

String

null
Return Type
Responses
Table 42. HTTP Response Codes
Code Message Datatype

200

OK

06. Add event

POST /rest/v1/realm/{realm}/endpoint/{clientId}/event

Subscribe to a specific event for an endpoint.

Description
Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

clientId

User-readable ID of the endpoint to update.

✓

String

null
Body Parameter
Name Description Required Type Default Format

NotificationEventRequest

✓

NotificationEventRequest
Return Type
Content Type

  • application/json

Responses
Table 43. HTTP Response Codes
Code Message Datatype

200

OK

NotificationEvent

07. Delete event

DELETE /rest/v1/realm/{realm}/endpoint/{clientId}/event

Unlink a specific event type to an endpoint to remove a filter on notifications to receive.

Description

Remove an event type associated to an endpoint to filter out notification.
Even though the parameters kind, method and operation are not required, only the event matching exactly the three parameters will be removed.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

clientId

User-readable ID of the endpoint to update.

✓

String

null
Query Parameters
Name Description Required Type Default Format

kind

Type of the event to remove.

-

Enum: [FILE, DOCUMENT]

null

method

Method of the event to remove.

-

Enum: [CREATE, UPDATE, DELETE]

null

operation

Operation of the event to remove.

-

NotificationEventOperation

null
Return Type
Responses
Table 44. HTTP Response Codes
Code Message Datatype

200

OK

2.9. Task

01. Get task

GET /rest/v1/{realm}/task/{taskId}

Get task content

Description

Retrieve the content of a task. Tasks are linked to an entity, document or file.

Parameters
Path Parameters
Name Description Required Type Default Format

realm

Your realm user-readable name.

✓

String

null

taskId

UID of the task to retrieve.

✓

String

null
Query Parameters
Name Description Required Type Default Format

waitTime

Number of millisecond you may want to wait if the task is not in a state that allows to retrieve a report. Note that if the task is still not ready after that time, the task object is returned.

-

Long

0

int64
Return Type
Content Type

  • application/json

Responses
Table 45. HTTP Response Codes
Code Message Datatype

200

OK

TaskResponse

3. Models

3.1. AttachmentRequest

Allows to create an attachment and store it alongside a file.

Field Name Description Required Type Format

technicalData

Technical data

List[MapItem]

title

Name of the attachment.

String

description

Description of the attachment.

String

type

Type of the attachment.

String

Min length: 0. Max length: 45.

contentBase64

base64 content of the attachment.

✓

String

fileName

File name of the attachment.

✓

String

3.2. AttachmentResponse

Representation of an attachment.

Field Name Description Required Type Format

technicalData

Technical data

List[MapItem]

uid

UID of the attachment.

✓

String

title

Name of the attachment.

String

description

Description of the attachment.

String

type

Type of the attachment.

String

fileUid

UID of the file the attachment is attached to.

✓

String

date

Date of creation of the attachment.

✓

Date

date-time

fileName

File name of the attachment.

✓

String

3.3. AttachmentSummary

Light representation of an attachment.

Field Name Description Required Type Format

uid

UID of the attachment.

✓

String

title

Name of the attachment.

String

description

Description of the attachment.

String

type

Type of the attachment.

String

date

Date of creation of the attachment.

✓

Date

date-time

fileName

File name of the attachment.

✓

String

mediaType

Media type associated to the attachment.

✓

String

3.4. AttachmentUpdateRequest

Allows to update an attachment.

Field Name Description Required Type Format

technicalData

Technical data

List[MapItem]

title

Name of the attachment.

String

description

Description of the attachment.

String

type

Type of the attachment.

String

Min length: 0. Max length: 45.

3.5. Check

Specific rule or group of rules that were verified.

Field Name Description Required Type Format

identifier

The identifier of the check.

✓

String

title

The given title of the check.

✓

String

message

Details of the check result.

✓

String

type

Type of the check.

✓

Enum: [DOCUMENT_VALIDITY, DOCUMENT_ACCEPTABILITY, DATA_ACCEPTABILITY, DATA_CONSISTENCY, FILE_COMPLETENESS, OTHER, UNKNOWN]

status

Status of the check.

✓

Enum: [NONE, OK, WARN, ERROR, OBSOLETE]

documentUid

UID of the document corresponding to this check.

String

fileUid

UID of the file corresponding to this check.

String

dataReferences

If applicable, data used as references to build the check. Used for example for matching checks.

List[DataReference]

subChecks

List[Check]

errorCause

Cause of the failure of a check.

ErrorCause

3.6. CheckErrorCause

Enum Values

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

MRZ_ALTERATION_DETECTED

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

BOTH_BIC_MISSING

OCR_BIC_MISSING

REFERENCE_DATABASE_BIC_MISSING

ADDITIONAL_IDENTITIES_NOT_MATCH_BARCODE

3.7. CustomerIdentity

Representation of the aggregated identity of a person based on all documents provided.

Field Name Description Required Type Format

uid

UID of the identity.

✓

String

role

Logical role that was used to build the identity based on documents having this role.

ReportDataItem

creationDate

Date of creation of the identity.

✓

Date

date-time

documentUids

List of UID of documents used to build the identity.

✓

List[String]

identityData

Identity report data.

ReportIdentityData

addressData

Address report data.

ReportAddressData

financeData

Finance report data.

ReportFinanceData

jobData

Job report data.

ReportJobData

legalEntityData

Legal entity report data.

ReportLegalEntityData

vehicleData

Vehicle report data.

ReportVehicleData

chequeData

Cheque report data.

ReportChequeData

3.8. DataReference

Data used as reference to perform matching checks.

Field Name Description Required Type Format

expectedValue

Expected value

String

expectedReference

Expected reference

String

givenValue

Given value

String

givenReference

Given reference

String

3.9. DocumentCustomer

A customer identity can be based on multiple documents. This references the opposite: the customer identities that were built based on the referenced document.

Field Name Description Required Type Format

documentUid

UID of the referenced document.

✓

String

customers

List of UID of customer identity that match the referenced document.

✓

List[String]

3.10. DocumentInputData

Representation of all data that will be used as reference to perform cross checks and improve the quality of checks. Do not set document input data if you already added input data on the file level.

Field Name Description Required Type Format

clientData

Client input data

InputClientData

infoData

Document input data

InputInfoData

persons

List of person's input data

List[InputPerson]

3.11. DocumentReference

References a document inside a file response.

Field Name Description Required Type Format

uid

Identifier of the referenced document.

✓

String

type

Type of the referenced document.

Enum: [ID, IBAN, CHEQUE, TAX_SHEET, PAY_SLIP, ADDRESS_PROOF, CREDIT_CARD, PORTRAIT, LEGAL_ENTITY, CAR_REGISTRATION, LIVENESS, DATA]

subType

Sub type of the referenced document.

DocumentSubType

evidenceKey

Evidence key that was provided during the creation of the document.

String

3.12. DocumentReport

Report of a document containing extracted data, check tree and images.

Field Name Description Required Type Format

uid

UID of the report.

✓

String

generationDate

Date of generation of the report.

✓

Date

date-time

globalStatus

Aggregated global status of the report.

✓

Enum: [NONE, OK, WARN, ERROR, OBSOLETE]

checks

List of checks and their sub-checks of the report.

✓

List[Check]

issuance

Extracted data related to the issuance of the document.

DocumentReportIssuance

info

Extracted data related to the identification of the document.

DocumentReportInfo

clientData

Extra fields given as input data during the creation request.

ReportClientData

persons

Representation of all person information that were extracted from the document.

List[DocumentReportPerson]

referenceValues

All data used as reference to perform matching checks.

ReportReferenceValues

backendResultId

Technical ID used internally during the analysis.

✓

String

fromManualAnalysis

Specifies if a manual review was performed during the analysis the document.

Boolean

3.13. DocumentReportInfo

Extracted data related to the identification of the document.

Field Name Description Required Type Format

documentNumber

Number of the document.

ReportDataItem

cardAccessNumber

Card access number of the document.

ReportDataItem

personalNumber

Personal number of the document.

ReportDataItem

documentType

Type of the document.

ReportDataItem

sidesIssue

Details on error linked to the sides of the document.MISSING_VERSO if the verso is missing, INVALID_VERSO if the verso does not match the recto, MISSING_RECTO if the recto is missing or INVALID_RECTO if the recto does not match the verso.

ReportDataItem

expirationDate

Date of expiration of the document. Based on legal rules, for some documents this field can be different from the actually extracted value.

ReportDateItem

expirationDay (DEPRECATED)

Expiration day (deprecated since CIS 2.3. Use expirationDate.day instead).

ReportDataItem

expirationMonth (DEPRECATED)

Expiration month (deprecated since CIS 2.3. Use expirationDate.month instead).

ReportDataItem

expirationYear (DEPRECATED)

Expiration year (deprecated since CIS 2.3. Use expirationDate.year instead).

ReportDataItem

readExpirationDate

Date of expiration of the document based on extracted value.

ReportDateItem

extra

Additional extracted information that are not named fields.

List[ReportDataMapItem]

3.14. DocumentReportIssuance

Extracted data related to the issuance of the document.

Field Name Description Required Type Format

issueDate

Issue date

ReportDateItem

issueDay (DEPRECATED)

Issue day (deprecated since CIS 2.3. Use issueDate.day instead).

ReportDataItem

issueMonth (DEPRECATED)

Issue month (deprecated since CIS 2.3. Use issueDate.month instead).

ReportDataItem

issueYear (DEPRECATED)

Issue year (deprecated since CIS 2.3. Use issueDate.year instead).

ReportDataItem

issuingCountry

Issuing country

ReportDataItem

issuingAuthority

Issuing authority

ReportDataItem

extra

Additional extracted information that are not named fields.

List[ReportDataMapItem]

3.15. DocumentReportPerson

Representation of a person information that were extracted from the document.

Field Name Description Required Type Format

role

Logical role that was provided in the input data (InputPerson).

ReportDataItem

identityData

Identity report data.

ReportIdentityData

addressData

Address report data.

ReportAddressData

financeData

Finance report data.

ReportFinanceData

jobData

Job report data.

ReportJobData

legalEntityData

Legal entity report data.

ReportLegalEntityData

vehicleData

Vehicle report data.

ReportVehicleData

chequeData

Cheque report data.

ReportChequeData

consumptionData

Consumption address report data.

ReportAddressData

3.16. DocumentRequest

Allows to create a document.

Field Name Description Required Type Format

technicalData

Technical data

List[MapItem]

location

Assigns a location to the document; only users with access to that location can view it.

String

Min length: 0. Max length: 512.

type

Type of the document.

✓

Enum: [ID, IBAN, CHEQUE, TAX_SHEET, PAY_SLIP, ADDRESS_PROOF, CREDIT_CARD, PORTRAIT, LEGAL_ENTITY, CAR_REGISTRATION, LIVENESS, DATA]

inputData

Representation of all data that you expect to be extracted from the corresponding document. Do not set document input data if you already added input data on the file level.

DocumentInputData

images

List of images to link to the document.

List[ImageRequest]

evidenceKey

Specific string that is verified on file level. This key allows to ensure the unicity of a document inside a file. A document with a given evidence key can not be added to a file that already contains a document with said evidence key.

String

Min length: 0. Max length: 100.

country

Country (Alpha2 or Alpha3 code) as defined in ISO 3166-1

String

enableNotifications

Notifications can be disabled globally for your realm. If this is the case, you can enable them for this specific document analysis. Do not fill this field if notifications are already activated globally.

Boolean

endpointsToNotify

When set, only these endpoints 'clientId' are notified; otherwise, all. This feature must not be used to provide one notification endpoint per analysis flow.

List[String]

businessUid

Custom UID you want to be linked to that document.

String

Min length: 0. Max length: 45.

3.17. DocumentResponse

Representation of a document.

Field Name Description Required Type Format

technicalData

Technical data

List[MapItem]

uid

UID of the document.

✓

String

owner

Owner of the document. This field is filled with the username present in the access token used to send requests.

String

location

Location provided during the document creation/update.

String

type

Type of the document.

✓

Enum: [ID, IBAN, CHEQUE, TAX_SHEET, PAY_SLIP, ADDRESS_PROOF, CREDIT_CARD, PORTRAIT, LEGAL_ENTITY, CAR_REGISTRATION, LIVENESS, DATA]

subType

Subtype of the document determined during the analysis.

DocumentSubType

classId

Internal identifier of the model of the document.

String

prettyName

Internal name of the model of the document.

String

fileUid

UID of the file the document is part of.

String

evidenceKey

Evidence key that was provided during the creation of the document.

String

country

Country (Alpha3 code) as defined in ISO 3166-1.

String

biometricConsent

Specifies if the end user consented to the data processing of biometric documents.

Boolean

lastReport

Last report generated of the document.

DocumentReport

lastAnalysisStatus

Status of the last analysis of the document. This is the technical status of the analysis.

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]

reports

List of the light version of all reports generated of the document.

List[ReportSummary]

images

List of all images added or generated for the document.

List[ImageResponse]

creationDate

Date of creation of the document.

✓

Date

date-time

lastUpdateDate

Date of last update of the document.

Date

date-time

inputData

Input data that were added during the creation/update of the document.

DocumentInputData

enableNotifications

Specifies if notifications were specifically enabled for this document, while notifications were disabled globally for the realm.

Boolean

qualityIssues

List of quality issues found in the images of the document.

List[ImageQualityIssues]

businessUid

Custom UID used during the creation of this document.

String

3.18. DocumentSearchResponse

Light representation of documents matching the search request.

Field Name Description Required Type Format

rows

List of found documents matching the search request.

List[DocumentSummary]

total

Total number of documents matching the search request.

Integer

int32

3.19. DocumentSubType

Enum Values

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

3.20. DocumentSummary

Light representation of a document.

Field Name Description Required Type Format

uid

UID of the document.

✓

String

owner

Owner of the document. This field is filled with the username present in the access token used to send requests.

String

type

Type of the document.

✓

Enum: [ID, IBAN, CHEQUE, TAX_SHEET, PAY_SLIP, ADDRESS_PROOF, CREDIT_CARD, PORTRAIT, LEGAL_ENTITY, CAR_REGISTRATION, LIVENESS, DATA]

fileUid

UID of the file the document is part of.

String

evidenceKey

Evidence key that was provided during the creation of the document.

String

lastReportStatus

Last report status for this document.

Enum: [NONE, OK, WARN, ERROR, OBSOLETE]

lastAnalysisStatus

Status of the last analysis of the document. This is the technical status of the analysis.

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]

creationDate

Date of creation of the document.

Date

date-time

lastUpdateDate

Date of last update of the document.

Date

date-time

enableNotifications

Specifies if notifications were specifically enabled for this document, while notifications were disabled globally for the realm.

Boolean

3.21. DocumentUpdateRequest

Allows to update a document.

Field Name Description Required Type Format

technicalData

Technical data

List[MapItem]

location

Assigns a location to the document; only users with access to that location can view it.

String

Min length: 0. Max length: 512.

inputData

Representation of all data that you expect to be extracted from the corresponding document. Do not set document input data if you already added input data on the file level.

DocumentInputData

enableNotifications

Notifications can be disabled globally for your realm. If this is the case, you can enable them for this specific document analysis. Do not fill this field if notifications are already activated globally.

Boolean

evidenceKey

Specific string that is verified on file level. This key allows to ensure the unicity of a document inside a file. A document with a given evidence key can not be added to a file that already contains a document with said evidence key.

String

Min length: 0. Max length: 100.

country

Country (Alpha2 or Alpha3 code) as defined in ISO 3166-1

String

endpointsToNotify

When set, only these endpoints 'clientId' are notified; otherwise, all. This feature must not be used to provide one notification endpoint per analysis flow.

List[String]

3.22. ErrorCause

Field Name Description Required Type Format

identifier (DEPRECATED)

Identifier

CheckErrorCause

key

key

✓

CheckErrorCause

parameters

parameters

List[String]

message

Localized message

✓

String

3.23. EventResponse

Representation of an event.

Field Name Description Required Type Format

eventId

UID of the event.

✓

Long

int64

eventType

Type of the event.

✓

EventType

eventStatus

Status of the event.

✓

Enum: [OK, KO]

eventMessageKey

Internal key used to describe the event message.

String

eventMessage

Internal message leading to the state of the event.

String

eventDate

Date of creation of the event.

✓

Date

date-time

owner

Owner of the event. This field is filled from information extracted from the access token used.

✓

String

entityUid

UID of the file or document related to the event. If we are in a file context, we save the document and file UIDs. This field aim to provide the UID of the targeted entity.

String

entityType

Type of entity linked to the event: file or document.

✓

Enum: [FILE, DOCUMENT, IMAGE]

entityDetail

Set of json formatted details of the event.

String

fileUid

UID of the file linked to the event.

String

documentUid

UID of the document linked to the event.

String

3.24. EventSearchResponse

Light representation of events matching the search request.

Field Name Description Required Type Format

rows

List of found events matching the search request.

✓

List[EventResponse]

total

Total number of events matching the search request.

✓

Integer

int32

3.25. EventType

Enum Values

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

SETUP_SIGNING

SIGNING_USER_RESULT

SIGNING_RESULT

3.26. FileComment

Representation of a comment associated to a file.

Field Name Description Required Type Format

uid

UID of the comment.

String

commentDate

Date of creation of the comment.

Date

date-time

type

Type of the comment.

✓

String

comment

Text content of the comment.

String

issuer

Issuer

String

3.27. FileCommentRequest

Allows to create and add a comment on a file.

Field Name Description Required Type Format

type

Type of the comment.

String

Min length: 0. Max length: 100.

comment

Text content of the comment.

✓

String

3.28. FileInputData

Representation of all data that will be used as reference to perform cross checks and improve the quality of checks. Do not set file input data if you already added input data on the document level.

Field Name Description Required Type Format

clientData

Client input data

InputClientData

persons

List of person's input data

List[InputPerson]

3.29. FileReport

Report of a file containing extracted data, check tree and images.

Field Name Description Required Type Format

uid

UID of the report.

✓

String

generationDate

Date of generation of the report.

✓

Date

date-time

globalStatus

Aggregated global status of the report.

✓

Enum: [NONE, OK, WARN, ERROR, OBSOLETE]

checks

List of checks and their sub-checks of the report.

✓

List[Check]

documents

List of documents and the linked identities built from each of those documents.

✓

List[DocumentCustomer]

clientData

Extra fields given as input data during the creation request.

✓

ReportClientData

referenceValues

All data used as reference to perform matching checks.

ReportReferenceValues

customerIdentities

List of all identities that were built from the extracted data of all documents.

List[CustomerIdentity]

3.30. FileRequest

Allows to create or update a file.

Field Name Description Required Type Format

technicalData

Technical data

List[MapItem]

uid

UID of the file. If no UID is provided, one will be generated.

String

Min length: 0. Max length: 45.

location

Assigns a location to the file; only users with access to that location can view it.

String

Min length: 0. Max length: 512.

inputData

Representation of all data that you expect to be extracted from the corresponding file. Do not set file input data if you already added input data on the document level.

FileInputData

tags

List of tags to be stored alongside the file.

List[String]

enableNotifications

Notifications can be disabled globally for your realm. If this is the case, you can enable them for this specific file analysis. Do not fill this field if notifications are already activated globally.

Boolean

endpointsToNotify

When set, only these endpoints 'clientId' are notified; otherwise, all. This parameter must not be used to provide one notification endpoint per analysis flow.

List[String]

businessUid

Custom UID you want to be linked to that file.

String

Min length: 0. Max length: 45.

3.31. FileResponse

Representation of a file.

Field Name Description Required Type Format

technicalData

Technical data

List[MapItem]

uid

UID of the file.

String

owner

Owner of the file. This field is filled with the username present in the access token used to send requests.

String

location

Location provided during the file creation/update.

String

businessUid

Custom UID used during the creation of this document.

String

creationDate

Date of creation of the file.

Date

date-time

lastUpdateDate

Date of last update of the file.

Date

date-time

lastReportStatus

Status of the last report of the file.

Enum: [NONE, OK, WARN, ERROR, OBSOLETE]

lastAnalysisStatus

Status of the last analysis of the file. The is the technical status of the analysis.

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 of the file.

FileReport

documents

List of all documents inside the file.

List[DocumentReference]

reports

List of generated reports for the file.

List[ReportSummary]

inputData

Input data that were added during the creation/update of the file.

FileInputData

validity

Validity of the file.

Enum: [VALID, INVALID, NOT_VALIDATED]

state

State from the lifecycle of the file.

String

type

Type of file.

String

tags

List of tags added during the creation/update of the file.

List[String]

comments

List of comments associated with the file.

List[FileComment]

attachments

List of attachments associated with the file.

List[AttachmentSummary]

enableNotifications

Specifies if notifications were specifically enabled for this file, while notifications were disabled globally for the realm.

Boolean

verdict

Verdict

Verdict

3.32. FileSearchResponse

Light representation of files matching the search request.

Field Name Description Required Type Format

rows

List of found files matching the search request.

List[FileSummary]

total

Total number of files matching the search request.

Integer

int32

3.33. FileSummary

Light representation of a file.

Field Name Description Required Type Format

uid

UID of the file.

String

owner

Owner of the file. This field is filled with the username present in the access token used to send requests.

String

creationDate

Date of creation of the file.

Date

date-time

lastUpdateDate

Date of last update of the file.

Date

date-time

lastReportStatus

Status of the last report of the file.

Enum: [NONE, OK, WARN, ERROR, OBSOLETE]

lastAnalysisStatus

Status of the last analysis of the file. The is the technical status of the analysis.

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]

validity

Validity of the file.

Enum: [VALID, INVALID, NOT_VALIDATED]

state

State from the lifecycle of the file.

String

enableNotifications

Specifies if notifications were specifically enabled for this file, while notifications were disabled globally for the realm.

Boolean

3.34. HealthResponse

Provided health of the service.

Field Name Description Required Type Format

serverStatus

Server status (UP/DOWN)

String

serverVersion

Server version

✓

String

apiVersion

API version

✓

String

3.35. ImageQualityIssues

Representation of quality issues associated to a given image.

Field Name Description Required Type Format

imageUid

UID of the image having those quality issues.

✓

String

issues

Quality issues associated to the image.

✓

List[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]]

3.36. ImageRequest

Allows to add images to a document.

Field Name Description Required Type Format

data

Image data (base64 encoded). Accepted format: pdf, jpeg, tiff and png.

✓

String

documentPart

Side of the physical document corresponding to this image. Used for identity document (e.g.,ID Card, Passport). The recto of an ID document is the side containing the MRZ. For non identity document, do not fill this field.

Enum: [RECTO, VERSO, OTHER]

3.37. ImageResponse

Response representing an image. Can be an image added by the customer, or generated during the analysis.

Field Name Description Required Type Format

uid

UID of the image.

✓

String

source

Is the image an original provided by the customer or captured by a SDK, or a cropped generated during analysis.

Enum: [ORIGINAL, CROPPED]

documentPart

Side of the physical document corresponding to this image. Used for identity document (e.g.,ID Card, Passport).

✓

Enum: [RECTO, VERSO, OTHER]

type

Image lightning type. Used for specific cases with specific scanners.

✓

Enum: [DL, IR, UV]

origin

Concatenation of the image source and part.

✓

String

sourceImageUid

UID of the original image that was used for the crop. Not present on original images.

String

3.38. InputAddressData

Definition of the address fields that will be used as reference to perform cross checks and improve the quality of checks.

Field Name Description Required Type Format

lines

Lines of the address.

List[String]

zipCode

Zip code of the address.

String

city

City of the address.

String

extra

Free-form metadata (key/value) stored with the record. Not used during analysis or reporting. Keys must be unique.

List[MapItem]

3.39. InputClientData

Extra fields you want to store alongside the document. Those fields will not be used during analysis or report generation.

Field Name Description Required Type Format

extra

Free-form metadata (key/value) stored with the document. Keys must be unique.

List[MapItem]

3.40. InputFinanceData

Definition of the financial information fields that will be used as reference to perform cross checks and improve the quality of checks.

Field Name Description Required Type Format

iban

International Bank Account Number

String

bic

Bank's SWIFT code

String

ibanCountry

ISO country code (alpha-2) and full name derived from the IBAN

String

accountKey

Local check key (e.g., France’s RIB key)

String

accountNumber

National account number

String

accountOwner

Account holder’s full name

String

accountOwnerAddress

Account holder’s address

String

branchCode

Branch/agency code (if the country uses one; e.g.)

String

bankName

Bank or branch name

String

bankAddressLines (DEPRECATED)

Bank address lines (deprecated since CIS 2.31.95. Use bankAddress instead)

String

bankAddress

Address of the bank or branch

String

bankCode

National bank identifier (if applicable; e.g., France’s bank code)

String

extra

Free-form metadata (key/value) stored with the record. Not used during analysis or reporting. Keys must be unique.

List[MapItem]

3.41. InputIdentityData

Definition of the person identity fields that will be used as reference to perform cross checks and improve the quality of checks.

Field Name Description Required Type Format

fullName

Full name of the person. Can contain firstnames, lastname and usage name.

String

firstNames

First names of the person.

List[String]

lastName

Last name of the person.

String

usageName

Usage name of the person.

String

birthDepartment

Birth department of the person.

String

birthPlace

Birth place of the person.

String

birthDay

Day of birth of the person. Format: 2 digits.

String

birthMonth

Month of birth of the person. Format: 2 digits.

String

birthYear

Year of birth of the person. Format: 4 digits.

String

gender

Gender of the person.

String

nationality

Nationality of the person.

String

ssn

Social security number of the person. Last 5 digits are obfuscated.

String

personalNumber

Personal number of the person.

String

extra

Free-form metadata (key/value) stored with the record. Not used during analysis or reporting. Keys must be unique.

List[MapItem]

3.42. InputInfoData

Definition of the document information fields that will be used as reference to perform cross checks and improve the quality of checks.

Field Name Description Required Type Format

documentNumber

Unique document number.

String

personalNumber

Unique personal number.

String

documentType

Type of the document.

String

readExpirationDay

Day of expiration of the document based on extracted value. Format: 2 digits.

String

readExpirationMonth

Month of expiration of the document based on extracted value. Format: 2 digits.

String

readExpirationYear

Year of expiration of the document based on extracted value. Format: 4 digits.

String

expirationDay

Day of expiration of the document. Based on legal rules, for some documents this field can be different from the actually extracted value. Format: 2 digits.

String

expirationMonth

Month of expiration of the document. Based on legal rules, for some documents this field can be different from the actually extracted value. Format: 2 digits.

String

expirationYear

Day of expiration of the document. Based on legal rules, for some documents this field can be different from the actually extracted value. Format: 4 digits.

String

referenceDocument

UID of the document that is supposed to bear the information defined in this object.

String

extra

Free-form metadata (key/value) stored with the record. Not used during analysis or reporting. Keys must be unique.

List[MapItem]

3.43. InputJobData

Definition of the fields related to the occupation of the person that will be used as reference to perform cross checks and improve the quality of checks.

Field Name Description Required Type Format

siret

Siret/Siren of the employer.

String

employer

Name of the employer

String

income

Income of the person.

String

extra

Free-form metadata (key/value) stored with the record. Not used during analysis or reporting. Keys must be unique.

List[MapItem]

3.44. InputLegalEntityData

Definition of legal entity fields that will be used as reference to perform cross checks and improve the quality of checks.

Field Name Description Required Type Format

uid

Siret/Siren of the legal entity.

String

3.45. InputPerson

Definition of the person information that will be used as reference to perform cross checks and improve the quality of checks.

Field Name Description Required Type Format

role

Logical role of the person associated with the document (e.g., 'subscriber'). Used to link input data to a specific document (role field is also present on document). If multiple documents and multiple person's input data exist, role disambiguate which person's input data should be checked against which document.

String

identityData

Identity input data

InputIdentityData

addressData

Address input data

InputAddressData

financeData

Finance input data

InputFinanceData

jobData

Job input data

InputJobData

legalEntityData

Legal entity input data

InputLegalEntityData

3.46. MapItem

Representation of a Map entry with key and value.

Field Name Description Required Type Format

key

✓

String

value

✓

String

3.47. NotificationEndpoint

Representation of an endpoint.

Field Name Description Required Type Format

clientId

Identifier of the endpoint.

✓

String

Min length: 1. Max length: 255.

securityHeaderField

Header that will be added to the request to the endpoint. Used to add security context.

SecurityHeaderField

secret (DEPRECATED)

Secret.

String

Min length: 0. Max length: 100.

url

Full url of the endpoint. Must not contains identifier as the notification will embed such data.

✓

String

Min length: 1. Max length: 255.

active

Specifies if the endpoint should be called or not.

Boolean

supportEmail

This email address will be used to send alerting email in case the specified endpoint url is not reachable or return non 200 responses.

String

email

addBusinessUid

Option to add the businessUid in the notification.

String

events

List of events types this endpoint is subscribed to.

List[NotificationEvent]

3.48. NotificationEndpointRequest

Allows to create and update notification endpoints.

Field Name Description Required Type Format

clientId

The identifier of the endpoint.

✓

String

Min length: 0. Max length: 100.

securityHeaderField

Header that will be added to the request to the endpoint. Used to add security context.

SecurityHeaderField

secret (DEPRECATED)

Secret (deprecated: use securityHeaderField instead).

String

Min length: 0. Max length: 100.

url

Full url of the endpoint. Must not contains identifier as the notification will embed such data.

✓

String

Min length: 0. Max length: 255.

active

Specifies if the endpoint should be called or not.

Boolean

supportEmail

This email address will be used to send alerting email in case the specified endpoint url is not reachable or return non 200 responses.

String

Min length: 0. Max length: 100.

addBusinessUid

Option to add the businessUid in the notification.

Boolean

3.49. NotificationEvent

Type of event a notification endpoint subscribes to.

Field Name Description Required Type Format

eventKind

Type of entity the event is related to: file or document.

✓

Enum: [FILE, DOCUMENT]

method

Method related to this event.

Enum: [CREATE, UPDATE, DELETE]

operation

Operation that triggered the event.

NotificationEventOperation

3.50. NotificationEventOperation

Enum Values

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

START_SIGNING

3.51. NotificationEventRequest

Allows to specify types a event to subscribe to.

Field Name Description Required Type Format

eventKind

Type of entity the event is related to: file or document.

✓

Enum: [FILE, DOCUMENT]

method

Method related to this event.

Enum: [CREATE, UPDATE, DELETE]

operation

Operation that triggered the event.

NotificationEventOperation

3.52. ReportAddressData

Definition of the address extracted from the documents.

Field Name Description Required Type Format

laneNumber

Lane number of the address.

ReportDataItem

lane

Lane name of the address.

ReportDataItem

zipCode

Zip code of the address.

ReportDataItem

city

City of the address.

ReportDataItem

country

Country of the address.

ReportDataItem

fullAddress

Full address lines as read on document.

ReportDataListItem

extra

Additional extracted information that are not named fields.

List[ReportDataMapItem]

3.53. ReportAdministratorData

Directors of the legal entity extracted from the documents.

Field Name Description Required Type Format

title

Title of the director.

String

name

Name of the director.

String

birthDate

Date of birth of the director.

ReportDateItem

3.54. ReportChequeData

Definition of the cheque extracted from the documents.

Field Name Description Required Type Format

cmc7

CMC7 magnetic ink line as interpreted (France and some EU countries). Contains encoded bank, branch, account, and cheque number.

ReportDataItem

cmc7Raw

Raw CMC7 string as read from the document.

ReportDataItem

chequeNumber

Sequential number printed on the cheque.

ReportDataItem

zib

Bank code extracted from the CMC7. Identifies the issuing bank in the national scheme.

ReportDataItem

zin

Branch code extracted from the CMC7. Identifies the specific branch that issued the cheque.

ReportDataItem

rlmc

Account identifier segment extracted from the CMC7. Links the cheque to the underlying account.

ReportDataItem

extra

Additional extracted information that are not named fields.

List[ReportDataMapItem]

3.55. ReportClientData

Extra fields given as input data.

Field Name Description Required Type Format

extra

Free-form metadata (key/value) stored with the document.

List[ReportDataMapItem]

3.56. ReportDataItem

Single item representing a textual field extracted from the document.

Field Name Description Required Type Format

label

Label of the item.

String

value

Value of the item.

String

valueLabel

Human readable value of the item.

String

origin

Origin of the item.

Enum: [DOCUMENT_INPUT, FILE_INPUT, DOCUMENT]

originUid

UID of the file or document linked to this item.

String

extraAlphabetValues

If applicable, the different values related to the available alphabets in the documents.

Map[String]

3.57. ReportDataListItem

Single item representing a field that is a list of texts extracted from the document.

Field Name Description Required Type Format

label

Label of the item.

String

values

Values of the item.

List[String]

origin

Origin of the item.

Enum: [DOCUMENT_INPUT, FILE_INPUT, DOCUMENT]

originUid

UID of the file or document linked to this item.

String

extraAlphabetValues

If applicable, the different values related to the available alphabets in the documents.

Map[List]

3.58. ReportDataMapItem

Single item representing a field will be embedded in map of texts extracted from the document.

Field Name Description Required Type Format

key

The key that is going to be used in the map.

✓

String

label

Label of the item.

✓

String

value

Value of the item.

✓

String

valueLabel

Human readable value of the item.

String

origin

Origin of the item.

Enum: [DOCUMENT_INPUT, FILE_INPUT, DOCUMENT]

originUid

UID of the file or document linked to this item.

String

extraAlphabetValues

If applicable, the different values related to the available alphabets in the documents.

Map[String]

3.59. ReportDateItem

Single item representing a date field extracted from the document.

Field Name Description Required Type Format

label

Label of the item.

String

value

Value of the item.

String

day

Day of the date.

Integer

int32

month

Month of the date.

Integer

int32

year

Year of the date.

Integer

int32

origin

Origin of the item.

Enum: [DOCUMENT_INPUT, FILE_INPUT, DOCUMENT]

originUid

UID of the file or document linked to this item.

String

3.60. ReportFinanceData

Definition of the financial information extracted from the documents.

Field Name Description Required Type Format

iban

International Bank Account Number.

ReportDataItem

bic

Bank's SWIFT code.

ReportDataItem

ibanCountry

ISO country code (alpha-2) and full name derived from the IBAN.

ReportDataItem

accountKey

Local check key.

ReportDataItem

accountNumber

National account number.

ReportDataItem

accountOwner

Account holder’s full name.

ReportDataItem

accountOwnerAddress (DEPRECATED)

Account holder's address. Deprecated, use accountOwnerAddressLines instead.

ReportDataItem

accountOwnerAddressLines

Account holder’s address.

ReportDataListItem

branchCode

Branch/agency code.

ReportDataItem

bankName

Bank or branch name.

ReportDataItem

bankAddressLines

Bank address lines.

ReportDataListItem

bankCode

National bank identifier.

ReportDataItem

extra

Additional extracted information that are not named fields.

List[ReportDataMapItem]

3.61. ReportIdentityData

Definition of the person's identity extracted from the documents.

Field Name Description Required Type Format

fullName

Full name of the person. Can contain firstnames, lastname and usage name.

ReportDataItem

firstNames

First names of the person.

ReportDataListItem

lastName

Last name of the person.

ReportDataItem

usageName

Usage name of the person.

ReportDataItem

birthDepartment

Birth department of the person.

ReportDataItem

birthPlace

Birth place of the person.

ReportDataItem

birthPlaceCity

City of birth of the person.

ReportDataItem

birthPlaceCountry

Country of birth of the person.

ReportDataItem

birthDay (DEPRECATED)

Birth day (deprecated since CIS 2.3. Use birthDate.day instead).

ReportDataItem

birthMonth (DEPRECATED)

Birth month (deprecated since CIS 2.3. Use birthDate.month instead).

ReportDataItem

birthYear (DEPRECATED)

Birth year (deprecated since CIS 2.3. Use birthDate.year instead).

ReportDataItem

birthDate

Date of birth of the person.

ReportDateItem

gender

Gender of the person.

ReportDataItem

nationality

Nationality of the person.

ReportDataItem

ssn

Social security number of the person. Last 5 digits are obfuscated.

ReportDataItem

nationalRegistrationNumber

National registration number of the person.

ReportDataItem

faceUrl

Link where you can extract the portrait of the person extracted from documents.

ReportDataItem

extra

Additional extracted information that are not named fields.

List[ReportDataMapItem]

3.62. ReportJobData

Definition of the occupation of the person extracted from the documents.

Field Name Description Required Type Format

siret (DEPRECATED)

Employer identifier. Deprecated since 2.8, use field 'uid' instead.

ReportDataItem

uid

identifier of the employer.

ReportDataItem

employer

Name of the employer

ReportDataItem

employerAddress

Address of the employer

ReportAddressData

income

Income

ReportDataItem

extra

Additional extracted information that are not named fields.

List[ReportDataMapItem]

3.63. ReportLegalEntityData

Definition of the legal entity extracted from the documents.

Field Name Description Required Type Format

uid

UID of the company.

ReportDataItem

headOfficeUid

UID of the company head office.

ReportDataItem

name

Name of the company.

ReportDataItem

commercialName

Commercial name of the company.

ReportDataItem

addressLines

Address lines of the company.

ReportDataListItem

zipCode

Zip code of the company.

ReportDataItem

city

City of the company.

ReportDataItem

country

Country of the company.

ReportDataItem

registrationDate

Date of registration of the company.

ReportDateItem

legalForm

Legal form of the company.

ReportDataItem

activity

Type of activity of the company.

ReportDataItem

activityCode

Code of the activity of the company.

ReportDataItem

capitalAmount

Total capital of the company.

ReportDataItem

capitalCurrency

Currency of the capital of the company.

ReportDataItem

capitalType

Type of capital used by this company.

ReportDataItem

directors (DEPRECATED)

directors (deprecated since 2.28. Use administrators instead).

ReportDataListItem

administrators

Administrators of the company.

List[ReportAdministratorData]

extra

Additional extracted information that are not named fields.

Map[ReportDataItem]

3.64. ReportReferenceValues

List of all data (inputted and extracted) that were used to process checks performing matches between multiple sources.

Field Name Description Required Type Format

references

All data used as reference to perform matching checks.

✓

List[ReportDataMapItem]

3.65. ReportSummary

Light information related to the given report.

Field Name Description Required Type Format

uid

UID of the report.

✓

String

generationDate

Date of generation of the report.

✓

Date

date-time

globalStatus

Aggregated global status of the report.

✓

Enum: [NONE, OK, WARN, ERROR, OBSOLETE]

3.66. ReportVehicleData

Definition of the vehicle information extracted from the documents.

Field Name Description Required Type Format

plateNum

License plate number of the vehicle.

ReportDataItem

vin

Identification number of the vehicle.

ReportDataItem

brand

Brand of the vehicle.

ReportDataItem

model

Model of the vehicle.

ReportDataItem

bodyType

Body type of the vehicle.

ReportDataItem

type

Type of the vehicle.

ReportDataItem

firstRegistrationDate

First registration date of the vehicle.

ReportDateItem

extra

Additional extracted information that are not named fields.

Map[ReportDataItem]

3.67. SecurityHeaderField

Field used to add security context to the notification requests.

Field Name Description Required Type Format

name

Name of the header.

✓

String

Min length: 0. Max length: 40.

value

Value of the header.

✓

String

Min length: 0. Max length: 255.

3.68. TaskResponse

Representation of a task.

Field Name Description Required Type Format

uid

UID of the task.

✓

String

handledUid

Identifier for the related file or document.

String

status

Status of the task.

✓

Enum: [SUBMITTED, STARTED, MANUAL_ANALYSIS_STARTED, LIVENESS_STARTED, EMRTD_STARTED, VIDEOSCAN_STARTED, CORRELATION_SEARCH_STARTED, EXTRA_ANALYSIS_STARTED, ENDED, FAILED]

startDate

Date of creation of the task.

Date

date-time

endDate

Task completion date.

Date

date-time

message

Internal message explaining the failure of the task.

String

issuerUid

Creator of the task. This field is filled from information extracted from the access token used.

String

issuerType

Internal type of the task creator.

String

3.69. Verdict

Verdict provided for regulatory flows.

Field Name Description Required Type Format

status

Status of the verdict.

✓

Enum: [SUCCESS, REJECTED, FRAUDULENT_IDENTITY_SUSPICION, INTERNAL_ERROR, NOT_COMPLETE]

causeOfRejection

Cause of rejection of the verdict.

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 message associated with the cause of rejection of the verdict.

String