Skip to main content
POST
Create KYH Tracking Link

Authorizations

Authorization
string
header
required

HTTP Basic Auth. Use your clientId as the username and clientSecret as the password.

Body

application/json
sessionKey
string
required

Your session key for this login or signup. Use the same value when you later call the Customers or Devices API to retrieve signals.

Maximum string length: 255
Example:

"client-session-123"

code
string
required

The code (OTP) to show the human once they open the link. 4 to 12 letters or digits.

Pattern: ^[A-Za-z0-9]{4,12}$
Example:

"482913"

Response

Tracking link created

widgetUrl
string<uri>

Link to send to the human

Example:

"https://identity.sardine.ai/kyh?token=Zk3x9..."

expiresAt
string<date-time>

When the link expires (UTC, ISO 8601)

Example:

"2026-11-09T18:05:00Z"