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 corporate identity for a business customer. The information provided must be accurate and will be passed on for KYB verification with our partner.
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 needs to be a director or a legal representative of the corporate that is being onboarded - this user cannot be deactivated.
Root users need to verify their email address and mobile number, as well as complete KYC as part of the Corporate's due diligence process.
The company position of the Corporate Root User.
Enum"DIRECTOR""AUTHORISED_REPRESENTATIVE"
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.
The details associated with the company being on-boarded. The details provided need to match exactly with the details provided during KYB.
Supported company types - if company type is not listed, please contact our support team to check if the company type can be supported.
Enum"SOLE_TRADER""LLC""PUBLIC_LIMITED_COMPANY""LIMITED_LIABILITY_PARTNERSHIP""NON_PROFIT_ORGANISATION"
The IP address of the corporate user doing the registration.
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
Fee groups allow the possibility to charge different fees to users under the same profile. If fee groups are not required, ignore this field.
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 corporate's source of funds.
Enum"LABOUR_CONTRACT""CIVIL_CONTRACT""RENT""FUNDS_FROM_OTHER_AUXILIARY_SOURCES""SALE_OF_MOVABLE_ASSETS""SALE_OF_REAL_ESTATE""ORDINARY_BUSINESS_ACTIVITY""DIVIDENDS""LOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONS""LOAN_FROM_THIRD_PARTIES"
- Mock serverhttps://api.weavr.io/_mock/products/multi/openapi/corporates
- Weavr Sandbox Environmenthttps://sandbox.weavr.io/multi/corporates
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.weavr.io/_mock/products/multi/openapi/corporates \
-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"
},
"companyPosition": "DIRECTOR",
"dateOfBirth": {
"year": 1900,
"month": 1,
"day": 1
},
"tag": "string",
"locale": "en-GB",
"brand": "string"
},
"company": {
"type": "SOLE_TRADER",
"businessAddress": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"postCode": "string",
"state": "string",
"country": "st"
},
"name": "string",
"registrationNumber": "string",
"registrationCountry": "st"
},
"industry": "ACCOUNTING",
"sourceOfFunds": "LABOUR_CONTRACT",
"sourceOfFundsOther": "string",
"acceptedTerms": true,
"ipAddress": "string",
"baseCurrency": "str",
"feeGroup": "string"
}'Success
Bodyapplication/json
The unique identifier of the Corporate 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 Corporate Identity.
The company position of the Corporate Root User.
Enum"DIRECTOR""AUTHORISED_REPRESENTATIVE"
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.
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.
Example: "en-GB"
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.
Supported company types - if company type is not listed, please contact our support team to check if the company type can be supported.
Enum"SOLE_TRADER""LLC""PUBLIC_LIMITED_COMPANY""LIMITED_LIABILITY_PARTNERSHIP""NON_PROFIT_ORGANISATION"
The legal address of the company. This information is captured via the Due Diligence (KYB) process.
The country of company registration in ISO 3166 alpha-2.
Must be set to true to indicate that the root user has accepted the terms and conditions.
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
Fee groups allow the possibility to charge different fees to users under the same profile. If fee groups are not required, ignore this field.
The time when the Corporate was created, expressed in Epoch timestamp using millisecond precision.
Indicates the type of corporate entity based on its retail status.
Enum"RETAIL""NON_RETAIL""UNKNOWN"
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 corporate's source of funds.
Enum"LABOUR_CONTRACT""CIVIL_CONTRACT""RENT""FUNDS_FROM_OTHER_AUXILIARY_SOURCES""SALE_OF_MOVABLE_ASSETS""SALE_OF_REAL_ESTATE""ORDINARY_BUSINESS_ACTIVITY""DIVIDENDS""LOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONS""LOAN_FROM_THIRD_PARTIES"
Response
application/json
{ "id": { "type": "CONSUMER", "id": "string" }, "profileId": "string", "tag": "string", "rootUser": { "id": { … }, "name": "string", "surname": "string", "email": "user@example.com", "mobile": { … }, "companyPosition": "DIRECTOR", "active": true, "emailVerified": true, "mobileNumberVerified": true, "dateOfBirth": { … }, "tag": "string", "locale": "en-GB", "brand": "string", "passwordAlreadySet": true }, "company": { "name": "string", "type": "SOLE_TRADER", "registrationNumber": "string", "registeredAddress": { … }, "businessAddress": { … }, "countryOfRegistration": "st", "incorporatedOn": { … } }, "industry": "ACCOUNTING", "sourceOfFunds": "LABOUR_CONTRACT", "sourceOfFundsOther": "string", "acceptedTerms": true, "ipAddress": "string", "baseCurrency": "str", "feeGroup": "string", "creationTimestamp": 0, "retailQualifier": "RETAIL" }
- Mock serverhttps://api.weavr.io/_mock/products/multi/openapi/corporates
- Weavr Sandbox Environmenthttps://sandbox.weavr.io/multi/corporates
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.weavr.io/_mock/products/multi/openapi/corporates \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'api-key: YOUR_API_KEY_HERE'Success
Bodyapplication/json
The unique identifier of the Corporate 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 Corporate Identity.
The company position of the Corporate Root User.
Enum"DIRECTOR""AUTHORISED_REPRESENTATIVE"
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.
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.
Supported company types - if company type is not listed, please contact our support team to check if the company type can be supported.
Enum"SOLE_TRADER""LLC""PUBLIC_LIMITED_COMPANY""LIMITED_LIABILITY_PARTNERSHIP""NON_PROFIT_ORGANISATION"
The legal address of the company. This information is captured via the Due Diligence (KYB) process.
The country of company registration in ISO 3166 alpha-2.
Must be set to true to indicate that the root user has accepted the terms and conditions.
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
Fee groups allow the possibility to charge different fees to users under the same profile. If fee groups are not required, ignore this field.
The time when the Corporate was created, expressed in Epoch timestamp using millisecond precision.
Indicates the type of corporate entity based on its retail status.
Enum"RETAIL""NON_RETAIL""UNKNOWN"
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 corporate's source of funds.
Enum"LABOUR_CONTRACT""CIVIL_CONTRACT""RENT""FUNDS_FROM_OTHER_AUXILIARY_SOURCES""SALE_OF_MOVABLE_ASSETS""SALE_OF_REAL_ESTATE""ORDINARY_BUSINESS_ACTIVITY""DIVIDENDS""LOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONS""LOAN_FROM_THIRD_PARTIES"
Response
application/json
{ "id": { "type": "CONSUMER", "id": "string" }, "profileId": "string", "tag": "string", "rootUser": { "id": { … }, "name": "string", "surname": "string", "email": "user@example.com", "mobile": { … }, "companyPosition": "DIRECTOR", "active": true, "emailVerified": true, "mobileNumberVerified": true, "dateOfBirth": { … }, "tag": "string", "locale": "en-GB", "brand": "string" }, "company": { "name": "string", "type": "SOLE_TRADER", "registrationNumber": "string", "registeredAddress": { … }, "businessAddress": { … }, "countryOfRegistration": "st", "incorporatedOn": { … } }, "industry": "ACCOUNTING", "sourceOfFunds": "LABOUR_CONTRACT", "sourceOfFundsOther": "string", "acceptedTerms": true, "ipAddress": "string", "baseCurrency": "str", "feeGroup": "string", "creationTimestamp": 0, "retailQualifier": "RETAIL" }
Request
Update the details of the logged-in corporate identity.
The following Corporate details are verified during due diligence (KYB) and cannot be updated via the API once the Corporate has been verified:
- Root User Name
- Root User Surname
- Root User Email
- Root User Mobile Country Code
- Root User Mobile Number
- Business Address
- Date of birth
If these details need to be changed after due diligence is completed, please contact Customer Support to restart the Due Diligence process.
Security
auth_token and api-key
The tag field is a custom field that can be used to search and filter.
The fee group which the Corporate 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.
The first name of the Corporate root user.
The last name of the Corporate 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 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 corporate's source of funds.
Enum"LABOUR_CONTRACT""CIVIL_CONTRACT""RENT""FUNDS_FROM_OTHER_AUXILIARY_SOURCES""SALE_OF_MOVABLE_ASSETS""SALE_OF_REAL_ESTATE""ORDINARY_BUSINESS_ACTIVITY""DIVIDENDS""LOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONS""LOAN_FROM_THIRD_PARTIES"
- Mock serverhttps://api.weavr.io/_mock/products/multi/openapi/corporates
- Weavr Sandbox Environmenthttps://sandbox.weavr.io/multi/corporates
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://api.weavr.io/_mock/products/multi/openapi/corporates \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'api-key: YOUR_API_KEY_HERE' \
-H 'idempotency-ref: string' \
-d '{
"tag": "string",
"industry": "ACCOUNTING",
"sourceOfFunds": "LABOUR_CONTRACT",
"sourceOfFundsOther": "string",
"companyBusinessAddress": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"postCode": "string",
"state": "string",
"country": "st"
},
"feeGroup": "string",
"baseCurrency": "str",
"name": "string",
"surname": "string",
"email": "user@example.com",
"mobile": {
"countryCode": "stri",
"number": "string"
},
"dateOfBirth": {
"year": 1900,
"month": 1,
"day": 1
},
"resetMobileCounter": true,
"userTag": "string",
"locale": "en-GB",
"brand": "string"
}'Success
Bodyapplication/json
The unique identifier of the Corporate 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 Corporate Identity.
The company position of the Corporate Root User.
Enum"DIRECTOR""AUTHORISED_REPRESENTATIVE"
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.
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.
Supported company types - if company type is not listed, please contact our support team to check if the company type can be supported.
Enum"SOLE_TRADER""LLC""PUBLIC_LIMITED_COMPANY""LIMITED_LIABILITY_PARTNERSHIP""NON_PROFIT_ORGANISATION"
The legal address of the company. This information is captured via the Due Diligence (KYB) process.
The country of company registration in ISO 3166 alpha-2.
Must be set to true to indicate that the root user has accepted the terms and conditions.
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
Fee groups allow the possibility to charge different fees to users under the same profile. If fee groups are not required, ignore this field.
The time when the Corporate was created, expressed in Epoch timestamp using millisecond precision.
Indicates the type of corporate entity based on its retail status.
Enum"RETAIL""NON_RETAIL""UNKNOWN"
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 corporate's source of funds.
Enum"LABOUR_CONTRACT""CIVIL_CONTRACT""RENT""FUNDS_FROM_OTHER_AUXILIARY_SOURCES""SALE_OF_MOVABLE_ASSETS""SALE_OF_REAL_ESTATE""ORDINARY_BUSINESS_ACTIVITY""DIVIDENDS""LOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONS""LOAN_FROM_THIRD_PARTIES"
Response
application/json
{ "id": { "type": "CONSUMER", "id": "string" }, "profileId": "string", "tag": "string", "rootUser": { "id": { … }, "name": "string", "surname": "string", "email": "user@example.com", "mobile": { … }, "companyPosition": "DIRECTOR", "active": true, "emailVerified": true, "mobileNumberVerified": true, "dateOfBirth": { … }, "tag": "string", "locale": "en-GB", "brand": "string" }, "company": { "name": "string", "type": "SOLE_TRADER", "registrationNumber": "string", "registeredAddress": { … }, "businessAddress": { … }, "countryOfRegistration": "st", "incorporatedOn": { … } }, "industry": "ACCOUNTING", "sourceOfFunds": "LABOUR_CONTRACT", "sourceOfFundsOther": "string", "acceptedTerms": true, "ipAddress": "string", "baseCurrency": "str", "feeGroup": "string", "creationTimestamp": 0, "retailQualifier": "RETAIL" }
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