Skip to content
/
Start KYC for a consumer

Weavr Multi Product API (3.63.5)

Weavr Multi API provides a simple and flexible way to issue cards and accounts to your customers.

By integrating Weavr Multi API in your application you can embed banking capabilities within your app and provide a seamless experience for your customers.

Authentication

Each request to the Multi API must include an api-key that represents your account. You can obtain an API Key by registering for a Multi account here.

Almost all endpoints require a secondary authentication token auth_token that represents the user for whom the request is being executed.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://weavr.io
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/multi/openapi
Weavr Sandbox Environment
https://sandbox.weavr.io/multi

Access

Manage authentication for your users.

Operations

Passwords

Manage your users' passwords.

Operations

Authentication Factors

Operations

Step-up Challenges

Operations

Confirmation Challenges

Operations

Corporates

Corporates are identities representing companies. Once on-boarded, Corporates can create and manage their own instruments via your application.

Operations

Consumers

Consumers are identities representing individuals. Once on-boarded, Consumers can create and manage their own instruments via your application.

Operations

Verify email of the root user

Request

The second step in verifying the root user's email. The randomly generated code sent to the root user via email, using the consumerRootUserEmailVerificationCodeSend operation, is submitted here to verify the root user's email.

This is needed as part of the verification process for basic due diligence.

Note that on the Sandbox Environment, emails are not sent and the verification code is always set to "123456".

Security
api-key
Bodyapplication/jsonrequired
emailstring(email)(Email)required

E-mail Address of the user

verificationCodestring(VerificationCode)^[0-9]{6}$required

A randomly generated one-time use code used to verify the user's email address or mobile number.

curl -i -X POST \
  https://api.weavr.io/_mock/products/multi/openapi/consumers/verification/email/verify \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@example.com",
    "verificationCode": "string"
  }'

Responses

Success - No Content.

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Response
No content

Start KYC for a consumer

Request

Consumers need to complete due diligence (KYC) before they can create instruments and fund transaction.

This operation initiates the due diligence process for the logged-in consumer.

Due Diligence is handled by a KYC provider, you will need to embed the KYC UI Component in your application to show the KYC screens to your users.

To initialise the KYC UI Component, you need a reference that is given to you in the response of this operation.

Security
auth_token and api-key
Bodyapplication/json
prefillDetailsArray of objects

List of KYC details to be prefilled for the consumer.

kycLevelstring(KycLevel)Deprecated

The KYC level, which determines what KYC information will be requested from the consumer:

  • KYC_LEVEL_1: The most basic level of KYC required.
  • KYC_LEVEL_2: Full due diligence level 2
Enum"KYC_LEVEL_1""KYC_LEVEL_2"
curl -i -X POST \
  https://api.weavr.io/_mock/products/multi/openapi/consumers/kyc \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "kycLevel": "KYC_LEVEL_1",
    "prefillDetails": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
referencestring^[0-9]+$required

The reference used to initialise the KYC UI Component.

kycLevelstring(KycLevel)Deprecatedrequired

The KYC level, which determines what KYC information will be requested from the consumer:

  • KYC_LEVEL_1: The most basic level of KYC required.
  • KYC_LEVEL_2: Full due diligence level 2
Enum"KYC_LEVEL_1""KYC_LEVEL_2"
Response
application/json
{
  "reference": "string",
  "kycLevel": "KYC_LEVEL_1"
}

Get KYC for a consumer

Request

Returns the KYC status for the logged-in consumer.

Security
auth_token and api-key
curl -i -X GET \
  https://api.weavr.io/_mock/products/multi/openapi/consumers/kyc \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
fullDueDiligencestring(KyiStatus)required

The status of the Due Diligence for the consumer.

Enum"NOT_STARTED""INITIATED""PENDING_REVIEW""APPROVED""REJECTED"
ongoingFullDueDiligencestring(KyiStatus)required

The status of the ongoing Due Diligence process for the consumer

Enum"NOT_STARTED""INITIATED""PENDING_REVIEW""APPROVED""REJECTED"
kycLevelstring(KycLevel)Deprecated

The KYC level, which determines what KYC information will be requested from the consumer:

  • KYC_LEVEL_1: The most basic level of KYC required.
  • KYC_LEVEL_2: Full due diligence level 2
Enum"KYC_LEVEL_1""KYC_LEVEL_2"
ongoingKycLevelstring(KycLevel)Deprecated

The KYC level, which determines what KYC information will be requested from the consumer:

  • KYC_LEVEL_1: The most basic level of KYC required.
  • KYC_LEVEL_2: Full due diligence level 2
Enum"KYC_LEVEL_1""KYC_LEVEL_2"
Response
application/json
{
  "fullDueDiligence": "NOT_STARTED",
  "kycLevel": "KYC_LEVEL_1",
  "ongoingFullDueDiligence": "NOT_STARTED",
  "ongoingKycLevel": "KYC_LEVEL_1"
}

Authorised Users

Corporate and Consumer identities can invite authorised users to access their account. Once on-boarded, authorised users can create and manage instruments and transactions on behalf of the identity they are on-boarded with.

In case of Corporate Identities, authorised users are typically employees who have access to company's banking products such as cards and bank accounts.

In case of Consumer Identities, authorised users are typically children/teens whose parents want them to have access to banking products such as cards and bank accounts.

Note that the /users GET endpoints return all users including root users. However, modification operations (create, update, activate, deactivate) on /users endpoints only apply to authorised users. To modify root user details, use the respective /consumers or /corporates endpoints.

Operations

Beneficiaries

Operations

Managed Accounts

Managed Accounts are a type of financial instrument offered by Weavr.

They hold funds for their owner, and can be upgraded to IBANs so as to receive and send funds to instruments outside of the Weavr Platform, via Wire Transfers.

Managed accounts can also be used as source and destination instruments in the transfer and send transactions.

Operations

Managed Cards

Managed Cards are a type of financial instrument offered by Weavr.

You can create virtual or physical cards that are issued to the consumer or corporate identity.

A card created in prepaid mode has its own balance, whereas a card created in debit mode does not have its own balance but taps into the balance of its parent managed account.

Operations

Linked Accounts

Linked Accounts are external bank accounts that users connect to their profiles within the Weavr Platform.

These accounts allow users to link their existing bank accounts, held at external financial institutions, to the Weavr Platform, enabling secure and efficient transfer of funds between their own accounts.

Linked Accounts are designed to streamline the process of moving money between a user’s various bank accounts, providing a convenient and integrated way to manage personal finances across different financial institutions.

Operations

Sends

The Send transaction is used to send funds between managed accounts and managed cards belonging to different identities.

Operations

Transfers

The Transfer transaction is used to transfer funds between managed accounts and managed cards belonging to same identity.

Operations

Outgoing Wire Transfers

The Outgoing Wire Transfer transaction is used to transfer funds from managed accounts to an external bank account.

Operations

Incoming Wire Transfers

Webhooks

Operations

Operations

Manage

Operations