Skip to content

Create a password

Request

Create a new password for the user identified by the user_id path parameter.

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

The unique identifier for the user.

Bodyapplication/jsonrequired
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.

curl -i -X POST \
  'https://sandbox.weavr.io/multi/passwords/{user_id}/create' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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
passwordInfoobject(PasswordInfo)

Additional information related to the user's password.

tokenstring

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

Response
{
  "passwordInfo": {
    "identityId": { … },
    "expiryDate": 0
  },
  "token": "string"
}