API template library

U.S. Bank Corporate Onboarding mock API and live sandbox

A WireMock simulation of U.S. Bank's REST API — covering KYC document intake, participant invitations, virtual account opening, status polling, and closure.

Vendor
U.S. Bank
Functionality
KYC and account opening
Spec version
2.3.0
Endpoints
6
Stubs
7
Protocol
REST
Validation
AI-validated Before publication, an AI agent exercised these endpoints against the real U.S. Bank API through WireMock's recording proxy, and the recorded traffic was used to verify each stub's request and response shapes.

Live sandbox · no signup, no API key

US Bank Corporate Onboarding

A running WireMock Cloud instance of this template, callable right now from a terminal, a script, or an AI agent.

Base URL
https://7md83.wiremockapi.cloud

POST Run KYC (create virtual account onboarding)

curl -s -X POST 'https://7md83.wiremockapi.cloud/virtual-accounts' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST Close virtual account

curl -s -X POST 'https://7md83.wiremockapi.cloud/close-account' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST Create non-FBO virtual account

curl -s -X POST 'https://7md83.wiremockapi.cloud/non-fbo-virtual-accounts' \
  -H 'Content-Type: application/json' \
  -d '{}'
Method Path Summary
POST /close-account Close virtual accounts.
POST /document-upload Submit document to run KYC.
POST /invite-intake Submit Onboarding data to initiate an email invite to your participant.
POST /non-fbo-virtual-accounts To open virtual accounts without KYC.
POST /virtual-accounts Submit Onboarding data to open virtual accounts.
GET /virtual-accounts/{onboardingID} Retrieve Virtual account details by passing onboardingID.

Unauthenticated WireMock Cloud demo sandbox for U.S. Bank — not an official U.S. Bank sandbox, and it returns simulated example data only.

What's inside the Corporate Onboarding template

The template models the paperwork mile between "we'd like an account" and an account number: KYC-gated virtual account opening for FBO programs, a lighter no-KYC route, email invitations that let the participant finish the forms themselves, and document intake for the identity evidence. Its intake registry is real — each onboarding submission is acknowledged with a 202 and a freshly minted eight-digit onboardingID, and the status route resolves precisely the ids this sandbox has issued while any other number draws the resource-not-found error. What the poll returns is the canonical outcome: virtual account 8856274 on routing 122105155, the same account the no-KYC route opens instantly and the closure route hands back as deletedAccountDetails, so the whole lifecycle orbits one fixture account.

  • KYC intake — onboarding submission with minted ids, plus document upload for identity evidence
  • Self-service path — invite-intake, which emails the participant a link to complete onboarding
  • Instant path — non-FBO virtual account opening with immediate account details
  • Lifecycle — status polling by onboardingID and virtual account closure

Frequently asked questions

Only if the sandbox still remembers it — minted onboardingIDs live in a shared store that resets periodically, so poll soon after you submit and treat old ids as expendable. The submit-then-poll chain itself is faithful: the id in your 202 is the id the status route honors, the async idiom U.S. Bank also uses for corporate card account setup.

As two different data types. The enum is the state machine — started, not completed — while onboardingStatusPercentage is a display string, quotes and percent sign included, that progress bars render but business logic should never branch on. The fixture pairing the two at their most contradictory is a standing test that your code trusts the machine-readable field.

No — any JSON with document content is acknowledged with the fixture documentID and a received status. That verifies the submission contract and the id your client must persist for later reference; rejection paths like unreadable scans or unsupported document types are yours to stub in a private WireMock Cloud copy, where a 4xx variant per failure mode is quick to add.

The gate. The FBO path answers 202 and makes you poll because KYC review sits between request and account; the non-FBO path skips the review and returns account details in the create response itself. Both ultimately surface the same fixture account, which makes the sandbox a clean place to verify your client handles a deferred and an immediate provisioning flow through one codebase.

Vendor names identify APIs represented by WireMock template sources. This page does not imply vendor endorsement, certification, partnership, or official integration status.