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

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

Weavr Consumers API is one of 55 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 42 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://sandbox.weavr.io/multi/backoffice, https://sandbox.weavr.io/multi, https://sandbox.weavr.io/simulate/api", "".

3 operations 3 paths 42 schemas 3 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, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Weavr Consumers API declares 6 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 api-key (api-key). An API key is passed in the header as webhooks-key (webhooks_key). An API key is passed in the header as programme-key (API_Secret_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.
  • 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…
  • webhooks_key — The Webhooks key can be found in the API Credentials tab in your Portal Page.
  • API_Secret_Key — The API Secret Key - available from the Configuration area of the Innovator Portal
  • Auth_Token — Authorization Token returned by login - example format: e6YrWi53lW0Bb6TbBL4ADA==

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 42

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

Id
string
Fee
object
2 properties 2 required
CurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties 2 required
TransactionId
object
2 properties 2 required
Error
object
2 properties
ChargeFee
object
7 properties 8 required
InstrumentType
string
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.
TransactionState
string
Status of the transaction.
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
InstrumentId
object
2 properties 2 required
AddressWithCountryRequired
object
The address, with none of the separate fields being set as required.
6 properties 1 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.
AddressWithNoRequiredFields
object
The address, with none of the separate fields being set as required.
6 properties
Mobile
object
2 properties 2 required
UserLocale
string
BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
Consumer
object
11 properties 5 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
Date
object
3 properties 3 required
IdentityId
object
2 properties 2 required
Tag
string
The tag field is a custom field that can be used to search and filter.
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…
Email
string
E-mail Address of the user
Occupation
string
The industry of the identity.
ConsumerSourceOfFunds
string
The consumer's source of funds.
Nationality
string
Nationality of the user - using ISO 3166 alpha-2.
ConsumerRootUser
object
16 properties 8 required
FieldValidationType
string
FieldValidation
object
2 properties
FieldValidationErrors
object
2 properties
MessageValidation
object
2 properties
DefaultError
object
A default error model in case of errors other than 400, 409 or 504.
1 property
ClientInvalidRequest
object
2 properties
KycRejectionReason
string
KycLevel
string
The KYC level, which determines what KYC information will be requested from the consumer: - KYCLEVEL1: The most basic level of KYC required. - KYCLEVEL2: Full…
IdentityDeactivatedEvent
object
3 properties 3 required
KyiStatus
string
IdentityActivatedEvent
object
2 properties 2 required
IdentityDeactivatedReasonCode
string
ActionDoneBy
string
KycEvent
object
10 properties
KycEventAdditionalInformation
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
Where this information came from

This is an independent, third-party profile of Weavr Consumers 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.