Skip to main content

​
1. Create a Trust Envelope™

Here is the minimal request body to create a Trust Envelope™. You can find all the available fields in the API Reference.

​
Request

FieldDescription
queryDefine the data you need to verify
return_urlThe URL that the user will be redirected to after they complete the process. You can use this to redirect the user to a thank you page or to your app
 
curl https://hub.inklink.com/api/v1/envelope \
    --header "x-api-key: $secret_xxx" \
    --header "content-type: application/json" \
    --data \
'{
    "name": "Dugong Awareness",
    "query": "User is aware of Dugong, a marine mammal"
    "return_url": "https://your-app.com/capture-complete?your-ref-id=xxx"
}'

​
Response

The response contains the envelope_url which users can use to complete the data verification process.
JSON
{
  "id": "iq_xxx",
  ... // other fields
  "envelope_url": "https://hub.inklink.com/capture/iq_xxx"
}

​
2. Retrieve Envelope Results

​
Request

FieldDescription
iq_xxxThe ID of the envelope
 
curl https://hub.inklink.com/api/v1/result/iq_xxx \
    --header "x-api-key: $secret_xxx"

​
Response

Please refer to the API Reference for the response schema.