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

# Get Web Inquiry

> Returns the web inquiry configuration, nested result (with status history), and capture sessions with page visits and signed evidence URLs.



## OpenAPI

````yaml /api-reference/openapi.json GET /web/inquiry/{id}
openapi: 3.0.3
info:
  title: API 2.0
  version: 1.0.0
  contact: {}
servers:
  - url: https://platform.inklink.com/api/v1
security: []
tags: []
paths:
  /web/inquiry/{id}:
    get:
      summary: Get Web inquiry
      description: >-
        Returns the full web inquiry configuration, the latest `result`
        (including `status_history`, scores, and `claims`), and all capture
        `sessions` with `page_visits` and `evidence`. Each evidence item
        includes a time-limited signed `file` URL, not a raw storage path. See
        [Web Inquiry Quickstart](/web/quickstart) for the full flow.
      operationId: getWebInquiry
      parameters:
        - name: api-key
          in: header
          schema:
            type: string
            example: secret_live_xxx
          required: true
        - name: id
          in: path
          required: true
          description: Web inquiry id (`web_iq_...`).
          schema:
            type: string
            example: web_iq_xxx
      responses:
        '200':
          description: Inquiry found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Web inquiry id (`web_iq_...`).
                  template_id:
                    type: string
                    nullable: true
                  template_key:
                    type: string
                    nullable: true
                  template_version:
                    type: integer
                  name:
                    type: string
                  description:
                    type: string
                  query:
                    type: string
                  fields:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        description:
                          type: string
                  user_instruction:
                    type: string
                    description: End-user instruction shown in the capture flow.
                  acceptance_guide:
                    type: string
                  start_url:
                    type: string
                    format: uri
                  return_url:
                    type: string
                    format: uri
                  capture_type:
                    type: string
                    enum:
                      - screenshot
                      - document
                  settings:
                    type: object
                    additionalProperties: true
                    description: >-
                      Template-style settings, for example
                      `show_acceptance_guide`.
                  max_retries:
                    type: integer
                  metadata:
                    type: object
                    nullable: true
                    additionalProperties:
                      type: string
                  expires_at:
                    type: string
                    format: date-time
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  deleted_at:
                    type: string
                    format: date-time
                    nullable: true
                  subject_id:
                    type: string
                  result:
                    type: object
                    nullable: true
                    description: >-
                      Latest processing result for this inquiry, or null if none
                      yet.
                    properties:
                      id:
                        type: string
                      inquiry_id:
                        type: string
                      status:
                        type: string
                        enum:
                          - pending
                          - manual_review
                          - approved
                          - rejected
                          - failed
                      acceptance:
                        type: string
                        enum:
                          - high
                          - medium
                          - low
                          - reject
                        nullable: true
                      acceptance_reason:
                        type: string
                        nullable: true
                      confidence:
                        type: string
                        enum:
                          - high
                          - medium
                          - low
                        nullable: true
                      confidence_reason:
                        type: string
                        nullable: true
                      claims:
                        type: array
                        items:
                          type: object
                          properties:
                            property:
                              type: string
                            value:
                              type: string
                            source_url:
                              type: string
                            evidence_id:
                              type: string
                      error:
                        type: string
                        nullable: true
                      retry_count:
                        type: integer
                      submitted_at:
                        type: string
                        format: date-time
                        nullable: true
                      completed_at:
                        type: string
                        format: date-time
                        nullable: true
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      status_history:
                        type: array
                        description: Append-only log of result status changes.
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            from_status:
                              type: string
                              nullable: true
                            to_status:
                              type: string
                            reason:
                              type: string
                              nullable: true
                            created_at:
                              type: string
                              format: date-time
                            changed_by:
                              type: object
                              nullable: true
                              description: >-
                                Operator who made the change, or null for
                                system-driven updates.
                              properties:
                                name:
                                  type: string
                                email:
                                  type: string
                  sessions:
                    type: array
                    description: >-
                      Capture sessions for this inquiry, ordered by creation
                      time.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        page_visits:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              url:
                                type: string
                              visited_at:
                                type: string
                                format: date-time
                        evidence:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              capture_mode:
                                type: string
                                enum:
                                  - manual
                                  - auto
                              evidence_type:
                                type: string
                                enum:
                                  - screenshot
                                  - document
                              source_url:
                                type: string
                              extracted_fields:
                                type: array
                                items:
                                  type: object
                              created_at:
                                type: string
                                format: date-time
                              file:
                                type: object
                                description: >-
                                  Time-limited signed download URL for the
                                  evidence blob.
                                properties:
                                  url:
                                    type: string
                                    format: uri
                                  expires_at:
                                    type: string
                                    format: date-time
              example:
                id: web_iq_xxxxxxxxxxxxxxxx
                template_id: web_tpl_xxxxxxxxxxxxxxxx
                template_key: web_tpl_key_xxxxxxxxxxxxxxxx
                template_version: 1
                name: Bank Statement
                description: ''
                query: Bank Statement
                fields: []
                user_instruction: ''
                acceptance_guide: >
                  ## High Acceptance


                  ### Official Bank PDF Statement

                  * Log into the bank's online banking portal using a web
                  browser.
                start_url: https://www.example.com
                return_url: https://www.inklink.com
                capture_type: document
                settings:
                  show_acceptance_guide: true
                max_retries: 3
                metadata: null
                expires_at: '2026-04-24T23:37:17.502Z'
                created_at: '2026-04-23T23:37:17.416Z'
                updated_at: '2026-04-23T23:37:17.416Z'
                deleted_at: null
                subject_id: user_123
                result:
                  id: web_res_xxxxxxxxxxxxxxxx
                  inquiry_id: web_iq_xxxxxxxxxxxxxxxx
                  status: pending
                  acceptance: null
                  acceptance_reason: null
                  confidence: null
                  confidence_reason: null
                  claims: []
                  error: null
                  retry_count: 0
                  submitted_at: null
                  completed_at: null
                  created_at: '2026-04-23T23:37:17.416Z'
                  updated_at: '2026-04-23T23:37:17.416Z'
                  status_history: []
                sessions:
                  - id: web_sess_xxxxxxxxxxxxxxxx
                    created_at: '2026-04-23T23:37:21.771Z'
                    page_visits: []
                    evidence: []
        '400':
          description: >-
            Validation error (`VALIDATION_ERROR`) - for example an invalid or
            empty `id` path parameter.
        '404':
          description: >-
            Inquiry not found or not accessible (wrong org, deleted inquiry, or
            invalid id).

````