Setup

Accept a user invitation

Accepts the invitation sent with Invite a user to set a password and sets the user's first password.

Pass the inviteCode from the invitation URL together with the tokenized password. Check the invite is still valid first with Validate a user's invite, so the user doesn't fill in a form for an expired link.

:::note On sandbox, inviteCode is always 123456. :::

post/users/{user_id}/invite/consume

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/users/{user_id}/invite/consume
  • Auth: API key in header api-key

Path parameters

user_idstring required
Example:987654321

The unique identifier for the user.

Headers

idempotency-refstring
Example:transfer-2026-08-07-001

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Request body

inviteCodestring required

A randomly generated one-time use code.

Example request

{
  "inviteCode": "654321",
  "password": {
    "value": "Passw0rd!"
  },
  "mobile": {
    "countryCode": "+44",
    "number": "7700900123"
  }
}

Response

Success

tokenstring

An authorization token to be used in the Authorization header for secured operations.

Example response

{
  "token": "eyJraWQiOiJnZW5lcmF0b3IiLCJhbGciOiJFUzI1NiJ9.eyJzdWIiOiJST09ULDk4NzY1NDMyMSJ9.1KnuaBkSX_YfempeNMkUbxkkXsNz65-lQQXAhXrhiEI"
}

Changes

No recorded changes to this operation across all 1 revision of this API.