Skip to main content

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.

​
Prerequisites

  • Server-side API key from the InkLink dashboard (secret_live_xxx).
  • Send the api-key header on every request (never from a public client).
  • A published Web inquiry template and its template_key, or pass the full inquiry config inline. You can create and publish templates in the dashboard or with the Template API (POST /web/template, then POST /web/template/{key}/publish when needed).

​
1. Create an inquiry

The simplest path is to use a template you have already configured in the dashboard. Only subject_id and template_key are required; the inquiry inherits the rest of its configuration from the template. You can still pass additional fields in the request to override it. 
curl -X POST "https://platform.inklink.com/api/v1/web/inquiry" \
  --header "api-key: $INKLINK_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "subject_id": "user_123",
    "template_key": "linkedin_profile"
  }'
Save the id from the response (e.g. web_iq_…).
Without template_key, you must pass the full inquiry configuration inline (name, query, fields, start_url, and so on). See the API reference for the full payload.

​
2. Send the user to hosted capture

Redirect or deep-link: https://platform.inklink.com/capture/<id> <id> is the same id from the create response (e.g. web_iq_…). It appears in the path for InkLink-hosted capture; inquiry_id is only the query parameter name when you land on your return URL (see below). The hosted app walks the user through the capture flow and sends the browser back to the return URL configured on the inquiry.

​
3. Read status on your return URL

When the flow finishes, the capture app redirects to your configured return URL with two query parameters added:
ParameterDescription
statuspending, processing, approved, rejected, or failed
inquiry_idThe same inquiry id from the create response (e.g. web_iq_…)
Example: https://your-app.com/web/complete?status=approved&inquiry_id=web_iq_xxx Use that landing route to decide what to show next.

​
Optional: full inquiry JSON

If you need more than status, such as scores, extracted claims, capture sessions, or timestamps, call Get Web inquiry from your server: GET https://platform.inklink.com/api/v1/web/inquiry/<inquiry_id> 
curl "https://platform.inklink.com/api/v1/web/inquiry/web_iq_xxx" \
  --header "api-key: $INKLINK_API_KEY"
The response includes the inquiry configuration, a nested result (with status, acceptance, confidence, claims, and status_history), and sessions with page visits and time-limited signed evidence URLs. See Error handling and the Get Web inquiry reference.

​
Optional: list inquiries

To page through inquiries from your server, call List Web inquiries with limit (default 25, max 100) and optional after_id - use the previous response’s last_id as after_id when has_more is true. 
curl "https://platform.inklink.com/api/v1/web/inquiry?limit=10" \
  --header "api-key: $INKLINK_API_KEY"
See the List Web inquiries reference.