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

The Consumers API from Weavr — 3 operation(s) for consumers.

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

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

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

Consumers 3
POST
/consumers/fees/chargedeprecated
Charge fee to a consumer
consumerChargeFee 1 param body → 200400401403409500503default
POST
/consumers
Register a consumer
consumerCreate 1 param body → 200400401403409429500503
POST
/consumers/{consumer_id}/verify
Simulate verification of a consumer identity
consumers_consumer_id_verify 2 params → 204400default

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are ConsumerRootUser (16 properties), Consumer (11 properties), ChargeFee (7 properties), AddressWithNoRequiredFields (6 properties). Each schema is shown below with its type and property counts.

CurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties 2 required
ValidationError
array
Is returned as part of an HTTP error response whenever a validation error is detected. A list of the fields together with their syntax error will be provided.
Fee
object
2 properties 2 required
Brand
string
Brand identifier used to determine the set of email and SMS user notification templates. Must be alphanumeric, up to 25 characters, and contain no spaces.
Tag
string
The tag field is a custom field that can be used to search and filter.
ClientInvalidRequest
object
2 properties
Date
object
3 properties 3 required
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
TransactionState
string
Status of the transaction.
UserLocale
string
BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
AddressWithCountryRequired
object
The address, with none of the separate fields being set as required.
6 properties 1 required
ConsumerRootUser
object
16 properties 8 required
TransactionId
object
2 properties 2 required
ConsumerSourceOfFunds
string
The consumer's source of funds.
Email
string
E-mail Address of the user
InstrumentType
string
InstrumentId
object
2 properties 2 required
Occupation
string
The industry of the identity.
ProfileId
string
The profile Id which a specific identity, instrument or transaction type is linked to. Profiles contain configuration and determine behavioral aspects of the n…
Consumer
object
11 properties 5 required
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
MessageValidation
object
2 properties
Id
string
IdentityId
object
2 properties 2 required
FieldValidationType
string
Mobile
object
2 properties 2 required
Error
object
2 properties
DefaultError
object
A default error model in case of errors other than 400, 409 or 504.
1 property
AddressWithNoRequiredFields
object
The address, with none of the separate fields being set as required.
6 properties
Nationality
string
Nationality of the user - using ISO 3166 alpha-2.
ChargeFee
object
7 properties 8 required
FieldValidation
object
2 properties
FieldValidationErrors
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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