Skip to main content
GET
/
v1
/
consumer
/
similarity
Get similarity score
curl --request GET \
  --url https://api.truthlocks.com/v1/consumer/similarity \
  --header 'X-API-Key: <api-key>'
{
  "scores": [
    {
      "attestation_id": "<string>",
      "similarity": 123,
      "match_type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt

Use this file to discover all available pages before exploring further.

GET/v1/consumer/similarity
Check whether a SHA-256 content hash already has public protections. Use this before protecting content to detect exact duplicates and avoid re-protecting content that someone else has already registered. Authentication is optional. When you include an API key, your own protections are excluded from the results so you only see matches from other users. Only protections with visibility: "public" are searched. Private protections are never returned.

​
Parameters

​
hash
string
required
SHA-256 hash of the content to check. Must match the hex-encoded hash format used when protecting content.

​
Responses

​
Response fields

FieldTypeDescription
content_hashstringThe hash you submitted, echoed back for confirmation.
exact_matchbooleantrue if at least one public protection exists for this hash.
matchesarrayUp to 10 matching protections, ordered by creation date.
matches[].attestation_idstringAttestation ID of the matching protection.
matches[].titlestringTitle of the matching protection.
matches[].categorystringContent category (e.g. photography, code, design).
matches[].similarity_scorenumberAlways 1.0 for exact hash matches.
matches[].protected_atstringISO 8601 timestamp when the content was protected.
matches[].owner_usernamestringPublic username of the protection owner, if set.
totalintegerTotal number of matches found.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Response

Similarity scores

​
scores
object[]