Web inquiries capture and verify information from any website in a secure capture flow that protects the integrity of the evidence you collect.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.
For most integrations, the flow is simple: publish a template or pass config inline, create the inquiry on your backend, send the user to the hosted capture app, then read
status and inquiry_id on your configured return URL.Integration flow
Create a template (dashboard or API)
In the InkLink dashboard, create a template that defines your inquiry settings, including the query, fields, and return URLs. Save it and copy the
template_key so each inquiry can inherit that configuration. Alternatively, create and publish templates with the Template API–see Inquiry templates for the full lifecycle and endpoint list.Create an inquiry
Call
POST https://platform.inklink.com/api/v1/web/inquiry from your backend with your org api-key. Send subject_id (your stable user key) and template_key from your template so the inquiry uses that configuration. If you skip a template, you can pass the full inquiry config inline instead (name, query, fields, return_url, start_url, and more). See Quickstart and the API reference for the full payload.Hosted capture
Open the user’s browser to:
https://platform.inklink.com/capture/<id>Put the id from the create response (e.g. web_iq_…) as the last path segment. When the flow completes, your return_url receives that same value as the inquiry_id query parameter. The capture app guides the user through the target site and collects evidence.Read the outcome on your return URL
When the hosted flow finishes, the user is redirected to your configured return URL (from the template or your create request) with
status and inquiry_id as query parameters.For most integrations, those query parameters are enough. List Web inquiries (
GET /api/v1/web/inquiry) returns a paginated list with a nested result for each row - useful for dashboards or sync - see the API reference. Call Get Web inquiry (GET /web/inquiry/{id}) when you need the full payload for one inquiry, such as status_history, sessions, or signed evidence URLs.Return URL and Get Web inquiry
Capture types
| Type | What it captures |
|---|---|
screenshot | Viewport screenshot of the target page |
document | Document files downloaded from a website (for example PDF and other supported formats), sent to InkLink for analysis |
Result statuses
Result statuses
| Status | Meaning |
|---|---|
pending | Result created, not yet processed |
approved | Claims verified and accepted |
rejected | Claims did not pass acceptance criteria |
failed | Processing encountered an error |
Result scores and extra fields
Result scores and extra fields
Each completed result includes two scores:
Both scores include a human-readable reason field. The nested
| Score | Values | Purpose |
|---|---|---|
| Acceptance | high, medium, low, reject | How well the captured evidence satisfies the inquiry criteria |
| Confidence | high, medium, low | How reliable the evidence source and extraction are |
result on GET https://platform.inklink.com/api/v1/web/inquiry/<inquiry_id> can also include extracted claims, status_history, timestamps, and other metadata; the same response includes sessions and signed evidence URLs when you need the full picture.Next steps
Quickstart
Create an inquiry, send users to hosted capture, and handle the return URL.
API reference
Review the create inquiry request and response schema.
Error handling
Check common API and integration errors before going live.