### Get available fraud detection models Source: https://docs.deepxl.ai/llms.txt Get a list of available fraud detection models with their capabilities and supported file types. ```APIDOC ## Get available fraud detection models ### Description Get a list of available fraud detection models with their capabilities and supported file types. ### Method GET ### Endpoint /fraud-detection/models ### Response #### Success Response (200) - **models** (array) - A list of available fraud detection models. ``` -------------------------------- ### Get list of parsing models Source: https://docs.deepxl.ai/api-reference/document-parsing/get-list-of-parsing-models Retrieve a list of available document parsing models with their capabilities and supported file types. ```APIDOC ## GET /v1/parsing-models ### Description Retrieve a list of available document parsing models with their capabilities and supported file types. ### Method GET ### Endpoint /v1/parsing-models ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **name** (string) - The name of the parsing model. - **description** (string) - A description of the model's capabilities. - **tags** (array of strings) - Tags associated with the model (e.g., "id-parsing", "fast"). - **category** (string) - The category of the model (e.g., "document-parsing"). - **validInputTypes** (array of strings) - Supported input types (e.g., "image", "document"). - **validFileTypes** (array of strings) - Supported file extensions (e.g., "jpg", "pdf"). - **ownedBy** (string) - The owner of the model (e.g., "DeepXL"). - **version** (string) - The version of the model. #### Response Example ```json [ { "name": "light", "description": "Parsing light model. Data extraction is aimed at Driver License, State ID, Residency Permit, Social Security Card, Military ID", "tags": [ "id-parsing", "fast" ], "category": "document-parsing", "validInputTypes": [ "image", "document" ], "validFileTypes": [ "jpg", "jpeg", "png", "webp", "pdf" ], "ownedBy": "DeepXL", "version": "1.0.0" }, { "name": "performance", "description": "Parsing performance model. Data extraction is aimed at Bank statements, US pay stubs", "tags": [ "document-parsing", "comprehensive" ], "category": "document-parsing", "validInputTypes": [ "image", "document" ], "validFileTypes": [ "jpg", "jpeg", "png", "webp", "pdf" ], "ownedBy": "DeepXL", "version": "1.0.0" } ] ``` ### Error Handling - **401** - Authentication required - API key or Clerk token missing/invalid. ``` -------------------------------- ### Get list of parsing models Source: https://docs.deepxl.ai/llms.txt Retrieve a list of available document parsing models with their capabilities and supported file types. ```APIDOC ## Get list of parsing models ### Description Retrieve a list of available document parsing models with their capabilities and supported file types. ### Method GET ### Endpoint /document-parsing/models ### Response #### Success Response (200) - **models** (array) - A list of available parsing models. ``` -------------------------------- ### Get Verification Source: https://docs.deepxl.ai/llms.txt Get details of a specific verification by its ID, including all associated tags and files. ```APIDOC ## Get Verification ### Description Get details of a specific verification by its ID, including all associated tags and files. ### Method GET ### Endpoint /id-verification/{verification_id} ### Parameters #### Path Parameters - **verification_id** (string) - Required - The ID of the verification. ### Response #### Success Response (200) - **verification_data** (object) - The verification details, including tags and files. ``` -------------------------------- ### Example Tags Value for ID Verification Source: https://docs.deepxl.ai/api-reference/id-verification/verify-user-with-their-id-and-selfie Pass optional metadata as a JSON object to organize and filter your verification results. Recommended fields include customerId, customerName, documentId, companyName, and companyId. ```json {"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-001","companyName":"DeepXL","companyId":"COMP-001"} ``` -------------------------------- ### Get Verification Details Source: https://docs.deepxl.ai/api-reference/id-verification/get-verification Fetches detailed information about a specific verification, including all associated tags and files, by its unique ID. ```APIDOC ## GET /verification/{verificationId} ### Description Retrieves detailed information about a specific verification, including all associated tags and files, by its unique ID. ### Method GET ### Endpoint /verification/{verificationId} ### Parameters #### Path Parameters - **verificationId** (string) - Required - The unique identifier of the verification to retrieve. ``` -------------------------------- ### Get Available Fraud Detection Models Source: https://docs.deepxl.ai/api-reference/fraud-detection/get-available-fraud-detection-models This endpoint retrieves a list of all available fraud detection models. Each model includes a description, supported tags, category, input types, valid file types, ownership, and version. ```APIDOC ## GET /v1/detection-models ### Description Get a list of available fraud detection models with their capabilities and supported file types. ### Method GET ### Endpoint /v1/detection-models ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **name** (string) - The name of the model. - **description** (string) - A detailed description of the model's purpose and capabilities. - **tags** (array of strings) - Tags associated with the model for categorization and filtering. - **category** (string) - The general category the model belongs to (e.g., "fraud-detection"). - **validInputTypes** (array of strings) - The types of input the model can process (e.g., "image", "document"). - **validFileTypes** (array of strings) - The file extensions the model supports (e.g., "jpg", "pdf"). - **ownedBy** (string) - The entity that owns or developed the model. - **version** (string) - The version number of the model. #### Response Example ```json [ { "name": "document", "description": "Advanced document fraud detection model that analyzes documents for signs of manipulation and tampering.", "tags": [ "fraud-detection", "document-verification" ], "category": "fraud-detection", "validInputTypes": [ "image", "document" ], "validFileTypes": [ "jpg", "jpeg", "png", "webp", "pdf" ], "ownedBy": "DeepXL", "version": "1.1.0" }, { "name": "object", "description": "AI-generated image detection model that identifies synthetic or manipulated images.", "tags": [ "ai-detection", "image-verification" ], "category": "fraud-detection", "validInputTypes": [ "image" ], "validFileTypes": [ "jpg", "jpeg", "png", "webp" ], "ownedBy": "DeepXL", "version": "1.0.0" } ] ``` ``` -------------------------------- ### OpenAPI Specification for Fraud Detection Models Source: https://docs.deepxl.ai/api-reference/fraud-detection/get-available-fraud-detection-models This OpenAPI 3.1.0 specification defines the GET /v1/detection-models endpoint. It details the available fraud detection models, their descriptions, supported input and file types, and versions. ```yaml openapi: 3.1.0 info: title: DeepXL API description: >- Professional document analysis and verification API for fraud detection, identity verification, and data extraction. contact: name: DeepXL Support url: https://deepxl.ai/contact email: hello@deepxl.ai version: 1.1.0 servers: - url: https://api.deepxl.ai description: Production security: [] tags: - name: Fraud Detection description: Detect manipulated or AI-generated content in documents and images. - name: Document Parsing description: Extract structured data from IDs, bank statements, and pay stubs. - name: ID Verification description: Match an ID document against a selfie. - name: File Retrieval description: Fetch original uploads or generated heatmaps from a prior analysis. paths: /v1/detection-models: get: tags: - Fraud Detection summary: Get available fraud detection models description: >- Get a list of available fraud detection models with their capabilities and supported file types. operationId: get_detection_models_v1_detection_models_get responses: '200': description: List of available fraud detection models content: application/json: schema: $ref: '#/components/schemas/RootModel_list_ModelMetadata__' example: - name: document description: >- Advanced document fraud detection model that analyzes documents for signs of manipulation and tampering. tags: - fraud-detection - document-verification category: fraud-detection validInputTypes: - image - document validFileTypes: - jpg - jpeg - png - webp - pdf ownedBy: DeepXL version: 1.1.0 - name: object description: >- AI-generated image detection model that identifies synthetic or manipulated images. tags: - ai-detection - image-verification category: fraud-detection validInputTypes: - image validFileTypes: - jpg - jpeg - png - webp ownedBy: DeepXL version: 1.0.0 security: - API Key: [] components: schemas: RootModel_list_ModelMetadata__: items: $ref: '#/components/schemas/ModelMetadata' type: array title: RootModel[list[ModelMetadata]] ModelMetadata: properties: name: type: string title: Name description: type: string title: Description tags: items: type: string type: array title: Tags category: type: string title: Category validInputTypes: items: type: string type: array title: Validinputtypes validFileTypes: items: type: string type: array title: Validfiletypes ownedBy: type: string title: Ownedby version: type: string title: Version type: object required: - name - description - tags - category - validInputTypes - validFileTypes - ownedBy - version title: ModelMetadata securitySchemes: API Key: type: apiKey description: API key created in the dashboard in: header name: x-api-key ``` -------------------------------- ### OpenAPI Specification for File Retrieval Source: https://docs.deepxl.ai/api-reference/file-retrieval/retrieve-a-file This OpenAPI specification defines the GET /v1/files/{fileName} endpoint for retrieving files. It includes details on parameters, responses, and security schemes. ```yaml openapi: 3.1.0 info: title: DeepXL API description: >- Professional document analysis and verification API for fraud detection, identity verification, and data extraction. contact: name: DeepXL Support url: https://deepxl.ai/contact email: hello@deepxl.ai version: 1.1.0 servers: - url: https://api.deepxl.ai description: Production security: [] tags: - name: Fraud Detection description: Detect manipulated or AI-generated content in documents and images. - name: Document Parsing description: Extract structured data from IDs, bank statements, and pay stubs. - name: ID Verification description: Match an ID document against a selfie. - name: File Retrieval description: Fetch original uploads or generated heatmaps from a prior analysis. paths: /v1/files/{fileName}: get: tags: - File Retrieval summary: Retrieve a file description: >- Retrieve a file from cloud storage. Files are associated with analysis results (fraud detection, parsing, verification) and include original uploads and generated heatmaps. operationId: get_file_v1_files__fileName__get parameters: - name: fileName in: path required: true schema: type: string title: Filename responses: '200': description: File retrieved successfully content: application/octet-stream: schema: type: string format: binary '401': description: Authentication required - API key or Clerk token missing/invalid '404': description: File not found or not accessible by this organization '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '500': description: Internal server error security: - API Key: [] components: schemas: HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: API Key: type: apiKey description: API key created in the dashboard in: header name: x-api-key ``` -------------------------------- ### Submit Documentation Feedback Source: https://docs.deepxl.ai/api-reference/fraud-detection/get-available-fraud-detection-models Use this endpoint to report any issues or suggest improvements for the documentation. Include the specific path and a description of the problem. ```json { "path": "/api-reference/fraud-detection/get-available-fraud-detection-models", "feedback": "Description of the issue" } ``` -------------------------------- ### Submit Documentation Feedback Source: https://docs.deepxl.ai/api-reference/fraud-detection/get-fraud-detection-by-id Use this endpoint to report issues with the documentation. Provide the specific path and a description of the problem. ```json { "path": "/api-reference/fraud-detection/get-fraud-detection-by-id", "feedback": "Description of the issue" } ``` -------------------------------- ### Get Parse History Source: https://docs.deepxl.ai/llms.txt Get the document parse history for the organization. Supports sorting, pagination, and tag filtering. ```APIDOC ## Get Parse History ### Description Get the document parse history for the organization. Supports sorting, pagination, and tag filtering. ### Method GET ### Endpoint /document-parsing/history ### Parameters #### Query Parameters - **sort** (string) - Optional - Field to sort the results by. - **page** (integer) - Optional - Page number for pagination. - **limit** (integer) - Optional - Number of results per page. - **tag** (string) - Optional - Filter results by tag. ### Response #### Success Response (200) - **history** (array) - A list of past document parsing records. ``` -------------------------------- ### Get fraud detection by ID Source: https://docs.deepxl.ai/llms.txt Get a specific fraud detection record by its ID, including all associated tags and files. ```APIDOC ## Get fraud detection by ID ### Description Get a specific fraud detection record by its ID, including all associated tags and files. ### Method GET ### Endpoint /fraud-detection/{analysis_id} ### Parameters #### Path Parameters - **analysis_id** (string) - Required - The ID of the fraud detection record. ### Response #### Success Response (200) - **analysis_data** (object) - The fraud detection analysis data, including tags and files. ``` -------------------------------- ### Submit Documentation Feedback Source: https://docs.deepxl.ai/api-reference/id-verification/get-verification Use this endpoint to report issues with the documentation. Include the path to the page and a description of the problem. ```json { "path": "/api-reference/id-verification/get-verification", "feedback": "Description of the issue" } ``` -------------------------------- ### Submit Documentation Feedback Source: https://docs.deepxl.ai/api-reference/document-parsing/parse-document Use this endpoint to submit feedback on the documentation. Include the path to the document and a description of the issue. ```json { "path": "/api-reference/document-parsing/parse-document", "feedback": "Description of the issue" } ``` -------------------------------- ### Get fraud detection history Source: https://docs.deepxl.ai/llms.txt Get a paginated list of fraud detection records for the organization. Supports sorting, pagination, and tag filtering. ```APIDOC ## Get fraud detection history ### Description Get a paginated list of fraud detection records for the organization. Supports sorting, pagination, and tag filtering. ### Method GET ### Endpoint /fraud-detection/history ### Parameters #### Query Parameters - **sort** (string) - Optional - Field to sort the results by. - **page** (integer) - Optional - Page number for pagination. - **limit** (integer) - Optional - Number of results per page. - **tag** (string) - Optional - Filter results by tag. ### Response #### Success Response (200) - **history** (array) - A list of fraud detection records. ``` -------------------------------- ### Submit Documentation Feedback Source: https://docs.deepxl.ai/en/introduction Use this endpoint to submit feedback on documentation issues. Include the path to the documentation and a description of the problem. ```json { "path": "/en/introduction", "feedback": "Description of the issue" } ``` -------------------------------- ### Filter Results by Tags Source: https://docs.deepxl.ai/api-reference/document-parsing/parse-document Filter parsing results by tags using a GET request. ```APIDOC ## GET /parse ### Description Retrieve parsing results filtered by tags. ### Method GET ### Endpoint /parse ### Parameters #### Query Parameters - **tagFilter** (string) - Required - Filter results based on tag key-value pairs. Example: `customerId=9999`. ``` -------------------------------- ### Submit Documentation Feedback Source: https://docs.deepxl.ai/api-reference/document-parsing/get-list-of-parsing-models Use this endpoint to submit feedback on the documentation. Include the path of the page and a description of the issue. ```json { "path": "/api-reference/document-parsing/get-list-of-parsing-models", "feedback": "Description of the issue" } ``` -------------------------------- ### Get Parse History Source: https://docs.deepxl.ai/api-reference/document-parsing/get-parse-history Fetches a list of past document parsing operations. Supports filtering and pagination. ```APIDOC ## GET /v1/history ### Description Retrieves a paginated list of document parsing history records. You can filter and sort the results. ### Method GET ### Endpoint /v1/history ### Query Parameters - **limit** (integer) - Optional - The maximum number of records to return per page. - **offset** (integer) - Optional - The number of records to skip before starting to collect the result set. - **sortBy** (string) - Optional - Field to sort the results by. Allowed values: `timestamp`. - **direction** (string) - Optional - The direction of sorting. Allowed values: `asc`, `desc`. ### Response #### Success Response (200) - **totalCount** (integer) - Total number of records matching the query. - **count** (integer) - Number of records returned in this page. - **data** (array) - List of parse records. Each record contains details like `parseId`, `mediaType`, `fileType`, `fileName`, `fileSize`, `timestamp`, `timestampISO`, `model`, `modelVersion`, `country`, `documentType`, `parsedData`, `tags`, and `files`. #### Response Example ```json { "totalCount": 100, "count": 10, "data": [ { "parseId": 123, "mediaType": "image", "fileType": "jpeg", "fileName": "drivers_license.jpg", "fileSize": 231433, "timestamp": 1725795600, "timestampISO": "2024-09-08T10:00:00.000000", "model": "performance", "modelVersion": "1.2.0", "country": "us", "documentType": "usa_driver_license", "parsedData": { "name": "John Doe", "address": "123 Main St" }, "tags": [ { "customerId": "9999", "customerName": "Acme Corp" } ], "files": [ { "category": "original_file", "fileName": "drivers_license.jpg", "fileSize": 231433, "contentType": "image/jpeg", "timestamp": 1725795600, "timestampISO": "2024-09-08T10:00:00.000000", "url": "https://api.deepxl.ai/v1/files/parse_117_drivers_license.jpg" } ] } ] } ``` ### Error Handling - **400** - Invalid request parameters (sortBy or direction). - **401** - Authentication required - API key or Clerk token missing/invalid. - **422** - Validation Error. - **500** - Internal server error. ``` -------------------------------- ### Submit Documentation Feedback Source: https://docs.deepxl.ai/api-reference/document-parsing/get-parse-history Use this endpoint to submit feedback on the documentation. Include the specific path of the page you are referencing and a clear description of the issue. ```json { "path": "/api-reference/document-parsing/get-parse-history", "feedback": "Description of the issue" } ``` -------------------------------- ### Submit Feedback on Documentation Source: https://docs.deepxl.ai/api-reference/file-retrieval/retrieve-a-file Use this endpoint to submit feedback if you encounter incorrect, outdated, or confusing documentation. Provide a specific and actionable description of the issue. ```json { "path": "/api-reference/file-retrieval/retrieve-a-file", "feedback": "Description of the issue" } ``` -------------------------------- ### Get parsed document Source: https://docs.deepxl.ai/llms.txt Retrieve the results of a previously parsed document by its ID, including all associated tags and files. ```APIDOC ## Get parsed document ### Description Retrieve the results of a previously parsed document by its ID, including all associated tags and files. ### Method GET ### Endpoint /document-parsing/{document_id} ### Parameters #### Path Parameters - **document_id** (string) - Required - The ID of the parsed document. ### Response #### Success Response (200) - **document_data** (object) - The parsed document data, including tags and files. ``` -------------------------------- ### Get Verification by ID Source: https://docs.deepxl.ai/api-reference/id-verification/get-verification Retrieve the details of a specific verification using its unique ID. This includes information about the ID document, selfie, verification results, and any associated tags or files. ```APIDOC ## GET /v1/verification/{verificationId} ### Description Get details of a specific verification by its ID, including all associated tags and files. ### Method GET ### Endpoint /v1/verification/{verificationId} ### Parameters #### Path Parameters - **verificationId** (integer) - Required - Unique identifier for the verification record ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **result** (object) - The verification result - **verificationId** (integer) - Unique identifier for the verification record - **idFileType** (string) - The file type of the ID document - **idFileName** (string) - The filename of the ID document - **idFileSize** (integer) - The file size of the ID document in bytes - **selfieFileType** (string) - The file type of the selfie - **selfieFileName** (string) - The filename of the selfie - **selfieFileSize** (integer) - The file size of the selfie in bytes - **model** (string) - The model used for verification - **country** (string) - The country code associated with the verification - **verified** (boolean) - Indicates if the verification was successful - **modelResults** (object) - Results from the verification model - **technicalChecks** (array) - List of technical checks performed - **type** (string) - The type of technical check (e.g., FACE_MATCH, LIVENESS) - **status** (string) - The status of the check (e.g., PASS, FAIL) - **confidence** (number) - The confidence score of the check - **details** (string) - Additional details about the check - **timestamp** (integer) - Unix timestamp of when the verification was completed - **timestampISO** (string) - ISO 8601 formatted timestamp of completion - **tags** (array) - Key-value pairs of tags associated with the verification - **name** (string) - The name of the tag - **value** (string) - The value of the tag - **files** (array) - List of files associated with the verification - **category** (string) - The category of the file (e.g., id, face) - **fileName** (string) - The name of the file - **fileSize** (integer) - The size of the file in bytes - **contentType** (string) - The MIME type of the file - **timestamp** (integer) - Unix timestamp of when the file was uploaded - **timestampISO** (string) - ISO 8601 formatted timestamp of upload - **url** (string) - The URL to access the file #### Response Example ```json { "result": { "verificationId": 456, "idFileType": "jpeg", "idFileName": "drivers_license.jpg", "idFileSize": 156789, "selfieFileType": "jpeg", "selfieFileName": "selfie.jpg", "selfieFileSize": 89012, "model": "verification", "country": "us", "verified": true, "modelResults": { "technicalChecks": [ { "type": "FACE_MATCH", "status": "PASS", "confidence": 0.95, "details": "Face match confidence: 95%" }, { "type": "LIVENESS", "status": "PASS", "confidence": 0.98, "details": "Liveness check passed" } ] }, "timestamp": 1725795600, "timestampISO": "2024-09-08T10:00:00.000000", "tags": [ { "name": "customerId", "value": "9999" }, { "name": "customerName", "value": "Acme Corp" }, { "name": "documentId", "value": "DOC-2024-001" }, { "name": "companyName", "value": "DeepXL" }, { "name": "companyId", "value": "COMP-001" } ], "files": [ { "category": "id", "fileName": "drivers_license.jpg", "fileSize": 156789, "contentType": "image/jpeg", "timestamp": 1725795600, "timestampISO": "2024-09-08T10:00:00.000000", "url": "https://api.deepxl.ai/v1/files/v_id_456_drivers_license.jpg" }, { "category": "face", "fileName": "selfie.jpg", "fileSize": 89012, "contentType": "image/jpeg", "timestamp": 1725795600, "timestampISO": "2024-09-08T10:00:00.000000", "url": "https://api.deepxl.ai/v1/files/v_face_456_selfie.jpg" } ] } } ``` #### Error Responses - **401** - Authentication required - API key or Clerk token missing/invalid - **404** - Verification record not found - **422** - Validation Error - **500** - Internal server error ``` -------------------------------- ### Analyze File Source: https://docs.deepxl.ai/api-reference/fraud-detection/analyze-a-file-for-fraud-detection Upload a file and specify a detection model to analyze it for fraud. You can also provide optional tags and a country hint for more organized results. ```APIDOC ## POST /v1/detection ### Description Analyzes a file for fraud detection using a specified model. ### Method POST ### Endpoint /v1/detection ### Parameters #### Request Body - **model** (string) - Required - Model to use for analysis; Available models: document, object - **file** (file) - Required - The file to analyze (e.g., image, document) - **tags** (string) - Optional - JSON object with key-value pairs for organizing results. Example: {"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-001","companyName":"DeepXL","companyId":"COMP-001"} - **country** (string) - Optional - Country hint for analysis. Supported values: us, mx, br. Defaults to 'us'. ### Request Example ```json { "model": "object", "file": "", "tags": "{\"customerId\":\"9999\",\"customerName\":\"Acme Corp\"}", "country": "us" } ``` ### Response #### Success Response (200) - **result** (object) - The fraud detection result - **detectionId** (integer) - Unique identifier for the detection record - **mediaType** (string) - The media type of the analyzed file - **fileType** (string) - The type of the analyzed file - **fileName** (string) - The name of the analyzed file - **fileSize** (integer) - The size of the analyzed file in bytes - **model** (string) - The model used for detection - **likelihood** (float) - The likelihood of fraud (0-100%) - **fraudSeverity** (string) - The severity level of the detected fraud (e.g., low, medium, high) - **country** (string) - The country associated with the detection - **reasoning** (array) - An array of strings explaining the detection results - **modelResults** (object) - Detailed results from the detection model - **technicalChecks** (array) - Results of technical checks performed - **classification** (string) - The final classification of the file (e.g., verified, suspicious) - **timestamp** (integer) - The Unix timestamp of the detection - **timestampISO** (string) - The ISO 8601 formatted timestamp of the detection - **tags** (array) - An array of tag objects associated with the detection - **name** (string) - The name of the tag - **value** (string) - The value of the tag - **files** (array) - An array of file objects related to the detection - **category** (string) - The category of the file (e.g., original_file) - **fileName** (string) - The name of the file - **fileSize** (integer) - The size of the file in bytes - **contentType** (string) - The content type of the file - **timestamp** (integer) - The Unix timestamp of the file - **timestampISO** (string) - The ISO 8601 formatted timestamp of the file - **url** (string) - The URL to access the file #### Response Example ```json { "result": { "detectionId": 1, "mediaType": "image", "fileType": "jpeg", "fileName": "photo.jpg", "fileSize": 231433, "model": "object", "likelihood": 4.75, "fraudSeverity": "low", "country": "us", "reasoning": [ "Image appears authentic with only 4.7% AI probability. Natural characteristics suggest genuine photography." ], "modelResults": { "technicalChecks": [] }, "classification": "verified", "timestamp": 1725795600, "timestampISO": "2024-09-08T10:00:00.000000", "tags": [ { "name": "customerId", "value": "9999" }, { "name": "customerName", "value": "Acme Corp" }, { "name": "documentId", "value": "DOC-2024-002" }, { "name": "companyName", "value": "DeepXL" }, { "name": "companyId", "value": "COMP-001" } ], "files": [ { "category": "original_file", "fileName": "photo.jpg", "fileSize": 231433, "contentType": "image/jpeg", "timestamp": 1725795600, "timestampISO": "2024-09-08T10:00:00.000000", "url": "https://api.deepxl.ai/v1/files/fd_1_photo.jpg" } ] } } ``` ### Error Handling - **400**: Invalid model name or request parameters - **401**: Authentication required - API key or Clerk token missing/invalid - **415**: Unsupported media type - file type not compatible with selected model - **422**: Validation Error - **500**: Internal server error ``` -------------------------------- ### Authentication Source: https://docs.deepxl.ai/llms.txt Authenticate your API requests with an API key. ```APIDOC ## Authentication ### Description Authenticate your API requests with an API key. ### Method POST ### Endpoint /auth/api-key ### Parameters #### Request Body - **api_key** (string) - Required - Your API key. ### Response #### Success Response (200) - **token** (string) - An authentication token for subsequent requests. ``` -------------------------------- ### API Key Authentication Source: https://docs.deepxl.ai/api-reference/id-verification/get-verification Information on how to authenticate API requests using an API Key. ```APIDOC ## Security Schemes ### API Key - **Type**: API Key - **Description**: API key created in the dashboard. - **In**: Header - **Name**: x-api-key ``` -------------------------------- ### Retrieve a File Source: https://docs.deepxl.ai/api-reference/file-retrieval/retrieve-a-file Retrieve a file from cloud storage. Files are associated with analysis results (fraud detection, parsing, verification) and include original uploads and generated heatmaps. ```APIDOC ## GET /v1/files/{fileName} ### Description Retrieve a file from cloud storage. Files are associated with analysis results (fraud detection, parsing, verification) and include original uploads and generated heatmaps. ### Method GET ### Endpoint /v1/files/{fileName} ### Parameters #### Path Parameters - **fileName** (string) - Required - The name of the file to retrieve. ### Responses #### Success Response (200) - **File Content** (binary) - The content of the retrieved file. #### Error Responses - **401** - Authentication required - API key or Clerk token missing/invalid. - **404** - File not found or not accessible by this organization. - **422** - Validation Error. - **500** - Internal server error. ``` -------------------------------- ### Submit Documentation Feedback Source: https://docs.deepxl.ai/api-reference/id-verification/get-verification Allows users to submit feedback on the documentation, reporting incorrect, outdated, or confusing information. ```APIDOC ## POST /feedback ### Description Submit feedback regarding the documentation. This endpoint is used to report issues such as incorrect, outdated, or confusing information. ### Method POST ### Endpoint /feedback ### Request Body - **path** (string) - Required - The path of the documentation page the feedback pertains to. - **feedback** (string) - Required - A description of the issue or feedback. ### Request Example ```json { "path": "/api-reference/id-verification/get-verification", "feedback": "Description of the issue" } ``` ``` -------------------------------- ### Analyze a file for fraud detection Source: https://docs.deepxl.ai/llms.txt Analyze a file for fraud detection using the specified model. ```APIDOC ## Analyze a file for fraud detection ### Description Analyze a file for fraud detection using the specified model. ### Method POST ### Endpoint /fraud-detection/analyze ### Parameters #### Request Body - **file** (file) - Required - The file to analyze. - **model_id** (string) - Required - The ID of the fraud detection model to use. ### Response #### Success Response (200) - **analysis_id** (string) - The ID of the fraud detection analysis. ``` -------------------------------- ### Verify User with ID and Selfie Source: https://docs.deepxl.ai/api-reference/id-verification/verify-user-with-their-id-and-selfie Upload an ID document and a selfie to verify a user's identity. The system compares the face in the ID with the selfie and performs liveness checks. ```APIDOC ## POST /v1/verification ### Description Verify a user's identity by uploading an ID document and a selfie. The system compares the face in the ID with the selfie and performs liveness checks to ensure the person is real. **Required Files:** - `idFile` - ID document image or PDF (driver license, passport, etc.) - `selfieFile` - Selfie still image **or** selfie video (e.g. mp4, mov, webm), same field name for both **Tags Parameter:** Pass optional metadata as a JSON object to organize and filter your verification results. **Recommended tag fields:** | Field | Description | Example | |-------|-------------|---------| | `customerId` | Your customer's unique identifier | `"9999"` | | `customerName` | Customer or account name | `"Acme Corp"` | | `documentId` | Your internal document reference | `"DOC-2024-001"` | | `companyName` | Company name | `"DeepXL"` | | `companyId` | Company identifier | `"COMP-001"` | **Example tags value:** `{"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-001","companyName":"DeepXL","companyId":"COMP-001"}` You can filter results by tags using the GET endpoint: `?tagFilter=customerId=9999` ### Method POST ### Endpoint /v1/verification ### Parameters #### Request Body - **idFile** (file) - Required - The ID document image or PDF. - **selfieFile** (file) - Required - The selfie still image or video. - **tags** (string) - Optional - Metadata as a JSON object. ### Request Example ```json { "idFile": "", "selfieFile": "", "tags": "{\"customerId\":\"9999\",\"customerName\":\"Acme Corp\",\"documentId\":\"DOC-2024-001\",\"companyName\":\"DeepXL\",\"companyId\":\"COMP-001\"}" } ``` ### Response #### Success Response (200) - **verificationId** (integer) - Unique identifier for the verification. - **idFileType** (string) - File type of the uploaded ID. - **idFileName** (string) - File name of the uploaded ID. - **idFileSize** (integer) - File size of the uploaded ID. - **selfieFileType** (string) - File type of the uploaded selfie. - **selfieFileName** (string) - File name of the uploaded selfie. - **selfieFileSize** (integer) - File size of the uploaded selfie. - **model** (string) - The model used for verification. - **country** (string) - Country code associated with the ID. - **verified** (boolean) - Indicates if the verification was successful. - **modelResults** (object) - Detailed results from the verification models. - **technicalChecks** (array) - Array of technical check results. - **type** (string) - Type of technical check (e.g., FACE_MATCH, LIVENESS, ID_QUALITY). - **status** (string) - Status of the check (e.g., PASS, FAIL). - **confidence** (number) - Confidence score for the check. - **details** (string) - Additional details about the check. - **timestamp** (integer) - Unix timestamp of the verification. - **timestampISO** (string) - ISO 8601 formatted timestamp of the verification. - **tags** (array) - Array of tags associated with the verification. - **name** (string) - Name of the tag. - **value** (string) - Value of the tag. - **files** (array) - Array of files processed during verification. - **category** (string) - Category of the file (e.g., id, face). - **fileName** (string) - Name of the file. - **fileSize** (integer) - Size of the file. - **contentType** (string) - MIME type of the file. - **timestamp** (integer) - Unix timestamp of the file upload. - **timestampISO** (string) - ISO 8601 formatted timestamp of the file upload. - **url** (string) - URL to access the file. #### Response Example ```json { "result": { "verificationId": 457, "idFileType": "jpeg", "idFileName": "passport.jpg", "idFileSize": 234567, "selfieFileType": "jpeg", "selfieFileName": "live_selfie.jpg", "selfieFileSize": 112233, "model": "verification", "country": "us", "verified": true, "modelResults": { "technicalChecks": [ { "type": "FACE_MATCH", "status": "PASS", "confidence": 0.97, "details": "Face match confidence: 97%" }, { "type": "LIVENESS", "status": "PASS", "confidence": 0.99, "details": "Liveness check passed" }, { "type": "ID_QUALITY", "status": "PASS", "confidence": 0.92, "details": "ID document quality is acceptable" } ] }, "timestamp": 1725795600, "timestampISO": "2024-09-08T10:00:00.000000", "tags": [ { "name": "customerId", "value": "9999" }, { "name": "customerName", "value": "Acme Corp" }, { "name": "documentId", "value": "DOC-2024-001" }, { "name": "companyName", "value": "DeepXL" }, { "name": "companyId", "value": "COMP-001" } ], "files": [ { "category": "id", "fileName": "passport.jpg", "fileSize": 234567, "contentType": "image/jpeg", "timestamp": 1725795600, "timestampISO": "2024-09-08T10:00:00.000000", "url": "https://api.deepxl.ai/v1/files/v_id_457_passport.jpg" }, { "category": "face", "fileName": "live_selfie.jpg", "fileSize": 112233, "contentType": "image/jpeg", "timestamp": 1725795600, "timestampISO": "2024-09-08T10:00:00.000000", "url": "https://api.deepxl.ai/v1/files/v_id_457_live_selfie.jpg" } ] } } ``` -------------------------------- ### Verify User with ID and Selfie Source: https://docs.deepxl.ai/api-reference/id-verification/verify-user-with-their-id-and-selfie Upload an ID document and a selfie to verify a user's identity. The system compares the face in the ID with the selfie and performs liveness checks. ```APIDOC ## POST /verify-user ### Description Verify a user's identity by uploading an ID document and a selfie. The system compares the face in the ID with the selfie and performs liveness checks to ensure the person is real. ### Method POST ### Endpoint /verify-user ### Parameters #### Request Body - **idFile** (file) - Required - ID document image or PDF (driver license, passport, etc.) - **selfieFile** (file) - Required - Selfie still image or selfie video (e.g. mp4, mov, webm) - **tags** (string) - Optional - JSON object containing metadata to organize and filter verification results. Recommended fields include `customerId`, `customerName`, `documentId`, `companyName`, `companyId`. ### Request Example ```json { "idFile": "", "selfieFile": "", "tags": "{\"customerId\":\"9999\",\"customerName\":\"Acme Corp\",\"documentId\":\"DOC-2024-001\",\"companyName\":\"DeepXL\",\"companyId\":\"COMP-001\"}" } ``` ### Response #### Success Response (200) - **verificationId** (string) - Unique identifier for the verification process. - **status** (string) - The current status of the verification (e.g., 'pending', 'approved', 'rejected'). - **message** (string) - A message providing details about the verification result. #### Response Example ```json { "verificationId": "vfy_abc123xyz789", "status": "pending", "message": "Verification initiated successfully." } ``` ```