Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weavr Sign-in API

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

Weavr Sign-in API is one of 43 APIs that Weavr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sign-in. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version v3.

Requests are made against a single base URL, https://sandbox.weavr.io/multi/backoffice.

3 operations 3 paths 8 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v3
Base URL
https://api.weavr.io/multi
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Weavr Sign-in API declares 2 security schemes for authenticating requests. An API key is passed in the header as api-key (api_key). It accepts HTTP bearer tokens (JWT) (auth_token).

  • api_key — The API Key representing your Multi account.
  • auth_token — The authentication token representing the user. This will be included in the login response object.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Sign-in 3

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

POST
/login_with_password
Sign in with password
loginWithPassword body → 200400401403404409410423
POST
/login_via_biometrics
Sign in via biometrics
loginViaBiometrics body → 200400401403409423429500
POST
/logoutdeprecated
Logout
logout → 200204400401429500503default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Error (2 properties), IdentityId (2 properties), CredentialId (2 properties), TokenError (1 property). Each schema is shown below with its type and property counts.

SyntaxError
object
Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax error will be provided.
1 property
TokenError
object
The used token is expired or not found
1 property
SensitivePassword
object
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 ot…
1 property 1 required
Email
string
E-mail Address of the user
IdentityId
object
2 properties 2 required
TokenType
string
The auth token received can only be used to access the following endpoints: - /identities - /accesstoken
Error
object
2 properties
CredentialId
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-sign-in-api-openapi.yml Raw ↑

Other APIs Weavr publishes across the network.

Weavr Access Token API
Weavr Access Tokens API
Weavr Accounts API
Weavr Additional Factors API
Weavr Authentication Factors API
Weavr Authorised Signatories API
Weavr Authorised Users API
Weavr Buyer Authorised Users API
Weavr Buyers API
Weavr Card Payments API
Weavr Cards API
Weavr Confirmation Challenges API