Submit the bank's onboarding configuration for operator review

POST 
/v1/onboarding-cases/:case_id/submit-configuration

Declares the bank's part of onboarding complete and moves the case to READY_FOR_REVIEW. No request body is sent.

Required scope: connector:onboarding:submit-configuration.

Allowed states: AWAITING_BANK_ADMIN, BANK_CONFIGURING or NEEDS_CHANGES. In any other state the call returns 409 STATE_CONFLICT.

Checks (in this order); the first that fails returns 422 VALIDATION_ERROR:

1. A signing target is VERIFIED for each of BANK_ADMIN, CREATE_INTERBANK_TRANSFER_MAKER and APPROVE_INTERBANK_TRANSFER_CHECKER (detail: verified bank-admin, maker, and checker signing targets are required).
2. The ENCRYPT_TRANSFER_SOURCE_MESSAGE encryption target is VERIFIED (detail: transfer source message encryption target is required).
3. At least one staff member has the bank-admin role label (detail: an initial bank-admin staff member is required). Staff with maker, checker or readonly labels are optional.
4. Webhook setup is enabled, includes the beneficiary.screening.requested event type, has a signing secret and, when receiver authentication is configured, a client secret (detail: webhook setup is incomplete).

M2M workloads are optional and are not checked here. readiness.ready_for_review on the case tells you in advance whether these checks will pass.

Effect: the case moves to READY_FOR_REVIEW and its version increases. From now on all bank edits (targets, staff, webhook setup, M2M workloads, key generation) are rejected with 409. Submitting does not accept the package, activate the bank or provision any identity: the platform operator reviews and accepts the case, which starts the activation operation (see activation_operation_id on the case).

Retries: calling submit again on a case already in READY_FOR_REVIEW returns 409; the first submission stands.

The response contains the updated case without the readiness and bank_portal_route_code attributes; read the case to get them.

Request

Responses

200

The case is now READY_FOR_REVIEW.

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.

409

The case is not in an editable state (for example it was already submitted).

422

A readiness check failed. detail names the missing artifact.

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.