Skip to main content
GET
Get a party's partner-onboarding status
Requires scope: manage:parties — see Required scopes. Returns whether the party has been passed on to our banking partner and where its onboarding with that partner stands — the third readable onboarding gate next to identity verification and partner-terms consent. Read it before provisioning: PENDING here is exactly what creating a virtual bank account would refuse with 409 partner-onboarding-pending. NOT_STARTED is a normal 200. See Partner onboarding. While status is PENDING, requiredActions lists any step the partner is waiting on the end customer for, each with a url to the partner’s hosted flow. An empty array means there is nothing for the customer to do right now. The list is resolved live on every call and the response carries Cache-Control: no-store, so always use the latest url. See Is the partner waiting on your customer?.
url works without a login, so treat it like a credential. Give it only to the end customer it belongs to, and never log, store or share it anywhere else.

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

The party's 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.