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 Confirmation Challenges API

Issue and verify confirmation challenges used to authorise lists of resources.

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

Tagged areas include Confirmation Challenges. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 7 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 7 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 Confirmation Challenges 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.

Confirmation Challenges 3

Issue and verify confirmation challenges used to authorise lists of resources.

POST
/challenges/otp/{channel}
Issue a one-time password that can be used to verify a list of resources
multipleSCAChallenge 2 params body → 200400401403405409429500
POST
/challenges/{scaChallengeId}/otp/{channel}/verify
Verify a list of resources using a one-time password
multipleSCAVerify 3 params body → 204400401403409429500503
POST
/challenges/push/{channel}
Issue a push notification that can be used to verify a list of resources
multipleSCAChallengePush 2 params body → 200400401403405409429500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Error (2 properties), SyntaxError (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
MultipleSCAResourceType
string
The operation type upon which an SCA Challenge is being contested.
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…
Nonce
string
A randomly generated one-time use code.
SCAOtpChannel
string
- "SMS": The one-time-password is sent as a text message
Id
string
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-confirmation-challenges-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 Consumers API