Skip to main content
POST
Issue a partner-terms consent link up front
Requires scope: manage:parties — see Required scopes. Mints a fresh consent link so your end customer can accept every partner’s terms before onboarding begins — before any of their data is sent to a partner. Use this when you’d rather collect consent up front than wait for it to become a blocker. The hosted page shows every currently-enabled partner’s latest terms in one pass, whether or not the party has been forwarded to any partner yet. Takes no request body.
Every call supersedes the previous link. A link you already handed out stops working the moment you call this again. Don’t use it to check state — read the consent state for that.
The URL embeds a scoped, expiring token. Treat it as a credential: don’t log it, don’t put it in a shared inbox, and don’t reuse it across customers. When it expires, issue a new one rather than trying to extend it.

Errors

See Partner-terms consent.

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

A consent link was issued

success
boolean

Indicates whether the request was successful

result
object

A freshly issued consent link, letting the end customer accept every enabled partner's latest terms up front — before any of their data reaches a partner.