Liccium Developer Portal
Redaction & Deletion API

redaction

Endpoint:https://b2c-api-main-737c477.zuplo.app

Redact and un-redact declarations (declarer keys)

Redact or un-redact declarations

POST
https://b2c-api-main-737c477.zuplo.app
/v1/redact

Redaction removes the declaration from ISCC similarity search while it keeps existing: its CID still resolves (header x-declaration-status: redacted), it stays in the provenance chain and later declarations may still supersede it. In the federated registry the CID keeps its place while its value is replaced by a marker. isRedacted: false reverses it.

Two forms:

  • {"cid": "...", "isRedacted": true} is synchronous and answers with the resulting state.
  • {"cids": [...], "isRedacted": true} accepts up to 500 CIDs, answers 202 with a jobId, and GET /v1/redact/jobs/{jobId} returns the per-CID results.

The key must be bound to the declarer of the declarations. Idempotent: changed: false when the state already matched.

Redact or un-redact declarations › Request Body

  • isRedactedboolean · required

    true redacts, false un-redacts

  • cidstring

    One declaration id (cidV1, lowercase base32). Mutually exclusive with cids.

  • cidsstring[] · minItems: 1 · maxItems: 500

    Up to 500 declaration ids for an asynchronous batch (202).

  • reasonstring · maxLength: 500

Redact or un-redact declarations › Responses

Single CID: state after the call

  • cidstring
  • okboolean
  • changedboolean

    false when the declaration already was in the requested state

  • isRedactedboolean
  • everRedactedboolean

    true once the CID has been redacted at least once; it stays in the index afterwards

  • versioninteger
  • pageinteger

    Page of the redaction index holding the entry

  • declarerIdstring
  • effectsobject

    What each downstream store reported

Batch redaction job status

GET
https://b2c-api-main-737c477.zuplo.app
/v1/redact/jobs/{jobId}

Progress and per-CID results of a batch created by POST /v1/redact with cids. status moves from queued through running to done (or failed). Each result carries ok, changed and, on failure, status and error (not_found, forbidden, deleted). A declarer key only sees its own jobs.

Batch redaction job status › path Parameters

  • jobIdstring · uuid · required

Batch redaction job status › Responses

The job

  • jobIdstring · uuid
  • typestring · enum
    Enum values:
    redact
    unredact
  • statusstring · enum
    Enum values:
    queued
    running
    done
    failed
  • totalinteger
  • processedinteger
  • succeededinteger
  • unchangedinteger
  • failedinteger
  • resultsobject[]
  • declarerIdstring
  • createdAtinteger

    Unix time in milliseconds

  • startedAtinteger
  • finishedAtinteger
deletion