Manage authentication for your users.
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
Overview
URL
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/multi/openapi
Weavr Sandbox Environment
https://sandbox.weavr.io/multi
Request
Create a Consumer Identity to represent an Individual.
The information provided must be accurate as it will be passed on for KYC verification with our partner.
Incorrect information may incur a re-processing fee.
Security
api-key
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.
The tag field is a custom field that can be used to search and filter.
The root user represents the identity.
Root users need to verify their email address and mobile number, as well as complete KYC, as part of the Consumer's due diligence process.
Date of birth of the consumer root user.
Address of the consumer root user.
The post code associated with the address.
Nationality of the root user, in ISO 3166 alpha-2 format."
Tag to be assigned to the consumer root user.
BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
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.
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
The fee group which the consumer is bound to. Fee groups provide the possibility of different fees to users under the same profile. If fee groups are not required, ignore this field.
Must be set to true to indicate that the consumer has accepted the terms and conditions.
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"
- Mock serverhttps://api.weavr.io/_mock/products/multi/openapi/consumers
- Weavr Sandbox Environmenthttps://sandbox.weavr.io/multi/consumers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.weavr.io/_mock/products/multi/openapi/consumers \
-H 'Content-Type: application/json' \
-H 'api-key: YOUR_API_KEY_HERE' \
-H 'idempotency-ref: string' \
-d '{
"profileId": "string",
"tag": "string",
"rootUser": {
"name": "string",
"surname": "string",
"email": "user@example.com",
"mobile": {
"countryCode": "stri",
"number": "string"
},
"dateOfBirth": {
"year": 1900,
"month": 1,
"day": 1
},
"occupation": "ACCOUNTING",
"address": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"postCode": "string",
"state": "string",
"country": "st"
},
"placeOfBirth": "string",
"nationality": "st",
"tag": "string",
"locale": "en-GB",
"brand": "string"
},
"ipAddress": "string",
"acceptedTerms": true,
"baseCurrency": "str",
"feeGroup": "string",
"sourceOfFunds": "PERSONAL_SAVINGS",
"sourceOfFundsOther": "string"
}'Success
Bodyapplication/json
The unique identifier of the Consumer Identity.
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.
The tag field is a custom field that can be used to search and filter.
The root user of the Consumer Identity.
The state of the root user. If false, then the user will not be able to log in.
Indicates if the root user's mobile number has been verified.
Nationality of the consumer root user, in ISO 3166 alpha-2 format.
The tag field is a custom field that can be used to search and filter.
BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
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.
The time when this consumer was created, expressed in Epoch timestamp using millisecond precision.
The IP address of the consumer user doing the registration.
Must be set to true to indicate that the consumer root user has accepted the terms and conditions.
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
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"
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" }
- Mock serverhttps://api.weavr.io/_mock/products/multi/openapi/consumers
- Weavr Sandbox Environmenthttps://sandbox.weavr.io/multi/consumers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'Success
Bodyapplication/json
The unique identifier of the Consumer Identity.
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.
The tag field is a custom field that can be used to search and filter.
The root user of the Consumer Identity.
The state of the root user. If false, then the user will not be able to log in.
Indicates if the root user's mobile number has been verified.
Nationality of the consumer root user, in ISO 3166 alpha-2 format.
The tag field is a custom field that can be used to search and filter.
BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
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.
The time when this consumer was created, expressed in Epoch timestamp using millisecond precision.
The IP address of the consumer user doing the registration.
Must be set to true to indicate that the consumer root user has accepted the terms and conditions.
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
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"
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" }
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
- mobile Country Code
- mobile Number
- date of Birth
- address
Security
auth_token and api-key
The tag field is a custom field that can be used to search and filter.
The first name of the Consumer root user.
The last name of the Consumer root user.
The fee group which the consumer will be bound to. Do not specify this if you are not using fee groups.
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
Nationality of the consumer root user, in ISO 3166 alpha-2 format.
BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
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.
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"
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"
- Mock serverhttps://api.weavr.io/_mock/products/multi/openapi/consumers
- Weavr Sandbox Environmenthttps://sandbox.weavr.io/multi/consumers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
}'Success
Bodyapplication/json
The unique identifier of the Consumer Identity.
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.
The tag field is a custom field that can be used to search and filter.
The root user of the Consumer Identity.
The state of the root user. If false, then the user will not be able to log in.
Indicates if the root user's mobile number has been verified.
Nationality of the consumer root user, in ISO 3166 alpha-2 format.
The tag field is a custom field that can be used to search and filter.
BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
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.
The time when this consumer was created, expressed in Epoch timestamp using millisecond precision.
The IP address of the consumer user doing the registration.
Must be set to true to indicate that the consumer root user has accepted the terms and conditions.
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
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"
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" }
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 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 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