Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your secret key, rk_test_… or rk_live_…, sent as Authorization: Bearer <key>. Keep it on your server. Restricted keys carry only the scopes you give them.

Headers

Reflections-Version
string

The dated API version. Defaults to the version your account is pinned to.

Example:

"2026-10-15"

Reflections-Account
string

Act for a connected licensee. The value is the licensee's account ID. Requires an active connection between that account and yours.

Pattern: ^acct_[0-9a-hjkmnp-tv-z]{26}$

Path Parameters

license_id
string
required

The license's ID.

Pattern: ^lic_[0-9a-hjkmnp-tv-z]{26}$
revision_id
string
required

The revision's ID, such as the license's current_revision or pending_revision.

Pattern: ^lrv_[0-9a-hjkmnp-tv-z]{26}$

Response

The revision.

id
string
required

Unique identifier for the revision, lrv_….

Pattern: ^lrv_[0-9a-hjkmnp-tv-z]{26}$
object
string
required

Always license_revision.

Allowed value: "license_revision"
livemode
boolean
required

true for a live-mode revision, false for a test-mode one.

license
string
required

The license the revision belongs to.

Pattern: ^lic_[0-9a-hjkmnp-tv-z]{26}$
number
integer
required

The revision's position in its license, from 1 for the revision signed with the license.

Required range: x >= 1
status
enum<string>
required

Where the revision stands. New checks are decided under the current revision only.

Available options:
pending_acceptance,
current,
superseded,
declined
source_kind
enum<string>
required

What produced the revision. issue: signed with the license. change_request: a change the licensee asked for. amend: an amendment from the talent's side. renew: a renewal, such as a new window.

Available options:
issue,
change_request,
amend,
renew
terms
object
required

The signed document, exactly as signed, with its own camelCase field names. Its canonical form digests to terms_digest.

terms_digest
string
required

sha256: and the hex SHA-256 of terms in tlp-json-1 canonical form. Recompute it to confirm you hold the signed document.

Pattern: ^sha256:[0-9a-f]{64}$
canonicalization
string
required

The canonical JSON form the digest is computed over: UTF-8, object keys sorted by code point, no insignificant whitespace. Defined in the Standard under Tokens, canonical form.

Allowed value: "tlp-json-1"
scope
object
required

terms in normalized, snake_case form, for your code to read. Hash terms, never scope.

enforcement
object[]
required

Each term with its class: checked terms are enforced at the stages listed, recorded terms are signed and shown only.

signatures
object[]
required

The talent's side signs first. The licensee's signature is added when it accepts.

created_at
string<date-time>
required

When the talent's side signed the revision.

document_url
string<uri>

The signed document as a person reads it.