Get the mandatory onboarding key requirements

GET 
/v1/onboarding-cases/:case_id/key-requirements

Returns the catalogue of keys the bank must provide before it can submit its onboarding configuration. Each requirement id is the key purpose you use when registering a target or requesting key generation:

id	category	Register with
BANK_ADMIN	signing	POST .../signing-targets
CREATE_INTERBANK_TRANSFER_MAKER	signing	POST .../signing-targets
APPROVE_INTERBANK_TRANSFER_CHECKER	signing	POST .../signing-targets
ENCRYPT_TRANSFER_SOURCE_MESSAGE	encryption	POST .../encryption-targets

All four are currently required: true. data.id is the case_id.

attributes.version identifies this version of the catalogue. Send it as requirements_version when you create a key-generation job; if the catalogue has changed since you read it, the job is rejected with 422 and you must read the catalogue again.

Required scope: connector:onboarding:read. The case must belong to the calling bank (otherwise 404). The catalogue is the same for every case state.

Request

Responses

200

Versioned key catalogue for the onboarding case.

401

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.

403

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.

404

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.

503

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.