Consume a user invite

Request

Consumes an invitation previously 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

apiKey

Path

user_idstring^[0-9]+$required

The unique identifier for the user.

Example:110747174434373672

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, = 6 characters^[0-9]*$required

A randomly generated one-time use code.

passwordobjectrequired

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

between 8 and 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.

curl -i -X POST \
  https://sandbox.weavr.io/payment-run/v1/users/110747174434373672/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"
    }
  }'

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"
}