Skip to content

Update Business Onboarding API docs to match implementation - #1385

Merged
alexBinns merged 8 commits into
masterfrom
update-onboarding-api-docs
Sep 9, 2026
Merged

alexBinns merged 8 commits into
masterfrom
update-onboarding-api-docs

Conversation

@alexBinns

@alexBinns alexBinns commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Summary

  • The Business Onboarding API docs had drifted from kari's createOnboardingRequest.route.js: documents new request fields (sendInvitation, merchant.redirectUrls, merchant.searchHidden), corrects settlementAccountNumber/externalMerchantId from required to optional, notes deviceId is only required when vendor isn't nomad, and adds the LIVENESS_MISMATCH error code.
  • Adds a second worked example (e-commerce merchant with a Shopify sales channel) alongside the existing physical merchant example, since e-commerce merchants use redirectUrls instead of location.

Manual test steps

  1. Run the docs site locally and navigate to the Business Onboarding API page.
  2. Confirm the "Create an Onboarding Request" section renders the request/response panel for the physical merchant example, followed immediately by an "E-commerce Example" subsection with its own request/response panel — both under one nav entry in "On this page".
  3. Confirm the Onboarding Request Model, Merchant Model, Asset Program Model, and Sales Channel Model property tables render without markup errors.
  4. Confirm the new LIVENESS_MISMATCH error response renders correctly in the Error Responses list.

🤖 Generated with Claude Code

Documents fields and behavior added to createOnboardingRequest.route.js that had
drifted from the published docs: sendInvitation, stakeholders, merchant
redirectUrls/searchHidden, optional settlementAccountNumber/externalMerchantId,
the new billingConfig/rates model, conditional deviceId requirement, and the
LIVENESS_MISMATCH/BILLING_CONFIG_NOT_ALLOWED error codes. Also adds an
e-commerce onboarding example alongside the existing physical merchant one.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@alexBinns
alexBinns force-pushed the update-onboarding-api-docs branch from 38b97ff to 58e64b1 Compare September 9, 2026 01:00
Drop the billingConfig field, Billing Config Model, Rate Model, and
BILLING_CONFIG_NOT_ALLOWED error added in the previous commit.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Comment thread src/content/api/onboarding.mdoc Outdated
Comment thread src/content/api/onboarding.mdoc Outdated
alexBinns and others added 6 commits September 9, 2026 14:21
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The snapshot was stale because it was generated against a dist build
that predated the billing config removal.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@alexBinns
alexBinns merged commit 7bcd3c8 into master Sep 9, 2026
9 checks passed
@alexBinns
alexBinns deleted the update-onboarding-api-docs branch September 9, 2026 03:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants