infinihash-com Alerts API

openapi: 3.2.0
info:
  title: Infinihash KYC Alerts API
  version: 1.0.0
  description: 'Identity verification, KYB, sanctions screening, UBO orchestration and periodic review.


    Auth: send your key as `X-API-Key: ` (or `Authorization: Bearer `).


    Most endpoints are mounted twice — at the root (`/kyc/...`) and under `/api` (`/api/kyc/...`). Prefer the `/api` form; it is what the hosted portals and SDKs use.


    Python SDK: `pip install "git+https://github.com/Infinihash/kyc-python@v0.1.0"` (https://github.com/Infinihash/kyc-python; runnable examples in examples/).'
  contact:
    name: Infinihash
    url: https://kyc.infinihash.com
servers:
- url: https://kyc-api.infinihash.com
  description: Production
tags:
- name: Alerts
paths:
  /alerts:
    get:
      x-route-source:
        file: routes/alertdash.js
        method: get
        path: /
      summary: List SAR alerts
      description: 'Alert dashboard: pages through the calling key''s SAR alerts with optional filters and sorting.'
      tags:
      - Alerts
      operationId: listAlerts
      parameters:
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: Filter by SAR alert stage (matches `stage` exactly).
      - name: alertType
        in: query
        required: false
        schema:
          type: string
        description: Filter by alert type (exact match).
      - name: priority
        in: query
        required: false
        schema:
          type: string
        description: Filter by priority (exact match).
      - name: assignedTo
        in: query
        required: false
        schema:
          type: string
        description: Filter by assignee (exact match).
      - name: dateFrom
        in: query
        required: false
        schema:
          type: string
          format: date-time
        description: Created at or after (an unparseable date yields a 500).
      - name: dateTo
        in: query
        required: false
        schema:
          type: string
          format: date-time
        description: Created at or before.
      - name: subject
        in: query
        required: false
        schema:
          type: string
        description: Substring match on subject.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
          maximum: 200
        description: Page size (default 50, max 200).
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
        description: Rows to skip.
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          enum:
          - createdAt
          - priority
          - stage
          - alertType
          default: createdAt
        description: Sort field.
      - name: sortDir
        in: query
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
          default: desc
        description: Sort direction.
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: Alerts page
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertDashList'
        '401':
          description: Missing API key, or invalid or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /alerts/summary:
    get:
      x-route-source:
        file: routes/alertdash.js
        method: get
        path: /summary
      summary: SAR alert counts
      description: Returns the total number of the calling key's SAR alerts and counts grouped by stage and by alert type.
      tags:
      - Alerts
      operationId: getAlertsSummary
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: Alert summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertDashSummary'
        '401':
          description: Missing API key, or invalid or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /alerts/export:
    get:
      x-route-source:
        file: routes/alertdash.js
        method: get
        path: /export
      summary: Export SAR alerts
      description: Returns up to 1000 of the calling key's SAR alerts (newest first) as a JSON array, optionally filtered. Not a file download.
      tags:
      - Alerts
      operationId: exportAlerts
      parameters:
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: Filter by SAR alert stage (matches `stage` exactly).
      - name: alertType
        in: query
        required: false
        schema:
          type: string
        description: Filter by alert type (exact match).
      - name: priority
        in: query
        required: false
        schema:
          type: string
        description: Filter by priority (exact match).
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: Alerts
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AlertDashSarAlert'
        '401':
          description: Missing API key, or invalid or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AlertDashSarAlert:
      type: object
      properties:
        id:
          type: string
        apiKeyId:
          type: string
        alertType:
          type: string
        stage:
          type: string
        priority:
          type: string
        subject:
          type:
          - string
          - 'null'
        submissionId:
          type:
          - string
          - 'null'
        transactionRefs:
          type:
          - string
          - 'null'
          description: Comma-joined list.
        autoFlags:
          type:
          - string
          - 'null'
          description: Comma-joined list.
        assignedTo:
          type:
          - string
          - 'null'
        analystNotes:
          type:
          - string
          - 'null'
        filingRef:
          type:
          - string
          - 'null'
        filedAt:
          type:
          - string
          - 'null'
          format: date-time
        closureReason:
          type:
          - string
          - 'null'
        closedAt:
          type:
          - string
          - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    AlertDashSummary:
      type: object
      required:
      - total_alerts
      - by_stage
      - by_type
      properties:
        total_alerts:
          type: integer
        by_stage:
          type: object
          additionalProperties:
            type: integer
        by_type:
          type: object
          additionalProperties:
            type: integer
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
    AlertDashList:
      type: object
      required:
      - alerts
      - total
      - filters_applied
      - page_info
      properties:
        alerts:
          type: array
          items:
            $ref: '#/components/schemas/AlertDashSarAlert'
        total:
          type: integer
          description: Total matching alerts ignoring limit/offset.
        filters_applied:
          type: object
          description: Echo of the filters supplied (omitted when not supplied).
          properties:
            status:
              type: string
            alertType:
              type: string
            priority:
              type: string
            assignedTo:
              type: string
            dateFrom:
              type: string
            dateTo:
              type: string
            subject:
              type: string
        page_info:
          type: object
          required:
          - limit
          - offset
          properties:
            limit:
              type: integer
            offset:
              type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer