DPP

Delete DPP passports

Start deleting every DPP passport of the organization matching the filter.

The call returns as soon as the job is accepted; passports disappear as the job progresses. Poll the job referenced by jobId to observe completion.

Unlike publish and certify, deletion does not cascade: only the passports the filter matches are removed, never the batches or items attached to a matched model.

Only draft passports are deleted. A published passport has a public URL and possibly an on-chain anchor, and draft → published is one-way, so it is never removed.

Passports coming from a read-only source are never deleted either. Both cases are reported in skippedCount instead of failing the call.

post/v1/dpp/passports/delete

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/dpp/passports/delete
  • Auth: API key in header X-Api-Key

Query parameters

field'id' | 'createdAt' | 'updatedAt' required
order'asc' | 'desc' required
currentPageinteger

1-based page index.

pageSizeinteger

Number of items per page.

Response

Deletion job accepted

jobIdstring uuid nullable required

Identifier of the background job that carries out the action, or null when the filter matched nothing to process. Passports change state as the job progresses, not when this call returns.

eligibleCountinteger required

Number of passports the job will process (matched passports plus the batches and items cascaded from them). It is what the job starts from, not a count of completed work.

skippedCountinteger required

Number of matched passports the job will leave untouched, because they are published or come from a read-only source. Known before the job starts, so this count is final.

Example response

{
  "jobId": "6f1b9a7e-6c2d-4f3a-9b21-2f5d1c8e4a70",
  "eligibleCount": 42,
  "skippedCount": 3
}

Changes

No recorded changes to this operation across all 1 revision of this API.