INDEX.FILM · Developers

INDEX Registry API v1

One open API contract for every accredited registrar, and a free public verification API for everyone.

01

Authentication and safety

  • 01Registrar endpoints take Authorization: Bearer ixr_live_…; sandbox keys start with ixr_test_. Keys are scoped and can be rotated from the registrar console.
  • 02Every mutation takes an Idempotency-Key header; a retried request returns the original response.
  • 03PATCH /records/{id} requires If-Match: <version> and creates a new record version.
  • 04Errors are RFC 9457 application/problem+json documents with a stable type.
  • 05Webhooks carry Index-Signature: t=…,v1=HMAC-SHA256(secret, t + "." + body).
02

Quick start

curl -X POST https://api.index.film/v1/records \
  -H "Authorization: Bearer $INDEX_KEY" -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"workType":"film","formType":"short",
       "title":{"original":"The Glass Orchard","originalLanguage":"en"},
       "productionYear":2026,"durationSeconds":1122,"originalLanguages":["en"],
       "rightsHolder":{"name":"Halden Grove Pictures Ltd"},
       "registrantRef":"acct_8f2c",
       "aiDisclosure":{"summary":"Generated imagery, synthetic performers and voices."}}'

curl -X POST https://api.index.film/v1/records/7K3P9Q2M4X/assets \
  -H "Authorization: Bearer $INDEX_KEY" -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"assets":[{"role":"master","sha256":"<64 hex>","byteSize":48210445312,"mediaType":"application/mxf"}]}'

curl -X POST https://api.index.film/v1/records/7K3P9Q2M4X/documents \
  -H "Authorization: Bearer $INDEX_KEY" -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" -d '{"languages":["en","fr"]}'

curl https://api.index.film/v1/public/verify/7K3P9Q2M4X?v=1
03

Endpoints

Records05
POST/v1/recordsCreate a work record and assign an INDEX IDkey
GET/v1/recordsList the records held by this registrar (for incremental synchronisation)key
GET/v1/records/{id}Retrieve a record, including non-public fieldskey
PATCH/v1/records/{id}Update record fields (creates a new version)key
POST/v1/importsBulk import existing records (migration only; requires the `imports.write` scope)key
Assets02
POST/v1/records/{id}/assetsBind file fingerprintskey
POST/v1/records/{id}/assets/{sha256}/retireRetire a file fingerprint (its history is retained in full)key
Attestations03
POST/v1/records/{id}/verificationsSubmit a verification decision and issue a verification credential (advances to VERIFIED)key
POST/v1/records/{id}/clearancesSubmit a rights clearance decision (Rights Clearance Schedule)key
POST/v1/records/{id}/honoursRegister a festival honour (issued by the festival; INDEX links it to the record and provides the verification strip)key
Documents02
GET/v1/records/{id}/documentsList all certificates and schedules for the record, including superseded versionskey
POST/v1/records/{id}/documentsIssue or reissue the Certificate of Registration and certificate packkey
Status03
POST/v1/records/{id}/statusMark a dispute, resolve a dispute, or revoke a recordkey
POST/v1/records/{id}/transfer-codeGenerate a transfer code for the rights holder (used when changing registrar)key
POST/v1/transfersTake over a record as the new registrar using a transfer codekey
Registrar03
GET/v1/registrarProfile, accredited scopes and key status of this registrarkey
GET/v1/registrar/usageBilling events (monthly reconciliation)key
PUT/v1/registrar/webhooksSet the webhook endpointkey
Public08
GET/v1/public/records/{id}Public record (JSON-LD)public
GET/v1/public/records/{id}/versions/{version}Public record at a specific versionpublic
GET/v1/public/searchSearch VERIFIED and CLEARED works (agent discovery)public
GET/v1/public/lookupLook up works by file fingerprintpublic
GET/v1/public/verify/{id}Scan-to-verify: confirms whether a given certificate version is currently validpublic
GET/v1/public/credentials/{credentialId}Retrieve a signed credential (W3C VC 2.0)public
GET/v1/public/status-lists/{listId}Revocation and suspension status list (BitstringStatusListCredential)public
GET/v1/public/registrarsDirectory of accredited registrarspublic
Candidatures

Rejoignez le réseau mondial du registre.

Developers · INDEX.FILM