Skip to content

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

Login with password

Request

Authenticate a user with the email and password that they provided when registering.

Given that the user credentials are correct, this returns a token that can then be used to authorise other secured operations. In case the password is expired, a temporary token is returned, which can be used solely for updating the password.

The token returned is valid for 5 minutes from last activity.

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

E-mail Address of the user

passwordobject(SensitivePassword)required

The user's password or passcode used to log in a user. Passwords must be:

  • minimum 8 characters for end-users (Consumers and Corporates); 12 characters for others
  • maximum 30 characters
  • include a lowercase character
  • include an uppercase character
  • include a digit and a special character
  • different from any of the 5 last such passwords used.

For non-PCI compliant integrations, the password submitted must be tokenised.

password.​valuestring(password)<= 100 charactersrequired
curl -i -X POST \
  https://api.weavr.io/_mock/products/multi/openapi/login_with_password \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@example.com",
    "password": {
      "value": "pa$$word"
    }
  }'

Responses

Success

Headers
request-refstringrequired

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

Bodyapplication/json
tokenstring

An authorisation token (valid for 5 minutes from last activity) identifying the user to be used in the auth_token authorization header for secured operations.

tokenTypestring(TokenType)

The auth token received can only be used to access the following endpoints:

  • /identities
  • /access_token
Enum"NO_TYPE""AUTH""ACCESS"
identityobject(IdentityId)

The identity to which the logged-in user belongs to.

credentialsobject(CredentialId)

The unique identifier for the logged-in user.

Response
application/json
{
  "token": "string",
  "tokenType": "NO_TYPE",
  "identity": {
    "type": "CONSUMER",
    "id": "string"
  },
  "credentials": {
    "type": "ROOT",
    "id": "string"
  }
}

Login via biometrics

Request

Trigger a push notification and subsequent biometric authentication of a user, by providing the email that was used in the enrolment process of biometrics.

This endpoint can be used in conjunction with your application to authenticate a user and receive a stepped-up token in a single action, for use in-session for any endpoints or UI components that require step-up authentication.

Given that the user credentials are correct, a push notification is sent to the user requesting them to complete biometric authentication. On successful completion of authentication, a token will be shared that can be used for endpoints or UI components that require a stepped-up token.

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

E-mail Address of the user

identityobject(IdentityId)
curl -i -X POST \
  https://api.weavr.io/_mock/products/multi/openapi/login_via_biometrics \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@example.com",
    "identity": {
      "type": "CONSUMER",
      "id": "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
challengeIdstring

The unique identifier of a Biometric challenge.

Response
application/json
{
  "challengeId": "string"
}

Get user identities

Request

Retrieves a list of identities available to the holder of the token.

Security
(auth_token and api-key) or api-key
Query
offsetinteger>= 0

The number of results to skip from the beginning of the dataset.

limitinteger[ 1 .. 100 ]

The maximum number of identities to return.

curl -i -X GET \
  'https://api.weavr.io/_mock/products/multi/openapi/identities?offset=0&limit=1' \
  -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
identitiesArray of objects(UserIdentity)required

The list of identities available to user.

identities[].​idobject(IdentityId)required

The unique identifier of the Corporate Identity.

identities[].​id.​typestringrequired

Indicates the identity type.

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

The identifier for the identity.

identities[].​namestringrequired

The name of the company.

countinteger(int32)required

The total number of records (excluding the paging limit).

responseCountinteger(int32)required

The total number of records returned in this response (always capped at 100).

Response
application/json
{
  "identities": [
    { … }
  ],
  "count": 0,
  "responseCount": 0
}

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

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