Accept a user invitation

POST/users/{user_id}/invite/consume

Consumes an invitation perviously sent to the user via userInviteSend. This is needed so that the invited user sets up the password.

Note: on the Sandbox Environment, the inviteCode is always set to "123456".

Request

application/json

{}

objectobject · 3 fields

Request example

Path

/users/987654321/invite/consume

Headers

{  "idempotency-ref": "transfer-2026-08-07-001"}

Body

{  "inviteCode": "string",  "password": {    "value": "string"  },  "mobile": {    "countryCode": "+44",    "number": "7700900123"  }}

200OK

Success

Headers

Body

application/json

{}

TokenResponseTokenResponse · object · 1 field

Response example

{  "token": "string"}