Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Weavr

Weavr Linked Accounts API

The Linked Accounts API from Weavr — 11 operation(s) for linked accounts.

Documentation Provider Profile APIs.io OpenAPI GitHub

Weavr Linked Accounts API is one of 43 APIs that Weavr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Linked Accounts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 14 operations across 11 paths, and defines 35 schemas. It is described by OpenAPI 3.1.0, at version v3.

Requests are made against a single base URL, https://sandbox.weavr.io/multi/backoffice.

14 operations 11 paths 35 schemas 5 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v3
Base URL
https://api.weavr.io/multi
Authentication
API Key, HTTP Bearer
Contact
Weavr
Resource Areas
1

Authentication & Security 2

Weavr Linked Accounts API declares 2 security schemes for authenticating requests. An API key is passed in the header as api-key (api_key). It accepts HTTP bearer tokens (JWT) (auth_token).

  • api_key — The API Key representing your Multi account.
  • auth_token — The authentication token representing the user. This will be included in the login response object.

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 5 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Linked Accounts 14
POST
/linked_accounts
Add a linked account
linkedAccountCreate 1 param body → 200400401403409429500503
GET
/linked_accounts
Get all linked accounts
linkedAccountsGet 9 params → 200400401403429500503default
GET
/linked_accounts/{id}
Get a linked account
linkedAccountGet 1 param → 200400401403404429500503
PATCH
/linked_accounts/{id}
Update a linked account
linkedAccountUpdate 1 param body → 200400401403404429500503
POST
/linked_accounts/{id}/remove
Remove a linked account
linkedAccountRemove 1 param → 204400401403404409429500
POST
/linked_accounts/{id}/block
Block a linked account
linkedAccountBlock 2 params → 204400401403404409429500
POST
/linked_accounts/{id}/unblock
Unblock a linked account
linkedAccountUnblock 2 params → 204400401403404409429500
GET
/linked_accounts/{id}/verifications
Get linked account verifications
linkedAccountVerificationsGet 4 params → 200400401403429500503default
GET
/v1/linked_accounts
Get Linked accounts
getLinkedAccounts → 200400401403429500503default
GET
/v1/linked_accounts/{linked_account_id}
Get Linked account
getLinkedAccountsId 1 param → 200400401403404429500503
PATCH
/v1/linked_accounts/{linked_account_id}
Update a linked account
patchLinkedAccountsId 2 params body → 200400401403404409413422
POST
/v1/linked_accounts/{linked_account_id}/unlink
Unlink a linked account
unlinkLinkedAccountsId 2 params → 200400401403404409413422
POST
/linked_accounts/{account_id}/set
Allows the verification or rejection of a linked account run by specifying the account ID. This operation updates the status of a linked account to either VERIFIED or REJECTED.
linked_accounts_account_id_set 2 params body → 204400default
POST
/linked_accounts/{account_id}/verify
This tool is used to simulate internal verification for linked accounts by Account ID.
linked_accounts_account_id_verify 2 params body → 204400409default

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are LinkedAccount (12 properties), CreateLinkedAccountRequest (8 properties), LinkedAccountVerificationRun (5 properties), LinkedAccountVerificationTransferInstruction (3 properties). Each schema is shown below with its type and property counts.

LinkedAccountVerificationStepStatus
string
CurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties 2 required
StringWrappedTypeId
object
2 properties 2 required
LinkedAccountVerificationRunState
string
LinkedAccountRunRequest
object
1 property
VerifyStepsRequestConflict
object
1 property
ClientInvalidRequest
object
2 properties
LinkedAccountMicroDepositVerification
object
2 properties 1 required
Iban
object
Bank details
2 properties 1 required
SyntaxError
object
Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax error will be provided.
1 property
AccountNumberAndSortCode
object
Bank details
3 properties 2 required
LinkedAccount
object
12 properties 5 required
InstrumentState
string
The state of the instrument indicating what it can and cannot do as follows: - ACTIVE: The instrument is in an active state and can be used in transactions. -…
LinkedAccountVerificationTransferInstruction
object
3 properties 2 required
LinkedAccountVerificationRun
object
5 properties 1 required
VerifyRequestByAccountId
object
2 properties
VerifyStepsRequestConflictErrorCode
string
LinkedAccountRunRequestState
string
VerifyRequestByAccountIdVerificationStep
string
LinkedAccountState
string
The state of the linked account: - PENDINGVERIFICATION: The Linked Account is pending the completion of the required verification steps. - ACTIVE: The Linked A…
ProfileId
string
The profile Id which a specific identity, instrument or transaction type is linked to. Profiles contain configuration and determine behavioral aspects of the n…
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
VerifyRequestByAccountIdVerificationState
string
LinkedAccountVerificationStep
string
MessageValidation
object
2 properties
FieldValidation
object
2 properties
FieldValidationType
string
LinkedAccountProfileId
string
The id of the Linked Account Profile which this instrument is linked to. You can have one or more profiles linked to your application, and these can be used to…
AccountDescriptor
object
Identifier or account number which does not follow either the IBAN or Faster Payment (sort code and account number) format, such as a US bank account identifie…
1 property 1 required
AccountType
string
An account can be of two types, Personal or Business: - PERSONAL means that the account held at the external bank or PSP is registered under the ownership of a…
DefaultError
object
A default error model in case of errors other than 400, 409 or 504.
1 property
Error
object
2 properties
CreateLinkedAccountRequest
object
8 properties 4 required
Tag
string
The tag field is a custom field that can be used to search and filter.
FieldValidationErrors
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-linked-accounts-api-openapi.yml Raw ↑

Other APIs Weavr publishes across the network.

Weavr Access Token API
AE Profile APIs.io
Weavr Access Tokens API
AE Profile APIs.io
Weavr Accounts API
AE Profile APIs.io
Weavr Additional Factors API
AE Profile APIs.io
Weavr Authentication Factors API
AE Profile APIs.io
Weavr Authorised Signatories API
AE Profile APIs.io
Weavr Authorised Users API
AE Profile APIs.io
Weavr Buyer Authorised Users API
AE Profile APIs.io
Weavr Buyers API
AE Profile APIs.io
Weavr Card Payments API
AE Profile APIs.io
Weavr Cards API
AE Profile APIs.io
Weavr Confirmation Challenges API
AE Profile APIs.io
#Linked Accounts
← Back to W APIs
API Details
ID
weavr:weavr-linked-accounts-api
Base URL
https://api.weavr.io/multi
Docs
https://api.weavr.io/products/multi/openapi
Provider
Weavr
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network