Skip to content
/
Update 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

Get a consumer

Request

Retrieve the details of the logged-in Consumer.

Security
auth_token and api-key
curl -i -X GET \
  https://api.weavr.io/_mock/products/multi/openapi/consumers \
  -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
idobject(IdentityId)required

The unique identifier of the Consumer Identity.

id.​typestringrequired

Indicates the identity type.

Enum"CONSUMER""CORPORATE"
id.​idstring^[0-9]+$required

The identifier for the identity.

profileIdstring(ProfileId)^[0-9]+$required

The profile Id which a specific identity, instrument or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

tagstring(Tag)<= 50 characters^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

rootUserobject(ConsumerRootUser)required

The root user of the Consumer Identity.

rootUser.​idobject(IdentityId)required
rootUser.​id.​typestringrequired

Indicates the identity type.

Enum"CONSUMER""CORPORATE"
rootUser.​id.​idstring^[0-9]+$required

The identifier for the identity.

rootUser.​namestring<= 100 charactersrequired

First name of the root user.

rootUser.​surnamestring<= 100 charactersrequired

Last name of the root user.

rootUser.​emailstring(email)(Email)required

E-mail Address of the user

rootUser.​mobileobject(Mobile)required
rootUser.​mobile.​countryCodestring[ 1 .. 4 ] characters^\+[0-9]+$required

The country code of the user mobile number (e.g. +44).

rootUser.​mobile.​numberstring^[0-9]{1,12}$required

The mobile number of the user - excluding country code.

rootUser.​activebooleanrequired

The state of the root user. If false, then the user will not be able to log in.

rootUser.​emailVerifiedbooleanrequired

Indicates if the root user's email has been verified.

rootUser.​mobileNumberVerifiedbooleanrequired

Indicates if the root user's mobile number has been verified.

rootUser.​dateOfBirthobject(Date)

Date of birth of the consumer root user.

rootUser.​addressobject(AddressWithNoRequiredFields)

Address of the consumer root user.

rootUser.​nationalitystring(Nationality)= 2 characters^[A-Z]+$

Nationality of the consumer root user, in ISO 3166 alpha-2 format.

rootUser.​placeOfBirthstring

The place of birth of the consumer root user.

rootUser.​tagstring(Tag)<= 50 characters^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

rootUser.​localestring(UserLocale)<= 5 characters^[a-z]{2}(-[A-Z]{2})?$

BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.

rootUser.​brandstring(Brand)<= 25 characters^[a-zA-Z0-9]+$

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.

rootUser.​occupationstring(Occupation)Deprecated

The industry of the identity.

Enum"ACCOUNTING""AUDIT""FINANCE""PUBLIC_SECTOR_ADMINISTRATION""ART_ENTERTAINMENT""AUTO_AVIATION""BANKING_LENDING""BUSINESS_CONSULTANCY_LEGAL""CONSTRUCTION_REPAIR""EDUCATION_PROFESSIONAL_SERVICES"
creationTimestampinteger(int64)required

The time when this consumer was created, expressed in Epoch timestamp using millisecond precision.

ipAddressstring[ 5 .. 45 ] charactersrequired

The IP address of the consumer user doing the registration.

acceptedTermsboolean

Must be set to true to indicate that the consumer root user has accepted the terms and conditions.

baseCurrencystring(Currency)= 3 characters^[A-Z]*$

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

feeGroupstring

The fee group which the consumer is bound to.

sourceOfFundsstring(ConsumerSourceOfFunds)Deprecated

The consumer's source of funds.

Enum"PERSONAL_SAVINGS""FAMILY_SAVINGS""LABOUR_CONTRACT""CIVIL_CONTRACT""RENT""FUNDS_FROM_OTHER_AUXILIARY_SOURCES""SALE_OF_MOVABLE_ASSETS""SALE_OF_REAL_ESTATE""ORDINARY_BUSINESS_ACTIVITY""DIVIDENDS"
sourceOfFundsOtherstringDeprecated

Description of source of funds in case OTHER was chosen.

Response
application/json
{
  "id": {
    "type": "CONSUMER",
    "id": "string"
  },
  "profileId": "string",
  "tag": "string",
  "rootUser": {
    "id": { … },
    "name": "string",
    "surname": "string",
    "email": "user@example.com",
    "mobile": { … },
    "occupation": "ACCOUNTING",
    "active": true,
    "emailVerified": true,
    "mobileNumberVerified": true,
    "dateOfBirth": { … },
    "address": { … },
    "nationality": "st",
    "placeOfBirth": "string",
    "tag": "string",
    "locale": "en-GB",
    "brand": "string"
  },
  "creationTimestamp": 0,
  "ipAddress": "string",
  "acceptedTerms": true,
  "baseCurrency": "str",
  "feeGroup": "string",
  "sourceOfFunds": "PERSONAL_SAVINGS",
  "sourceOfFundsOther": "string"
}

Update a consumer

Request

Update the details of the logged-in consumer identity.

If the Consumer root user has already completed KYC, the following details cannot be updated:

  • name
  • surname
  • email
  • mobile Country Code
  • mobile Number
  • date of Birth
  • address
Security
auth_token and api-key
Bodyapplication/jsonrequired
tagstring(Tag)<= 50 characters^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

namestring<= 20 characters^[^0-9~!@#$%^*()_+={}\|:;,<>/?]*$

The first name of the Consumer root user.

surnamestring<= 20 characters^[^0-9~!@#$%^*()_+={}\|:;,<>/?]*$

The last name of the Consumer root user.

emailstring(email)(Email)

E-mail Address of the user

mobileobject(Mobile)
dateOfBirthobject(Date)

Date of birth of the consumer root user.

addressobject(AddressWithCountryRequired)

Address of the consumer root user.

feeGroupstring

The fee group which the consumer will be bound to. Do not specify this if you are not using fee groups.

baseCurrencystring(Currency)= 3 characters^[A-Z]*$

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

placeOfBirthstring

The place of birth of the consumer root user.

nationalitystring(Nationality)= 2 characters^[A-Z]+$

Nationality of the consumer root user, in ISO 3166 alpha-2 format.

resetMobileCounterboolean
userTagstring(Tag)<= 50 characters^[a-zA-Z0-9_-]+$

The tag to be assigned to the root user.

localestring(UserLocale)<= 5 characters^[a-z]{2}(-[A-Z]{2})?$

BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.

brandstring(Brand)<= 25 characters^[a-zA-Z0-9]+$

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.

occupationstring(Occupation)Deprecated

The industry of the identity.

Enum"ACCOUNTING""AUDIT""FINANCE""PUBLIC_SECTOR_ADMINISTRATION""ART_ENTERTAINMENT""AUTO_AVIATION""BANKING_LENDING""BUSINESS_CONSULTANCY_LEGAL""CONSTRUCTION_REPAIR""EDUCATION_PROFESSIONAL_SERVICES"
sourceOfFundsstring(ConsumerSourceOfFunds)Deprecated

The consumer's source of funds.

Enum"PERSONAL_SAVINGS""FAMILY_SAVINGS""LABOUR_CONTRACT""CIVIL_CONTRACT""RENT""FUNDS_FROM_OTHER_AUXILIARY_SOURCES""SALE_OF_MOVABLE_ASSETS""SALE_OF_REAL_ESTATE""ORDINARY_BUSINESS_ACTIVITY""DIVIDENDS"
sourceOfFundsOtherstringDeprecated

Description of source of funds in case OTHER was chosen.

curl -i -X PATCH \
  https://api.weavr.io/_mock/products/multi/openapi/consumers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "tag": "string",
    "name": "string",
    "surname": "string",
    "email": "user@example.com",
    "mobile": {
      "countryCode": "stri",
      "number": "string"
    },
    "dateOfBirth": {
      "year": 1900,
      "month": 1,
      "day": 1
    },
    "address": {
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "postCode": "string",
      "state": "string",
      "country": "st"
    },
    "feeGroup": "string",
    "baseCurrency": "str",
    "occupation": "ACCOUNTING",
    "sourceOfFunds": "PERSONAL_SAVINGS",
    "sourceOfFundsOther": "string",
    "placeOfBirth": "string",
    "nationality": "st",
    "resetMobileCounter": true,
    "userTag": "string",
    "locale": "en-GB",
    "brand": "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
idobject(IdentityId)required

The unique identifier of the Consumer Identity.

id.​typestringrequired

Indicates the identity type.

Enum"CONSUMER""CORPORATE"
id.​idstring^[0-9]+$required

The identifier for the identity.

profileIdstring(ProfileId)^[0-9]+$required

The profile Id which a specific identity, instrument or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

tagstring(Tag)<= 50 characters^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

rootUserobject(ConsumerRootUser)required

The root user of the Consumer Identity.

rootUser.​idobject(IdentityId)required
rootUser.​id.​typestringrequired

Indicates the identity type.

Enum"CONSUMER""CORPORATE"
rootUser.​id.​idstring^[0-9]+$required

The identifier for the identity.

rootUser.​namestring<= 100 charactersrequired

First name of the root user.

rootUser.​surnamestring<= 100 charactersrequired

Last name of the root user.

rootUser.​emailstring(email)(Email)required

E-mail Address of the user

rootUser.​mobileobject(Mobile)required
rootUser.​mobile.​countryCodestring[ 1 .. 4 ] characters^\+[0-9]+$required

The country code of the user mobile number (e.g. +44).

rootUser.​mobile.​numberstring^[0-9]{1,12}$required

The mobile number of the user - excluding country code.

rootUser.​activebooleanrequired

The state of the root user. If false, then the user will not be able to log in.

rootUser.​emailVerifiedbooleanrequired

Indicates if the root user's email has been verified.

rootUser.​mobileNumberVerifiedbooleanrequired

Indicates if the root user's mobile number has been verified.

rootUser.​dateOfBirthobject(Date)

Date of birth of the consumer root user.

rootUser.​addressobject(AddressWithNoRequiredFields)

Address of the consumer root user.

rootUser.​nationalitystring(Nationality)= 2 characters^[A-Z]+$

Nationality of the consumer root user, in ISO 3166 alpha-2 format.

rootUser.​placeOfBirthstring

The place of birth of the consumer root user.

rootUser.​tagstring(Tag)<= 50 characters^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

rootUser.​localestring(UserLocale)<= 5 characters^[a-z]{2}(-[A-Z]{2})?$

BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.

rootUser.​brandstring(Brand)<= 25 characters^[a-zA-Z0-9]+$

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.

rootUser.​occupationstring(Occupation)Deprecated

The industry of the identity.

Enum"ACCOUNTING""AUDIT""FINANCE""PUBLIC_SECTOR_ADMINISTRATION""ART_ENTERTAINMENT""AUTO_AVIATION""BANKING_LENDING""BUSINESS_CONSULTANCY_LEGAL""CONSTRUCTION_REPAIR""EDUCATION_PROFESSIONAL_SERVICES"
creationTimestampinteger(int64)required

The time when this consumer was created, expressed in Epoch timestamp using millisecond precision.

ipAddressstring[ 5 .. 45 ] charactersrequired

The IP address of the consumer user doing the registration.

acceptedTermsboolean

Must be set to true to indicate that the consumer root user has accepted the terms and conditions.

baseCurrencystring(Currency)= 3 characters^[A-Z]*$

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

feeGroupstring

The fee group which the consumer is bound to.

sourceOfFundsstring(ConsumerSourceOfFunds)Deprecated

The consumer's source of funds.

Enum"PERSONAL_SAVINGS""FAMILY_SAVINGS""LABOUR_CONTRACT""CIVIL_CONTRACT""RENT""FUNDS_FROM_OTHER_AUXILIARY_SOURCES""SALE_OF_MOVABLE_ASSETS""SALE_OF_REAL_ESTATE""ORDINARY_BUSINESS_ACTIVITY""DIVIDENDS"
sourceOfFundsOtherstringDeprecated

Description of source of funds in case OTHER was chosen.

Response
application/json
{
  "id": {
    "type": "CONSUMER",
    "id": "string"
  },
  "profileId": "string",
  "tag": "string",
  "rootUser": {
    "id": { … },
    "name": "string",
    "surname": "string",
    "email": "user@example.com",
    "mobile": { … },
    "occupation": "ACCOUNTING",
    "active": true,
    "emailVerified": true,
    "mobileNumberVerified": true,
    "dateOfBirth": { … },
    "address": { … },
    "nationality": "st",
    "placeOfBirth": "string",
    "tag": "string",
    "locale": "en-GB",
    "brand": "string"
  },
  "creationTimestamp": 0,
  "ipAddress": "string",
  "acceptedTerms": true,
  "baseCurrency": "str",
  "feeGroup": "string",
  "sourceOfFunds": "PERSONAL_SAVINGS",
  "sourceOfFundsOther": "string"
}

Send an email verification code to the root user

Request

The first step in verifying a root user's email. The root user whose email address is to be verified is sent an email containing a randomly generated code.

This code must then be provided in the consumerRootUserEmailVerify operation to verify the root user's email address.

Note that on the Sandbox Environment, the verificationCode is always set to "123456".

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

E-mail Address of the user

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

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

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