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:
keyis 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_keyis set forENCRYPT_TRANSFER_SOURCE_MESSAGEonce the key exists: the immutable KMS key ARN. A key-encryption key has no public key.target_idis the signing or encryption target registered on the case for this key, set from theREGISTERINGstep onwards.retryableistrueonly forFAILEDitems;errorexplains 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
- 200
- 401
- 403
- 404
- 503
Job with current allocation progress and any available key material.
The bearer token is missing, malformed, expired, signed by an unknown key, or was not issued by the platform IAM for the Lyriq Connector. Obtain a new token and retry. See the Authentication section.
The token is valid but may not perform this request: it lacks the required scope, has
no bank membership, needs an x-dan-bank-id header to choose between several
memberships, names a bank in x-dan-bank-id it has no membership for, or the caller's
bank is suspended or terminated. A new token with the same configuration fails the same
way. See the Authentication section.
The resource does not exist, or it belongs to another bank. The Lyriq Connector does not distinguish the two cases, so resources of other banks are never disclosed.
The request could not be served right now. Either the network is not fully operational
(OUTBOUND_HALTED or READ_ONLY: mutations are refused while read endpoints keep
working; OPERATIONAL_STATE_UNKNOWN: the state could not be determined), or a platform
dependency is temporarily unavailable. No Retry-After header is sent; retry later with
backoff. When retrying a mutation, reuse the same Idempotency-Key and body.