### Start Document Analysis Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide Initiates the analysis process for a specified document. This should be called after the document has been created and populated with images. ```APIDOC ## POST /rest/v1/$MY_REALM/document/{documentUid}/check ### Description Starts the analysis workflow for a given document. ### Method POST ### Endpoint `/rest/v1/$MY_REALM/document/{documentUid}/check` ### Parameters #### Path Parameters - **documentUid** (string) - Required - The unique identifier of the document to analyze. ### Request Example (No request body is typically required for this endpoint) ### Response (This endpoint typically returns a 200 OK status upon successful initiation of the check. Detailed results are usually retrieved via notifications or a subsequent GET request.) ``` -------------------------------- ### Initiate File Analysis Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide Starts the analysis flow for a given file. This endpoint is used after all required documents have been added to the file. ```APIDOC ## POST /rest/v1/{realm}/file/{fileUid}/check ### Description Initiates the analysis process for a specified file. This should be called after all documents have been added to the file. ### Method POST ### Endpoint `$CIS_API_ENDPOINT/rest/v1/$MY_REALM/file/{fileUid}/check` ### Parameters #### Path Parameters - **fileUid** (string) - Required - The unique identifier of the file to analyze. #### Request Body - **(empty object)** - Required - No specific fields are required for this request. ### Request Example ```json {} ``` ### Response #### Success Response (200) - The response indicates that the analysis has been initiated. Specific details may vary, but typically confirms the start of the process. #### Response Example (No specific example provided in the source text, but typically a success confirmation.) ``` -------------------------------- ### GET /rest/v1/{realm}/task/{taskId} Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Get task content. ```APIDOC ## GET /rest/v1/{realm}/task/{taskId} ### Description Retrieve the content of a task. Tasks are linked to an entity, document or file. ### Method GET ### Endpoint `/rest/v1/{realm}/task/{taskId}` ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. - **taskId** (String) - Required - UID of the task to retrieve. #### Query Parameters - **waitTime** (Long) - Optional - 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. (Default: 0, Format: int64) ### Responses #### Success Response (200) - **_TaskResponse_** - The task response object. #### Response Example ```json { "example": "TaskResponse object" } ``` ``` -------------------------------- ### Create Document with Input Data (cURL) Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide This example demonstrates how to create a document for analysis and specify input data for cross-checking. It includes personal identity information and image data for an ID document. ```cURL curl '$CIS_API_ENDPOINT/rest/v1/$MY_REALM/document?synchronous=true' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer eyJhbGci...IbNMQKRew' \ --data '{ "type": "ID", "inputData": { "persons": [ { "identityData": { "firstNames": [ "Sherlock" ], "lastName": "Holmes", "gender": "M", "nationality": "GBR" } } ] }, "images": [ { "data": "/9j/4AAQSkZJRgABAQAAAQABAAD…(truncated)…", "documentPart": "RECTO", "type": "DL" }, { "data": "/9j/4AAQSkZJRgABAQAAAQABAAD…(truncated)…", "documentPart": "VERSO", "type": "DL" } ] }' ``` -------------------------------- ### GET /rest/v1/{realm}/file/{uid} Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Retrieves a file by its unique identifier (UID). ```APIDOC ## GET /rest/v1/{realm}/file/{uid} ### Description Gets a file by its UID. ### Method GET ### Endpoint `/rest/v1/{realm}/file/{uid}` ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. - **uid** (String) - Required - UID of the file to retrieve. ### Response #### Success Response (200) - **FileResponse** (FileResponse) - The retrieved file details. #### Response Example ```json { "example": "FileResponse body" } ``` ``` -------------------------------- ### POST /rest/v1/{realm}/document/check Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Creates a document and immediately starts the analysis flow. Images must be included, and this operation is synchronous only. It's strongly discouraged due to its time-consuming nature. ```APIDOC ## POST /rest/v1/{realm}/document/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. ### Method POST ### Endpoint `/rest/v1/{realm}/document/check` ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. #### Query Parameters - **fileUid** (String) - Optional - UID of the file you want to link. #### Request Body - **DocumentRequest** (Object) - Required - The request body for creating and checking a document. ### Request Example ```json { "DocumentRequest": { "example": "Document request body" } } ``` ### Response #### Success Response (201) - **DocumentResponse** (Object) - The response containing the document and its analysis results. #### Response Example ```json { "DocumentResponse": { "example": "Document response" } } ``` ``` -------------------------------- ### GET /websites/api_idcheck-sandbox_ariadnext_io_gw_cis_api/image/quality Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/swagger Retrieves a list of quality issues associated with a specific image UID. ```APIDOC ## GET /websites/api_idcheck-sandbox_ariadnext_io_gw_cis_api/image/quality ### Description Retrieves a list of quality issues associated with a specific image UID. ### Method GET ### Endpoint /websites/api_idcheck-sandbox_ariadnext_io_gw_cis_api/image/quality ### Parameters #### Query Parameters - **imageUid** (string) - Required - UID of the image having those quality issues. ### Response #### Success Response (200) - **imageUid** (string) - UID of the image having those quality issues. - **issues** (array) - Quality issues associated to the image. - **items** (string) - Quality issues associated to the 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"] #### Response Example { "imageUid": "2af00602-82c3-4724-b636-5037928c7fba", "issues": [ "TRUNCATED_DOCUMENT" ] } ``` -------------------------------- ### POST /rest/v1/{realm}/file/{uid}/check Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/swagger Starts the analysis flow for a file identified by its UID. This operation can be performed synchronously or asynchronously and supports forcing document analysis. ```APIDOC ## POST /rest/v1/{realm}/file/{uid}/check ### Description Starts the analysis flow of a file by its UID. 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. ### Method POST ### Endpoint /rest/v1/{realm}/file/{uid}/check ### Parameters #### Path Parameters - **realm** (string) - Required - Your realm user-readable name. - **uid** (string) - Required - UID of the file to check. #### Query Parameters - **forceDocumentAnalysis** (boolean) - Optional - 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. (Default: false) - **synchronous** (boolean) - Optional - Whether to process the request synchronously (true) or asynchronously (false). (Default: false) - **disableManualAnalysis** (boolean) - Optional - Deprecated - use manualAnalysis = DISABLE instead (Default: false) - **manualAnalysis** (string) - Optional - This parameter overrides the manual analysis trigger mechanism for this analysis flow. (Enum: DISABLE, FORCE) ### Response #### Success Response (200) - **FileReport** - Schema reference for the file analysis report. #### Success Response (202) - **TaskResponse** - Schema reference for the asynchronous task status. #### Response Example (200) ```json { "example": "FileReport schema" } ``` #### Response Example (202) ```json { "example": "TaskResponse schema" } ``` ``` -------------------------------- ### GET /rest/v1/{realm}/file/search Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Searches for files based on multiple criteria. This operation can be heavy and is discouraged outside of a GUI. ```APIDOC ## GET /rest/v1/{realm}/file/search ### Description Search for files based on multiple criteria’s. This operation can be heavy, and we strongly discourage to use this endpoint outside of a graphic user interface. ### Method GET ### Endpoint /rest/v1/{realm}/file/search ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. #### Query Parameters *Note: Specific query parameters for search are not detailed in the provided text, but would typically be listed here.* ### Response *Note: Specific response details for search are not detailed in the provided text, but would typically be listed here.* ``` -------------------------------- ### GET /rest/v1/{realm}/files Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/swagger Searches for files based on various criteria such as status, validity, type, and more. Supports pagination and sorting. ```APIDOC ## GET /rest/v1/{realm}/files ### Description Searches for files based on various criteria such as status, validity, type, and more. Supports pagination and sorting. ### Method GET ### Endpoint /rest/v1/{realm}/files ### Parameters #### Path Parameters - **realm** (string) - Required - Your realm user-readable name. #### Query Parameters - **status** (array of strings) - Optional - List of statuses of files. Possible values: "N_SEARCH_IN_PROGRESS", "EXTRA_ANALYSIS_IN_PROGRESS", "ERROR". - **validities** (array of strings) - Optional - List of validity of files. Possible values: "VALID", "INVALID", "NOT_VALIDATED". - **states** (array of strings) - Optional - States of files. - **type** (string) - Optional - Type of file. - **tag** (string) - Optional - Tag associated to files. - **name** (string) - Optional - Name of files. - **businessUid** (string) - Optional - Custom business UID of files. - **limit** (integer) - Optional - Number of files returned (1 to 50). Defaults to 10. - **offset** (integer) - Optional - Offset for pagination. Defaults to 0. - **order** (string) - Optional - Sort order field. Defaults to "creationDate". Possible values: "creationDate", "lastReportStatus", "lastUpdateDate". - **direction** (string) - Optional - Sort direction. Defaults to "desc". Possible values: "asc", "desc". - **totalOnly** (boolean) - Optional - If set to true, returns only the total count of records; no result items are included. Defaults to false. - **attachment** (string) - Optional - To display folder with or without attachment only. Defaults to "ALL". Possible values: "WITH", "WITHOUT", "ALL". ### Response #### Success Response (200) - **FileSearchResponse** (object) - The response contains a list of files matching the search criteria. #### Response Example ```json { "example": "FileSearchResponse object structure" } ``` ``` -------------------------------- ### Initiate file analysis check (cURL) Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide Starts the analysis process for a file containing multiple documents. This POST request uses the file's UID to trigger the verification workflow. Notifications will be sent upon completion. ```cURL curl -X POST '$CIS_API_ENDPOINT/rest/v1/$MY_REALM/file/3a626a76-e536-46d2-8887-64ccb364df39/check' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer eyJhbGci...IbNMQKRew' ``` -------------------------------- ### GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}/download Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/swagger Downloads a specific attachment of a file using their respective UIDs. ```APIDOC ## GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}/download ### Description Download an attachment of a file by their UIDs. ### Method GET ### Endpoint /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}/download ### Parameters #### Path Parameters - **realm** (string) - Required - Realm name - **uid** (string) - Required - file uid - **attachmentUid** (string) - Required - Attachment uid #### Query Parameters #### Request Body ### Request Example ### Response #### Success Response (200) - **byte** - The attachment content. #### Response Example ```json { "example": "attachment content as bytes" } ``` ``` -------------------------------- ### POST /rest/v1/{realm}/file/{uid}/check Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Starts the analysis flow for a file by its UID. This process analyzes all documents within the file and generates a global report. It's recommended to use asynchronous mode for this time-consuming operation. ```APIDOC ## POST /rest/v1/{realm}/file/{uid}/check ### Description Start the analysis flow of a file by its UID. 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. ### Method POST ### Endpoint `/rest/v1/{realm}/file/{uid}/check` ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. - **uid** (String) - Required - UID of the file to check. #### Query Parameters - **synchronous** (Boolean) - Optional - Whether to process the request synchronously (true) or asynchronously (false). Default: false ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (204) - No content (synchronous mode) #### Success Response (202) - **TaskResponse** - Accepted (asynchronous mode) #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /rest/v1/{realm}/document/{uid}/thumbnail Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Retrieves a preview (thumbnail) of a document using its unique identifier (UID). The preview is generated from the images within the document. ```APIDOC ## GET /rest/v1/{realm}/document/{uid}/thumbnail ### Description Retrieve the preview of a document. This preview is built based on the images present inside that document. ### Method GET ### Endpoint `/rest/v1/{realm}/document/{uid}/thumbnail` ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. - **uid** (String) - Required - Document unique identifier. #### Query Parameters - **part** (Enum: [RECTO, VERSO, OTHER]) - Optional - Document part to generate thumbnail for. - **type** (String) - Optional - Image type. - **doWatermarking** (Boolean) - Optional - 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. ### Response #### Success Response (200) - **byte[]** - The thumbnail image data. #### Response Example (Binary data representing an image file) ``` -------------------------------- ### Create File with Input Data (cURL) Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide This example shows how to create a file for analysis and provide input data that will be used as a reference for cross-checks within the file. This is useful when no ID document is present or when you want to override extracted data. ```cURL curl '$CIS_API_ENDPOINT/rest/v1/$MY_REALM/file?synchronous=true' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer eyJhbGci...IbNMQKRew' \ --data '{ "inputData": { "persons": [ { "identityData": { "firstNames": [ "Sherlock" ], "lastName": "Holmes", "gender": "M", "nationality": "GBR" } } ] } }' ``` -------------------------------- ### GET /rest/v1/{realm}/file/{uid}/report Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Gets the PDF version of the last report for the file by its UID. ```APIDOC ## GET /rest/v1/{realm}/file/{uid}/report ### Description Get the PDF version of the last report for the file by its UID. ### Method GET ### Endpoint /rest/v1/{realm}/file/{uid}/report ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. - **uid** (String) - Required - UID of the file. #### Query Parameters - **doWatermarking** (Boolean) - Optional - 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. - **pdfaCompliance** (Boolean) - Optional - PDF report will be PDF/A-3 compliant. ### Response #### Success Response (200) - **byte[]** (byte array) - The PDF report content. #### Response Example (200) ```json { "example": "PDF report content as byte array" } ``` ``` -------------------------------- ### Start Document Analysis (cURL) Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide This cURL command initiates the analysis process for a previously created document. It requires the document's UID and is typically called after all necessary images have been added. The analysis is performed asynchronously, with results delivered via notifications. ```bash curl -X POST '$CIS_API_ENDPOINT/rest/v1/$MY_REALM/document/f5ba2d29-d93b-4c0e-9ad0-60fd4bf01e1c/check' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer eyJhbGci...IbNMQKRew' ``` -------------------------------- ### GET /rest/health Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/swagger Get the health status of the service. This endpoint provides a quick way to check if the Ariadnext Gateway service is operational. ```APIDOC ## GET /rest/health ### Description Get the health status of the service. This endpoint provides a quick way to check if the Ariadnext Gateway service is operational. ### Method GET ### Endpoint /rest/health ### Response #### Success Response (200) - **status** (string) - The health status of the service (e.g., "OK", "DEGRADED", "DOWN"). - **checks** (object) - An object containing the results of various internal health checks. #### Response Example ```json { "status": "OK", "checks": { "database": "OK", "cache": "OK" } } ``` ``` -------------------------------- ### GET /rest/health Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Retrieves the current health status of the service. ```APIDOC ## GET /rest/health ### Description Get the health status of the service. ### Method GET ### Endpoint `/rest/health` ### Parameters No parameters are required for this endpoint. ### Responses #### Success Response (200) OK - Returns a _HealthResponse_ object. #### Response Example ```json { "example": "HealthResponse object" } ``` ``` -------------------------------- ### File Creation with Input Data Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide This endpoint allows for the creation of a file, with the option to provide input data that will serve as a reference for cross-checks within the file. ```APIDOC ## POST /rest/v1/$MY_REALM/file ### Description Creates a file and performs cross-checks against provided input data. If an ID document is present, its data is used as reference by default, unless file-level input data is provided. ### Method POST ### Endpoint `/rest/v1/$MY_REALM/file?synchronous=true` ### Parameters #### Query Parameters - **synchronous** (boolean) - Optional - If true, the request will wait for the analysis to complete before returning. #### Request Body - **inputData** (object) - Optional - A set of information expected to be in the file for cross-checking. - **persons** (array) - Optional - An array of person objects. - **identityData** (object) - Optional - Identity information for a person. - **firstNames** (array of strings) - Optional - First names of the person. - **lastName** (string) - Optional - Last name of the person. - **gender** (string) - Optional - Gender of the person. - **nationality** (string) - Optional - Nationality of the person. ### Request Example ```json { "inputData": { "persons": [ { "identityData": { "firstNames": [ "Sherlock" ], "lastName": "Holmes", "gender": "M", "nationality": "GBR" } } ] } } ``` ### Response #### Success Response (200) - **fileId** (string) - The unique identifier for the created file. - **analysisResult** (object) - The result of the file analysis. #### Response Example ```json { "fileId": "some-file-id", "analysisResult": { ... } } ``` ``` -------------------------------- ### Create Document with Images (cURL) Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide This cURL command demonstrates how to create a new document and immediately provide images for analysis. It's suitable for flows where only one document needs processing. The 'synchronous=true' parameter ensures an immediate response with the document's UID. ```bash curl '$CIS_API_ENDPOINT/rest/v1/$MY_REALM/document?synchronous=true' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer eyJhbGci...IbNMQKRew' \ --data '{ "type": "ID", "images": [ { "data": "/9j/4AAQSkZJRgABAQAAAQABAAD…(truncated)…", "documentPart": "RECTO", "type": "DL" }, { "data": "/9j/4AAQSkZJRgABAQAAAQABAAD…(truncated)…", "documentPart": "VERSO", "type": "DL" } ] }' ``` -------------------------------- ### Get Attachment API Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Retrieve the metadata of an attachment linked to a file using their respective UIDs. ```APIDOC ## GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid} ### Description Retrieve the metadata of an attachment linked to a file using their respective UIDs. ### Method GET ### Endpoint /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid} ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. - **uid** (String) - Required - UID of the file the attachment is linked to. - **attachmentUid** (String) - Required - UID of the attachment. ### Response #### Success Response (200) - **AttachmentResponse** (_AttachmentResponse_) - Attachment retrieved successfully ``` -------------------------------- ### GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid} Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/swagger Retrieve an attachment metadata of a file by their UIDs. ```APIDOC ## GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid} ### Description Retrieve an attachment metadata of a file by their UIDs. ### Method GET ### Endpoint /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid} ### Parameters #### Path Parameters - **realm** (string) - Required - Your realm user-readable name. - **uid** (string) - Required - UID of the file the attachment is linked to. - **attachmentUid** (string) - Required - UID of the attachment. ### Responses #### Success Response (200) Attachment retrieved successfully ```json { "uid": "string", "name": "string", "content_type": "string", "size": "integer", "creation_date": "string", "last_modification_date": "string" } ``` ``` -------------------------------- ### POST /rest/v1/{realm}/file Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Creates a new file. You can optionally provide a custom UID; otherwise, one will be generated. This operation is fast and recommended for synchronous processing. ```APIDOC ## POST /rest/v1/{realm}/file ### Description Creates an empty file. It is possible to specify a custom UID, which must be unique in the database. If no UID is provided, a default one is generated. This is a fast operation, recommended for synchronous mode. ### Method POST ### Endpoint `/rest/v1/{realm}/file` ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. #### Query Parameters - **synchronous** (Boolean) - Optional - Whether to process the request synchronously (true) or asynchronously (false). Default: false #### Request Body - **FileRequest** (FileRequest) - Required - The request body for creating a file. ### Request Example ```json { "example": "FileRequest body" } ``` ### Response #### Success Response (201 - Synchronous) - **FileSummary** (FileSummary) - Details of the created file. #### Success Response (202 - Asynchronous) - **TaskResponse** (TaskResponse) - Information about the asynchronous task. #### Response Example ```json { "example": "FileSummary or TaskResponse body" } ``` ``` -------------------------------- ### Get Document Details Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide Retrieves the details and analysis report for a specific document using its unique identifier. ```APIDOC ## GET /rest/v1/$MY_REALM/document/{documentUid} ### Description Retrieves the complete details and analysis report for a specified document. ### Method GET ### Endpoint `/rest/v1/$MY_REALM/document/{documentUid}` ### Parameters #### Path Parameters - **documentUid** (string) - Required - The unique identifier of the document to retrieve. ### Request Example (No request body is required for this endpoint) ### Response #### Success Response (200) - **Details**: Contains the full report generated from the document analysis. (Structure depends on the specific analysis performed). #### Response Example (The response structure for a DocumentResponse is detailed in the document response section and annex.) ``` -------------------------------- ### POST /rest/v1/{realm}/file/{uid}/link/{documentUid} Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Links an existing document to a file using their UIDs. The document will be included in the file. This is a fast operation recommended to be done in synchronous mode. ```APIDOC ## POST /rest/v1/{realm}/file/{uid}/link/{documentUid} ### 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. ### Method POST ### Endpoint `/rest/v1/{realm}/file/{uid}/link/{documentUid}` ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. - **uid** (String) - Required - UID of the file to link the document to. - **documentUid** (String) - Required - UID of the document to link. #### Query Parameters - **synchronous** (Boolean) - Optional - Whether to process the request synchronously (true) or asynchronously (false). ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (204) - No content (synchronous mode) #### Success Response (202) - **TaskResponse** - Accepted (asynchronous mode) #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /rest/v1/{realm}/file/{uid}/check/{checkUid} Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Retrieves the check report of a file by its UIDs. This endpoint is deprecated. ```APIDOC ## GET /rest/v1/{realm}/file/{uid}/check/{checkUid} ### Description Retrieve the check report of a file by their UIDs. Note that this feature is deprecated as only the last report exists now. ### Method GET ### Endpoint /rest/v1/{realm}/file/{uid}/check/{checkUid} ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. - **uid** (String) - Required - UID of the file holding the report. - **checkUid** (String) - Required - UID of the check report. #### Query Parameters - **forceDocumentAnalysis** (Boolean) - Optional - 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. - **synchronous** (Boolean) - Optional - Whether to process the request synchronously (true) or asynchronously (false). - **disableManualAnalysis** (Boolean) - Optional - Deprecated - use manualAnalysis = DISABLE instead. - **manualAnalysis** (Enum: [DISABLE, FORCE]) - Optional - This parameter overrides the manual analysis trigger mechanism for this analysis flow. ### Response #### Success Response (200) - **FileReport** (Object) - The analysis report for the file. #### Success Response (202) - **TaskResponse** (Object) - Response indicating the task was accepted for asynchronous processing. #### Response Example (200) ```json { "example": "FileReport object" } ``` #### Response Example (202) ```json { "example": "TaskResponse object" } ``` ``` -------------------------------- ### GET /rest/v1/{realm}/document/{uid} Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Retrieves a document by its UID, including its metadata and the last associated analysis report. ```APIDOC ## GET /rest/v1/{realm}/document/{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. ### Method GET ### Endpoint `/rest/v1/{realm}/document/{uid}` ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. - **uid** (String) - Required - UID of the document to retrieve. ### Response #### Success Response (200) - **DocumentResponse** (Object) - The response containing the document details and analysis report. #### Response Example ```json { "DocumentResponse": { "example": "Document response" } } ``` ``` -------------------------------- ### POST /rest/v1/{realm}/file/{uid}/clone Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Clones a file by its UID, creating a new entry with all associated metadata and documents. A custom UID can be provided, or one will be generated. ```APIDOC ## POST /rest/v1/{realm}/file/{uid}/clone ### 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. ### Method POST ### Endpoint `/rest/v1/{realm}/file/{uid}/clone` ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. - **uid** (String) - Required - UID of the file to clone. #### Query Parameters - **synchronous** (Boolean) - Optional - Whether to process the request synchronously (true) or asynchronously (false). Default: false - **newFileUid** (String) - Optional - UID of the new file. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (201) - **TaskResponse** - Task accepted #### Success Response (200) - **FileSummary** - Cloned file #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### POST /rest/v1/realm/{realm}/document Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/swagger Creates a new document or links an existing file to a document. If an existing file is provided, the document will be immediately linked to that file. ```APIDOC ## POST /rest/v1/realm/{realm}/document ### Description Creates a new document or links an existing file to a document. If an existing file is provided, the document will be immediately linked to that file. ### Method POST ### Endpoint /rest/v1/realm/{realm}/document ### Parameters #### Path Parameters - **realm** (string) - Required - Your realm user-readable name. #### Query Parameters - **fileUid** (string) - Optional - UID of the file you want to link. #### Request Body - **DocumentRequest** (object) - Required - The schema for the document request. ### Request Example ```json { "example": "request body for DocumentRequest" } ``` ### Response #### Success Response (201) - **DocumentResponse** (object) - The schema for the document response. #### Response Example ```json { "example": "response body for DocumentResponse" } ``` ``` -------------------------------- ### Create File Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide Creates an empty file to which documents can be added. It is recommended to use synchronous mode for this call. ```APIDOC ## POST /rest/v1/{realm}/file ### Description Creates an empty file to hold documents. Synchronous mode is recommended. ### Method POST ### Endpoint `$CIS_API_ENDPOINT/rest/v1/$MY_REALM/file?synchronous=true` ### Parameters #### Query Parameters - **synchronous** (boolean) - Optional - Set to `true` for synchronous mode. #### Request Body - **(empty object)** - Required - No specific fields are required for an empty file. ### Request Example ```json {} ``` ### Response #### Success Response (200) - **uid** (string) - The unique identifier of the created file. - **creationDate** (string) - The date and time the file was created. - **lastUpdateDate** (string) - The date and time the file was last updated. - **validity** (string) - The validation status of the file (e.g., "NOT_VALIDATED"). - **state** (string) - The current state of the file (e.g., "INITIAL"). #### Response Example ```json { "uid": "3a626a76-e536-46d2-8887-64ccb364df39", "creationDate": "2025-10-21T10:52:27+0200", "lastUpdateDate": "2025-10-21T10:52:27+0200", "validity": "NOT_VALIDATED", "state": "INITIAL" } ``` ``` -------------------------------- ### GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}/thumbnail Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/swagger Downloads the thumbnail of an attachment associated with a file, identified by their UIDs. ```APIDOC ## GET /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}/thumbnail ### Description Download the thumbnail of an attachment by their UIDs. ### Method GET ### Endpoint /rest/v1/{realm}/file/{uid}/attachment/{attachmentUid}/thumbnail ### Parameters #### Path Parameters - **realm** (string) - Required - Realm name - **uid** (string) - Required - file uid - **attachmentUid** (string) - Required - Attachment uid #### Query Parameters #### Request Body ### Request Example ### Response #### Success Response (200) - **byte** - The attachment thumbnail content. #### Response Example ```json { "example": "thumbnail content as bytes" } ``` ``` -------------------------------- ### POST /rest/v1/{realm}/document/{uid}/check Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/index Initiates the analysis flow for a document using its UID. Asynchronous mode is strongly recommended due to the time-consuming nature of this operation. ```APIDOC ## POST /rest/v1/{realm}/document/{uid}/check ### 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. ### Method POST ### Endpoint /rest/v1/{realm}/document/{uid}/check ### Parameters #### Path Parameters - **realm** (String) - Required - Your realm user-readable name. - **uid** (String) - Required - UID of the document to check. #### Query Parameters - **forceDocumentAnalysis** (Boolean) - Optional - 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. Defaults to false. - **synchronous** (Boolean) - Optional - Whether to process the request synchronously (true) or asynchronously (false). Defaults to false. - **disableManualAnalysis** (Boolean) - Optional - Deprecated - use manualAnalysis = DISABLE instead. Defaults to false. - **manualAnalysis** (Enum: [DISABLE, FORCE]) - Optional - This parameter overrides the manual analysis trigger mechanism for this analysis flow. Defaults to null. ### Response #### Success Response (200) OK (synchronous mode) - Returns a _DocumentReport_ object. #### Success Response (202) Accepted (asynchronous mode) - Returns a _TaskResponse_ object. ``` -------------------------------- ### Create Document with Images Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide This endpoint allows you to create a new document and upload images for analysis in a single call. It is recommended to use synchronous mode for this operation. ```APIDOC ## POST /rest/v1/$MY_REALM/document?synchronous=true ### Description Creates a new document and uploads associated images for analysis. Supports synchronous mode for immediate response. ### Method POST ### Endpoint `/rest/v1/$MY_REALM/document?synchronous=true` ### Parameters #### Query Parameters - **synchronous** (boolean) - Optional - If true, the request will wait for the document creation to complete and return the result. #### Request Body - **type** (string) - Required - The type of the document (e.g., "ID"). - **images** (array) - Required - An array of image objects to be associated with the document. - **data** (string) - Required - Base64 encoded image data. - **documentPart** (string) - Required - The part of the document the image represents (e.g., "RECTO", "VERSO"). - **type** (string) - Required - The type of the image (e.g., "DL"). ### Request Example ```json { "type": "ID", "images": [ { "data": "/9j/4AAQSkZJRgABAQAAAQABAAD…(truncated)…", "documentPart": "RECTO", "type": "DL" }, { "data": "/9j/4AAQSkZJRgABAQAAAQABAAD…(truncated)…", "documentPart": "VERSO", "type": "DL" } ] } ``` ### Response #### Success Response (200) - **uid** (string) - The unique identifier of the created document. - **owner** (string) - The owner of the document. - **type** (string) - The type of the document. - **creationDate** (string) - The date and time the document was created. - **lastUpdateDate** (string) - The date and time the document was last updated. #### Response Example ```json { "uid": "f5ba2d29-d93b-4c0e-9ad0-60fd4bf01e1c", "owner": "my-company", "type": "ID", "creationDate": "2025-10-21T10:52:27+0200", "lastUpdateDate": "2025-10-21T10:52:27+0200" } ``` ``` -------------------------------- ### Get File Details Source: https://api.idcheck-sandbox.ariadnext.io/gw/cis/api/developer-guide Retrieves the details and generated report for a specific file after the analysis is complete. Notifications will be sent when the analysis is done. ```APIDOC ## GET /rest/v1/{realm}/file/{fileUid} ### Description Retrieves the details and the generated report for a specified file. This is typically called after receiving a notification that the analysis is complete. ### Method GET ### Endpoint `$CIS_API_ENDPOINT/rest/v1/$MY_REALM/file/{fileUid}` ### Parameters #### Path Parameters - **fileUid** (string) - Required - The unique identifier of the file to retrieve. ### Response #### Success Response (200) - The response contains the file details, including all associated documents and the generated analysis report. Document response details are included within the file response. #### Response Example (An example of a `FileResponse` is available in the annex, but not provided in the source text.) ```