Skip to content

Sign-in

Sign users in using passwords, biometrics, or third-party auth providers.

Operations

Sign in with password

Request

Authenticate a user with the email and password that they provided when registering.

Given that the user credentials are correct, this returns a token that can then be used to authorise other secured operations. In case the password is expired, a temporary token is returned, which can be used solely for updating the password.

The token returned is valid for 5 minutes from last activity.

Security
api-key
Bodyapplication/jsonrequired
emailstring, (email)(Email)required

E-mail Address of the user

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/login_with_password \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@example.com",
    "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 (valid for 5 minutes from last activity) identifying the user to be used in the auth_token authorization header for secured operations.

tokenTypestring(TokenType)

The auth token received can only be used to access the following endpoints:

  • /identities
  • /access_token
Enum:"NO_TYPE""AUTH""ACCESS"
identityobject(IdentityId)

The identity to which the logged-in user belongs to.

credentialsobject(CredentialId)

The unique identifier for the logged-in user.

Response
{
  "token": "string",
  "tokenType": "NO_TYPE",
  "identity": {
    "type": "CONSUMER",
    "id": "string"
  },
  "credentials": {
    "type": "ROOT",
    "id": "string"
  }
}