Skip to main content
GET
/
web
/
inquiry
/
{id}
Get Web inquiry
curl --request GET \
  --url https://platform.inklink.com/api/v1/web/inquiry/{id} \
  --header 'api-key: <api-key>'
{
  "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\n\n### Official Bank PDF Statement\n* Log into the bank's online banking portal using a web browser.\n",
  "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": []
    }
  ]
}

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.

Headers

api-key
string
required
Example:

"secret_live_xxx"

Path Parameters

id
string
required

Web inquiry id (web_iq_...).

Example:

"web_iq_xxx"

Response

Inquiry found.

id
string

Web inquiry id (web_iq_...).

template_id
string | null
template_key
string | null
template_version
integer
name
string
description
string
query
string
fields
object[]
user_instruction
string

End-user instruction shown in the capture flow.

acceptance_guide
string
start_url
string<uri>
return_url
string<uri>
capture_type
enum<string>
Available options:
screenshot,
document
settings
object

Template-style settings, for example show_acceptance_guide.

max_retries
integer
metadata
object
expires_at
string<date-time>
created_at
string<date-time>
updated_at
string<date-time>
deleted_at
string<date-time> | null
subject_id
string
result
object

Latest processing result for this inquiry, or null if none yet.

sessions
object[]

Capture sessions for this inquiry, ordered by creation time.