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 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 55 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.2.0, at version v3.

Requests are made against a single base URL, https://sandbox.weavr.io/multi.

8 operations 4 paths 28 schemas 4 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3
Base URL
https://api.weavr.io/multi
Authentication
API Key, HTTP Bearer, API Key
Contact
Resource Areas
1

Authentication & Security 3

Weavr Customer Data & Due Diligence API declares 3 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 webhooks-key (webhooks_key).

  • 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…
  • auth_token — The authentication token representing the user. This will be included in the login response object.
  • webhooks_key — The Webhooks key can be found in the API Credentials tab in your Portal Page.

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.

CorporateRootUser
object
13 properties 9 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.
Industry
string
The industry of the identity.
AddressWithNoRequiredFields
object
The address, with none of the separate fields being set as required.
6 properties
Mobile
object
2 properties 2 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…
UserLocale
string
BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
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.
CorporateSourceOfFunds
string
The corporate's source of funds.
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
Consumer
object
11 properties 5 required
Error
object
2 properties
KyiStatus
string
Date
object
3 properties 3 required
Corporate
object
14 properties 7 required
IdentityId
object
2 properties 2 required
Address
object
6 properties 4 required
Tag
string
The tag field is a custom field that can be used to search and filter.
LegalAddress
object
The legal address of the company. This information is captured via the Due Diligence (KYB) process.
6 properties 3 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…
Email
string
E-mail Address of the user
Occupation
string
The industry of the identity.
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
ConsumerSourceOfFunds
string
The consumer's source of funds.
Nationality
string
Nationality of the user - using ISO 3166 alpha-2.
CompanyPosition
string
The company position of the Corporate Root User.
ConsumerRootUser
object
16 properties 8 required

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
Where this information came from

This is an independent, third-party profile of Weavr Customer Data & Due Diligence 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.