Deferred-match lookup

Deferred-match lookup (first app open after an install).

THE CALL, PART BY PART

method

POST

host

strait.link

version

/v1

resource

/match

POST /v1/match

Auth: publishable key as publishableKey in the JSON body. Safe in apps and websites.

Request

Called once by the SDKs on the first launch after an install, to find the tap that led to it. On iPhone it compares coarse device signals (screen, language, time zone, network) with recent taps of this workspace and answers only when exactly one tap fits; ambiguous cases are refused, never guessed. Android uses POST /v1/referrer (Play Install Referrer) instead. Rate limited per IP.

Body (JSON)

publishableKey required string
platform required string
screenWidth required number
pixelRatio required number
language required string
timezone required string
appVersion string
The app's own version (iOS CFBundleShortVersionString, Android versionName), kept on the open. 1-64 printable ASCII characters; anything else is ignored, never an error.
sdkVersion string
The Strait SDK version, kept on the open. Same rule as appVersion.
installReferrer string
Android: the raw Google Play install referrer string (InstallReferrerClient). Only its utm_source / utm_medium / utm_campaign / utm_term / utm_content are kept on the install (each decoded, trimmed, at most 100 characters); everything else (gclid, strait_link…) is dropped, never stored. Over 4096 characters or not a string: ignored, never an error. Listed in GET /v1/export?part=installs.
record boolean
false = a read only (SDK checkDeferred): answer the match, record no install, open or webhook. Omit for the real first-launch check. While the workspace's test window is open (Dashboard -> Setup -> Test a link, 15 minutes), a read only gets the newest tap since the window opened, once (matchMethod test, test:true).

Response

  • 200 Match result
  • 400 platform and the device fields are required
  • 401 Missing or invalid publishable key
  • 429 Rate limited
Request · curl
curl -X POST https://strait.link/v1/match \
  -H "Content-Type: application/json" \
  -d '{
    "publishableKey": "st_pub_live_…",
    "platform": "ios",
    "screenWidth": 393,
    "pixelRatio": 3,
    "language": "en-IN",
    "timezone": "Asia/Kolkata"
  }'

The response, printed

Response 200
{
  "matched": true,
  "longUrl": "https://shop.example.com/sale/summer?utm_source=whatsapp&utm_campaign=summer-2026",
  "linkId": "lnk_5f0c2a8e-3b1d-4f6a-9c7e-2d8b1a0e4f63",
  "matchMethod": "exact_ext",
  "confidence": null,
  "clickId": "9a1c7e52-4b3d-4f8e-a6d1-0c2b5e7f9a34",
  "reasons": [
    "exact_ext"
  ],
  "match": {
    "method": "fingerprint",
    "confidence": "probable"
  }
}