Skip to main content
InkLink also provides a guided flow solution that allows you to create a data verification flow with predefined steps.

​
Overview

To create a guided flow, add the steps array to the request body 
curl "https://hub.inklink.com/api/v1/envelope" \
  --header "x-api-key: $secret_test_xxx" \
  --header "Content-Type: application/json" \
  --data \
  '{
    name": "LinkedIn Account Information",
    "query": "Capture all information about the user's experience, skills, education, account information on LinkedIn",
    "redirect_url": "https://www.linkedin.com/login",
    "return_url": "https://your-app.com/capture-complete?your-ref-id=xxx",
    "steps": [
      ...
    ]
  }'

​
Steps

The steps array contains the steps of the guided flow. Each step is an object with the following properties:
ValueDescription
user_instructionThe instruction given to the user at this step
capture_onThe url that allows the user to capture the data
auto_redirectWhether to automatically redirect the user to capture_on url
ai_instructionThe additional instructions given to the AI at this step
full_screenWhether to capture the entire page or just the visible area
fieldsThe fields to capture at this step

​
capture_on

The capture_on property defines the URL where data capture occurs. Use variables in the format :variable_name to dynamically extract values from the user’s current URL. Example
  • capture_on https://www.linkedin.com/in/:userId/overlay/about-this-profile/
  • user is on https://www.linkedin.com/in/1234567890/overlay/about-this-profile/
  • extracted value :userId = 1234567890
This is especially useful when auto_redirect is set to true, the system automatically uses extracted variables to construct redirect URLs. Example If you specify a redirect URL with :userId and the system has already extracted userId as 1234567890, navigating to https://www.linkedin.com/in/:userId/details/experience/ will redirect to https://www.linkedin.com/in/1234567890/details/experience/.

​
Sample Steps

Following is a sample steps for a guided flow that captures the user’s LinkedIn account information.
json
 "steps": [
    {
      "user_instruction": "Click on the capture button after you login",
      "capture_on": "https://www.linkedin.com/feed/",
      "auto_redirect": false,
      "ai_instruction": null,
      "full_screen": false,
      "fields": [
        {
          "name": "user_full_name",
          "required": true,
          "description": "The LinkedIn user full name"
        }
      ]
    },
    {
      "user_instruction": "Click on your name and capture the info",
      "capture_on": "https://www.linkedin.com/in/:userId/overlay/about-this-profile/",
      "auto_redirect": false,
      "ai_instruction": null,
      "full_screen": false,
      "fields": [
        {
          "name": "joined_date",
          "required": true,
          "description": "The joined date"
        }
      ]
    },
    {
      "user_instruction": "Capture your experience",
      "capture_on": "https://www.linkedin.com/in/:userId/details/experience/",
      "auto_redirect": true,
      "full_screen": true,
      "ai_instruction": "Capture all the companies that this user have worked for, along with the start date, end date, description of every role"
    },
    {
      "user_instruction": "Capture your education",
      "capture_on": "https://www.linkedin.com/in/:userId/details/education/",
      "auto_redirect": true,
      "full_screen": true,
      "ai_instruction": "Capture all the schools that this user have attended, along with the start date, end date, description of every degree"
    },
    {
      "user_instruction": "Capture your skills",
      "capture_on": "https://www.linkedin.com/in/:userId/details/skills/",
      "auto_redirect": true,
      "full_screen": true,
      "ai_instruction": "Capture all the skills that this user have"
    }
  ]