Skip to main content

Get the progress of a key-generation job

GET 

/v1/onboarding-cases/:case_id/key-generation-jobs/:job_id

Returns the job with the current state of each key allocation. Poll this endpoint after POST .../key-generation-jobs until every item has reached READY, FAILED or CONFLICT (see the create operation for the full allocation lifecycle).

Per item:

  • key is set for signing purposes once the public material is available: provider reference, algorithm, base64 SPKI DER public key and its SHA-256 fingerprint (hexadecimal).
  • encryption_key is set for ENCRYPT_TRANSFER_SOURCE_MESSAGE once the key exists: the immutable KMS key ARN. A key-encryption key has no public key.
  • target_id is the signing or encryption target registered on the case for this key, set from the REGISTERING step onwards.
  • retryable is true only for FAILED items; error explains the failure.

Required scope: connector:onboarding:read. A case or job that does not exist or belongs to another bank returns 404. If the platform key service is unavailable the call returns 503.

Request​

Responses​

Job with current allocation progress and any available key material.