Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-2464170247.4 KB
Onboarding V2

Create Self-Onboarding URL

Generate a 1Money-hosted onboarding URL for customer self-service.

post/v2/accounts/{main_account_id}/businesses/onboarding-sessions

Path parameters

main_account_idstring required

Main account id in the form BZ-XXXX-XXXX.

Headers

Idempotency-Keystring required

Idempotency key identifying the hosted business onboarding draft

Request body

legal_namestring required

Legal name of the business being onboarded. 1–100 characters. Only letters, numbers, spaces, and the characters / - ? : ( ) . , ' + are allowed.

redirect_urlstring nullable

Optional URL where the customer is redirected after completing — or abandoning — the hosted onboarding journey. Must be a valid absolute URL when provided.

Example request

{
  "legal_name": "Acme Corporation",
  "redirect_url": "https://client.example/onboarding/return"
}

Response

Hosted onboarding session link created successfully.

account_idstring
status'DRAFT' | 'PROCESSING' | 'ACTION_REQUIRED' | 'UNDER_REVIEW' | 'APPROVED' | 'REJECTED' required

Onboarding lifecycle status of a business sub-account.

  • DRAFT — sub-account initiated but not yet submitted for review.
  • PROCESSING — submitted and being prepared for review.
  • ACTION_REQUIRED — a Request for Information (RFI) is open and waiting on the partner to respond. See RFI Handling.
  • UNDER_REVIEW — active manual compliance review is in progress or provisioning.
  • APPROVED — terminal status; the sub-account is active and ready to transact.
  • REJECTED — terminal status; the sub-account cannot be activated.
onboarding_urlstring required

1Money-hosted URL that walks the customer through the full business onboarding journey. Share this URL with the customer.

expires_atstring required

Timestamp at which the hosted onboarding URL expires (RFC 3339 format).

Example response

{
  "onboarding_url": "https://app.1money.com/api/hosted/public/onboarding/exchange?grant_token=550e8400-e29b-41d4-a716-446655440000",
  "expires_at": "2026-05-04T12:30:00Z"
}