Skip to main content
POST
Request partner onboarding for a party
Requires scope: manage:parties — see Required scopes. Starts onboarding the party to our banking partner as soon as it is verified, instead of letting the first virtual-bank-account or payout-route attempt trigger it and fail with partner-onboarding-pending. Returns 202 with the current status; poll Get a party’s partner-onboarding status for the outcome. The 202 body has the same shape as the read, including requiredActions, and is also sent with Cache-Control: no-store. Idempotent while onboarding is PENDING or APPROVED. A REJECTED party is not a dead end — calling again re-attempts onboarding. See Partner onboarding.

Errors

Authorizations

Headers

x-tenant-id
string<uuid>

Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.

Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones you may use. Send the header once: a repeated header is rejected the same way.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Path Parameters

partyId
string<uuid>
required

Unique party identifier

Response

Onboarding requested; the body carries the current partner-onboarding status

success
boolean

Indicates whether the request was successful

result
object

A party's partner-onboarding status, and any steps the partner is still waiting on the end customer for. Reading it never triggers a provisioning attempt.