Skip to content
/
Consume a user's invite

Consume a user's invite

Request

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

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

Security
api-key
Path
user_idstring(UserId)^[0-9]+$required

The unique identifier for the user.

Headers
idempotency-refstring

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.

Bodyapplication/jsonrequired
inviteCodestring(Nonce)^[0-9]{6}$required

A randomly generated one-time use code.

passwordobject(SensitivePassword)required

The user's password or passcode used to log in a user. Passwords must be:

  • minimum 8 characters for end-users (Consumers and Corporates); 12 characters for others
  • maximum 30 characters
  • include a lowercase character
  • include an uppercase character
  • include a digit and a special character
  • different from any of the 5 last such passwords used.

For non-PCI compliant integrations, the password submitted must be tokenised.

mobileobject(Mobile)

Optional mobile number for the user. If provided, the user's mobile is set/replaced as part of consuming the invite. The new number is left unverified — it must be enrolled afterwards.

curl -i -X POST \
  'https://sandbox.weavr.io/multi/users/{user_id}/invite/consume' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "inviteCode": "string",
    "password": {
      "value": "pa$$word"
    },
    "mobile": {
      "countryCode": "stri",
      "number": "string"
    }
  }'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
tokenstring

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

Response
{
  "token": "string"
}