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 withixr_test_. Keys are scoped and can be rotated from the registrar console. - 02Every mutation takes an
Idempotency-Keyheader; a retried request returns the original response. - 03
PATCH /records/{id}requiresIf-Match: <version>and creates a new record version. - 04Errors are RFC 9457
application/problem+jsondocuments with a stabletype. - 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=103
Endpoints
Records05
| POST | /v1/records | Create a work record and assign an INDEX ID | key |
| GET | /v1/records | List the records held by this registrar (for incremental synchronisation) | key |
| GET | /v1/records/{id} | Retrieve a record, including non-public fields | key |
| PATCH | /v1/records/{id} | Update record fields (creates a new version) | key |
| POST | /v1/imports | Bulk import existing records (migration only; requires the `imports.write` scope) | key |
Assets02
| POST | /v1/records/{id}/assets | Bind file fingerprints | key |
| POST | /v1/records/{id}/assets/{sha256}/retire | Retire a file fingerprint (its history is retained in full) | key |
Attestations03
| POST | /v1/records/{id}/verifications | Submit a verification decision and issue a verification credential (advances to VERIFIED) | key |
| POST | /v1/records/{id}/clearances | Submit a rights clearance decision (Rights Clearance Schedule) | key |
| POST | /v1/records/{id}/honours | Register a festival honour (issued by the festival; INDEX links it to the record and provides the verification strip) | key |
Documents02
| GET | /v1/records/{id}/documents | List all certificates and schedules for the record, including superseded versions | key |
| POST | /v1/records/{id}/documents | Issue or reissue the Certificate of Registration and certificate pack | key |
Status03
| POST | /v1/records/{id}/status | Mark a dispute, resolve a dispute, or revoke a record | key |
| POST | /v1/records/{id}/transfer-code | Generate a transfer code for the rights holder (used when changing registrar) | key |
| POST | /v1/transfers | Take over a record as the new registrar using a transfer code | key |
Registrar03
| GET | /v1/registrar | Profile, accredited scopes and key status of this registrar | key |
| GET | /v1/registrar/usage | Billing events (monthly reconciliation) | key |
| PUT | /v1/registrar/webhooks | Set the webhook endpoint | key |
Public08
| GET | /v1/public/records/{id} | Public record (JSON-LD) | public |
| GET | /v1/public/records/{id}/versions/{version} | Public record at a specific version | public |
| GET | /v1/public/search | Search VERIFIED and CLEARED works (agent discovery) | public |
| GET | /v1/public/lookup | Look up works by file fingerprint | public |
| GET | /v1/public/verify/{id} | Scan-to-verify: confirms whether a given certificate version is currently valid | public |
| 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/registrars | Directory of accredited registrars | public |