DPP

Certify DPP passports

Start certifying the DPP passports matching the filter, cascading certification to their batches and items.

The call returns as soon as the job is accepted; certification happens afterwards. Poll the passports, or the job referenced by jobId, to observe completion.

post/v1/dpp/passports/certify

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/dpp/passports/certify
  • 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

Certification 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.

Example response

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

Changes

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