Accept Invitation

Activates the invited user's account. No request body is required — the password is managed internally.

Before calling this endpoint, create a session scoped to the invited user using the customerUid returned in step 1, then pass the session headers (X-Session-Id + X-Client-Id) with this request.

On success (200), the account is activated with no further steps required.

On 403, the account is created but additional actions are required (e.g., phone verification, KYC). Continue the onboarding flow using your session headers (X-Session-Id + X-Client-Id) for all subsequent /limited/ endpoints.

403 meta.fields values:

ValueMeaning
phoneNumberUser must verify their phone number
kycUser must complete KYC (individual signup)
kybUser must complete KYB (business onboarding)

Possible error codes:

CodeStatusDescription
INVITATION_DOES_NOT_EXIST400Token is invalid or already used
REQUIRED_DEVICE_ID400V-Client-Device-Id header is missing
REQUIRED_INVITATION_TOKEN400token query parameter is missing
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Activates the invited user's account. No request body is required — the password is managed internally.

Before calling this endpoint, create a session scoped to the invited user using the customerUid returned from step 1 (Check Invitation Token), then pass X-Session-Id + X-Client-Id with this request.

A 200 means the account is immediately active. A 403 means the account is created but additional onboarding steps (phone verification, KYC) are required — continue with steps 4–9 using your session headers.

Path differs per user type — use the correct URL for your user type:

  • Individual: POST /branches/public/v1/individual/invites/accept
  • Business Owner: POST /branches/public/v1/businessowner/invites/accept
  • Operator: POST /branches/public/v1/operator/invites/accept

The headers and response schema are the same for all three.

Query Params
string
required

Invitation token (same value from step 1).

Headers
string

Unique identifier for the client device. Use a UUID.

Responses
200

Account activated successfully. No further onboarding steps needed.

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json