> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deepxl.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get fraud detection history

> Get a paginated list of fraud detection records for the organization. Supports sorting, pagination, and tag filtering.



## OpenAPI

````yaml /openapi.json get /v1/detection
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:
    get:
      tags:
        - Fraud Detection
      summary: Get fraud detection history
      description: >-
        Get a paginated list of fraud detection records for the organization.
        Supports sorting, pagination, and tag filtering.
      operationId: get_detection_history_v1_detection_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 25
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
        - name: sortBy
          in: query
          required: false
          schema:
            type: string
            default: fraudDetectionId
            title: Sortby
        - name: direction
          in: query
          required: false
          schema:
            type: string
            default: desc
            title: Direction
        - name: tagFilter
          in: query
          required: false
          schema:
            type: string
            default: ''
            title: Tagfilter
        - name: mediaType
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Mediatype
        - name: fileType
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Filetype
        - name: fileName
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Filename
        - name: model
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Model
        - name: minLikelihood
          in: query
          required: false
          schema:
            anyOf:
              - type: number
                maximum: 100
                minimum: 0
              - type: 'null'
            title: Minlikelihood
        - name: maxLikelihood
          in: query
          required: false
          schema:
            anyOf:
              - type: number
                maximum: 100
                minimum: 0
              - type: 'null'
            title: Maxlikelihood
        - name: fraudSeverity
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Fraudseverity
        - name: classification
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Classification
        - name: minTimestamp
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 2147483647
                minimum: 0
              - type: 'null'
            title: Mintimestamp
        - name: maxTimestamp
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 2147483647
                minimum: 0
              - type: 'null'
            title: Maxtimestamp
      responses:
        '200':
          description: Fraud detection history retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetectionHistoryResponse'
              example:
                totalCount: 42
                count: 1
                data:
                  - detectionId: 123
                    mediaType: image
                    fileType: jpeg
                    fileName: document.jpg
                    fileSize: 231433
                    model: document
                    likelihood: 15.5
                    fraudSeverity: low
                    country: us
                    reasoning:
                      - Document structure appears authentic
                      - No manipulation detected
                    modelResults:
                      technicalChecks:
                        - type: DOCUMENT_STRUCTURE
                          status: PASS
                          details: Document structure is consistent
                    classification: authentic
                    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: original_file
                        fileName: document.jpg
                        fileSize: 231433
                        contentType: image/jpeg
                        timestamp: 1725795600
                        timestampISO: '2024-09-08T10:00:00.000000'
                        url: https://api.deepxl.ai/v1/files/fd_123_document.jpg
        '400':
          description: Invalid request parameters (sortBy or direction)
        '401':
          description: Authentication required - API key or Clerk token missing/invalid
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal server error
      security:
        - API Key: []
components:
  schemas:
    DetectionHistoryResponse:
      properties:
        totalCount:
          type: integer
          title: Totalcount
          description: Total number of records matching the query
        count:
          type: integer
          title: Count
          description: Number of records returned in this page
        data:
          items:
            $ref: '#/components/schemas/FraudDetection'
          type: array
          title: Data
          description: List of fraud detection records
      type: object
      required:
        - totalCount
        - count
        - data
      title: DetectionHistoryResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FraudDetection:
      properties:
        detectionId:
          type: integer
          title: Detectionid
          description: Unique identifier for the detection record
        mediaType:
          type: string
          title: Mediatype
          description: Media type category (e.g. image, document)
        fileType:
          type: string
          title: Filetype
          description: File extension (e.g. jpeg, png, pdf)
        fileName:
          type: string
          title: Filename
          description: Original file name
        fileSize:
          type: integer
          title: Filesize
          description: File size in bytes
        timestamp:
          type: integer
          title: Timestamp
          description: Unix timestamp of when the analysis was performed
        timestampISO:
          type: string
          title: Timestampiso
          description: ISO 8601 timestamp of when the analysis was performed
        model:
          type: string
          title: Model
          description: Model used for analysis (document or object)
        modelVersion:
          anyOf:
            - type: string
            - type: 'null'
          title: Modelversion
          description: Version of the model used (e.g. 1.1.0)
        likelihood:
          type: number
          title: Likelihood
          description: Fraud likelihood as a percentage (0-100)
        fraudSeverity:
          anyOf:
            - type: string
            - type: 'null'
          title: Fraudseverity
          description: >-
            Fraud severity level: low (0-30%), medium (30-70%), high (70-100%),
            or null for rejected documents
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
          description: Normalized country hint for this request (us, mx, br)
        classification:
          anyOf:
            - type: string
            - type: 'null'
          title: Classification
          description: Classification label (e.g. authentic, suspicious, verified)
        reasoning:
          items:
            type: string
          type: array
          title: Reasoning
          description: List of natural-language explanations for the analysis findings
        modelResults:
          additionalProperties: true
          type: object
          title: Modelresults
          description: Technical check results from the model
        tags:
          items:
            $ref: '#/components/schemas/Tag'
          type: array
          title: Tags
          description: Metadata tags attached to this detection
          default: []
        files:
          items:
            $ref: '#/components/schemas/FileData'
          type: array
          title: Files
          description: Associated files (original upload, heatmaps)
          default: []
      type: object
      required:
        - detectionId
        - mediaType
        - fileType
        - fileName
        - fileSize
        - timestamp
        - timestampISO
        - model
        - likelihood
        - reasoning
        - modelResults
      title: FraudDetection
    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
    Tag:
      properties:
        name:
          type: string
          title: Name
          description: Tag key name
        value:
          type: string
          title: Value
          description: Tag value
      type: object
      required:
        - name
        - value
      title: Tag
    FileData:
      properties:
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
          description: File category (e.g. original_file, heatmap, id, face)
        fileName:
          type: string
          title: Filename
          description: Name of the file
        fileSize:
          type: integer
          title: Filesize
          description: File size in bytes
        contentType:
          type: string
          title: Contenttype
          description: MIME content type (e.g. image/jpeg, application/pdf)
        timestamp:
          type: integer
          title: Timestamp
          description: Unix timestamp of when the file was created
        timestampISO:
          type: string
          title: Timestampiso
          description: ISO 8601 timestamp of when the file was created
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
          description: URL to retrieve the file via GET /v1/files/{fileName}
      type: object
      required:
        - fileName
        - fileSize
        - contentType
        - timestamp
        - timestampISO
      title: FileData
  securitySchemes:
    API Key:
      type: apiKey
      description: API key created in the dashboard
      in: header
      name: x-api-key

````