How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weavr Authentication Factors API

Manage user authentication factors, including passwords and device-based factors (OTP and push).

Weavr Authentication Factors API is one of 54 APIs that Weavr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication Factors. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 9 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://sandbox.weavr.io/multi, "".

10 operations 9 paths 20 schemas 1 DELETE1 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 3

Weavr Authentication Factors API declares 3 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). An API key is passed in the header as webhooks-key (webhooks_key).

  • api-key — An API key defined in your User API Client (or Delegate API Client - this feature is available only to customers enabled with delegation functionality). API Cl…
  • auth_token — The authentication token representing the user. This will be included in the login response object.
  • webhooks_key — The Webhooks key can be found in the API Credentials tab in your Portal Page.

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 1 DELETE, 1 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Authentication Factors 10

Manage user authentication factors, including passwords and device-based factors (OTP and push).

POST
/passwords/{user_id}/create
Create a password
passwordCreate 1 param body → 200400401403404409410429
POST
/passwords/update
Update a password
passwordUpdate body → 200400401403404409410429
POST
/passwords/validate
Validate a password
passwordValidate body → 204400401403404409410429
POST
/passwords/lost_password/start
Initiate lost password process
lostPasswordInitiate body → 204400401403404409429500
POST
/passwords/lost_password/resume
Resume lost password process
lostPasswordResume body → 200400401403404409410429
GET
/authentication_factors
Get user authentication factors
authFactorsGet → 200400401403404429500503
POST
/authentication_factors/otp/{channel}
Enrol a user device for authentication using one-time passwords
enrolDeviceUsingOtpStepOne 2 params → 204400401403404409429500
POST
/authentication_factors/otp/{channel}/verify
Verify enrolment of a user device for authentication using one-time passwords
enrolDeviceUsingOtpStepTwo 2 params body → 204400401403404409429500
POST
/authentication_factors/push/{channel}
Enrol a user device for authentication using push notifications
enrolDeviceUsingPush 2 params → 204400401403404409429500
DELETE
/authentication_factors/push/{channel}
Unlink a user device for authentication using push notifications
unlinkDeviceUsingPush 2 params → 204400401403404409429500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are EnrolmentEvent (4 properties), SCAFactor (3 properties), IdentityId (2 properties), PasswordInfo (2 properties). Each schema is shown below with its type and property counts.

SCAFactorStatus
string
The state of the factor type. - PENDINGVERIFICATION : The user has started the enrolment process but still hasn't completed enrolment. Challenges cannot be use…
SCAFactor
object
3 properties
SCAPushChannel
string
- "AUTHY": The push notification is sent on the user's device using [Twilio Authy](https://www.twilio.com/authy) - "BIOMETRIC": The push notification is sent t…
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
PasswordInfo
object
Additional information related to the user's password.
2 properties 1 required
AuthSCAPushChannel
string
- "AUTHY": The push notification is sent on the user's device using [Twilio Authy](https://www.twilio.com/authy)
SCAChannel
string
- "SMS": The one-time-password is sent as a text message - "AUTHY": The push notification is sent to an Authy application - "BIOMETRIC": The push notification…
SCAChallengeType
string
- "OTP": The OTP is sent as a text message - "PUSH": The authorisation request is sent as a push notification - "BIOMETRIC": The push notification is sent via…
TokenError
object
The used token is expired or not found
1 property
TokenResponse
object
1 property
SCAOtpChannel
string
- "SMS": The one-time-password is sent as a text message
Nonce
string
A randomly generated one-time use code.
UserId
string
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
IdentityId
object
2 properties 2 required
Email
string
E-mail Address of the user
Error
object
2 properties
CredentialId
object
2 properties 2 required
EnrolmentEvent
object
4 properties 4 required
EnrolmentEventEnrolmentStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-authentication-factors-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 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
Weavr Consumers API
Where this information came from

This is an independent, third-party profile of Weavr Authentication Factors API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.