Get one of the calling bank's onboarding cases

GET 
/v1/onboarding-cases/:case_id

Returns the onboarding case, its saved configuration and its readiness checklist.

Required scope: connector:onboarding:read. The bank is taken from the bank_memberships claim of your access token. A case that does not exist or belongs to another bank returns 404.

State refresh. When the case has an activation_operation_id, this call first reads that operation and brings the case state up to date (AWAITING_APPROVALS, PROVISIONING, ACTIVE, REJECTED or FAILED). Poll this endpoint to follow the case after submission. The case becomes ACTIVE only after the activation operation succeeds and every identity provisioning job (staff memberships, M2M workloads) has completed; until then it stays PROVISIONING.

Readiness. readiness.ready_for_review is true when all three signing targets and the encryption target are VERIFIED, at least one staff member has the bank-admin label, and readiness.webhook_ready is true. These are exactly the checks POST .../submit-configuration enforces. maker_present, checker_present and readonly_present are informational only.

This response also includes bank_portal_route_code, the code used to build your bank's private Bank Portal login URL.

Request

Responses

200

Onboarding case, configuration and readiness status.

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.