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

The Corporates API from Weavr — 3 operation(s) for corporates.

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

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

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

Corporates 3
POST
/corporates/fees/chargedeprecated
Charge fee to a corporate
corporateChargeFee 1 param body → 200400401403404409500503
POST
/corporates
Register a corporate
corporateCreate 1 param body → 200400401403409429500503
POST
/corporates/{corporate_id}/verify
Simulate verification of corporate identity
corporates_corporate_id_verify 2 params → 204400default

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are Corporate (14 properties), CorporateRootUser (13 properties), ChargeFee (7 properties), LegalAddress (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
CreatedCorporate
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.
CorporateRootUser
object
13 properties 9 required
ClientInvalidRequest
object
2 properties
Date
object
3 properties 3 required
Address
object
6 properties 4 required
Corporate
object
14 properties 7 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
UserLocale
string
BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
TransactionState
string
Status of the transaction.
CorporateSourceOfFunds
string
The corporate's source of funds.
TransactionId
object
2 properties 2 required
CreatedCorporateRootUser
LegalAddress
object
The legal address of the company. This information is captured via the Due Diligence (KYB) process.
6 properties 3 required
CompanyType
string
Supported company types - if company type is not listed, please contact our support team to check if the company type can be supported.
Email
string
E-mail Address of the user
InstrumentType
string
InstrumentId
object
2 properties 2 required
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…
FieldValidationErrors
object
2 properties
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
Industry
string
The industry of the identity.
Error
object
2 properties
DefaultError
object
A default error model in case of errors other than 400, 409 or 504.
1 property
ChargeFee
object
7 properties 8 required
FieldValidation
object
2 properties
Tag
string
The tag field is a custom field that can be used to search and filter.
CompanyPosition
string
The company position of the Corporate Root User.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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