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 Customer Data & Due Diligence API

Manage customer profile data and KYC/KYB due diligence flows for corporates and consumers.

Weavr Customer Data & Due Diligence API is one of 43 APIs that Weavr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customer Data & Due Diligence. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 4 paths, and defines 28 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.

8 operations 4 paths 28 schemas 4 GET2 PATCH2 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 Customer Data & Due Diligence 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 8

Across 4 paths, the API surfaces 8 operations — 4 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Customer Data & Due Diligence 8

Manage customer profile data and KYC/KYB due diligence flows for corporates and consumers.

GET
/corporates
Get a corporate
corporateGet → 200400401403429500503default
PATCH
/corporates
Update a corporate
corporateUpdate 1 param body → 200400401403404409429500
POST
/corporates/kyb
Start KYB for a corporate
corporateKybStart → 200400401403409429500503
GET
/corporates/kyb
Get KYB for a corporate
corporateKybGet → 200400401403429500503default
GET
/consumers
Get a consumer
consumerGet → 200400401403429500503default
PATCH
/consumers
Update a consumer
consumerUpdate body → 200400401403409429500503
POST
/consumers/kyc
Start KYC for a consumer
consumerKycStart body → 200400401403409429500503
GET
/consumers/kyc
Get KYC for a consumer
consumerKycGet → 200400401403429500503default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are ConsumerRootUser (16 properties), Corporate (14 properties), CorporateRootUser (13 properties), Consumer (11 properties). Each schema is shown below with its type and property counts.

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
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.
AddressWithCountryRequired
object
The address, with none of the separate fields being set as required.
6 properties 1 required
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…
CorporateSourceOfFunds
string
The corporate's source of funds.
KyiStatus
string
ConsumerSourceOfFunds
string
The consumer's source of funds.
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
ConsumerRootUser
object
16 properties 8 required
Consumer
object
11 properties 5 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…
Occupation
string
The industry of the identity.
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
IdentityId
object
2 properties 2 required
Mobile
object
2 properties 2 required
Industry
string
The industry of the identity.
Error
object
2 properties
Nationality
string
Nationality of the user - using ISO 3166 alpha-2.
AddressWithNoRequiredFields
object
The address, with none of the separate fields being set as required.
6 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-customer-data-due-diligence-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