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 Factors API

The Factors API from Weavr — 3 operation(s) for factors.

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

Tagged areas include Factors. 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 Factors 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.

Factors 3
POST
/factors/{credentials_id}/challenges/{challenge_id}/verify_invalid
Simulate invalid verification of specified challenge
factors_credentials_id_challenges_challenge_id_verify_invalid 3 params → 200400default
POST
/factors/{credentials_id}/challenges/{challenge_id}/verify_expired
Simulate expiry of specified challenge
factors_credentials_id_challenges_challenge_id_verify_expired 3 params → 200400default
POST
/factors/{credentials_id}/challenges/{challenge_id}/verify_success
Simulate successful verification of specified challenge
factors_credentials_id_challenges_challenge_id_verify_success 3 params → 200400default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are MessageValidation (2 properties), FieldValidation (2 properties), ClientInvalidRequest (2 properties), FieldValidationErrors (2 properties). Each schema is shown below with its type and property counts.

FieldValidationType
string
DefaultError
object
A default error model in case of errors other than 400, 409 or 504.
1 property
ClientInvalidRequest
object
2 properties
SimulateVerifyChallengeResponseResponseCode
string
FieldValidation
object
2 properties
SimulateVerifyChallengeResponse
object
1 property 1 required
MessageValidation
object
2 properties
FieldValidationErrors
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-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 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