How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weavr Linked Accounts API

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

Weavr Linked Accounts API is one of 55 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 37 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://sandbox.weavr.io/multi, https://sandbox.weavr.io/payment-run, https://sandbox.weavr.io/simulate/api", "".

14 operations 11 paths 37 schemas 5 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.weavr.io/multi
Authentication
API Key, HTTP Bearer, API Key, API Key, HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 7

Weavr Linked Accounts API declares 7 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). An API key is passed in the header as webhooks-key (webhooks_key). An API key is passed in the header as api-key (apiKey). It accepts HTTP bearer tokens (JWT) (authToken). An API key is passed in the header as programme-key (API_Secret_Key). It accepts HTTP bearer tokens (JWT) (Auth_Token).

  • api-key — An API key defined in your User API Client (or Delegate API Client - this feature is available only to customers enabled with delegation functionality). API Cl…
  • auth_token — The authentication token representing the user. This will be included in the login response object.
  • webhooks_key — The Webhooks key can be found in the API Credentials tab in your Portal Page.
  • apiKey — The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page.
  • authToken — The authentication token representing the user. This will be included in the login response object.
  • API_Secret_Key — The API Secret Key - available from the Configuration area of the Innovator Portal
  • Auth_Token — Authorization Token returned by login - example format: e6YrWi53lW0Bb6TbBL4ADA==

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 37

The contract defines 37 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.

LinkedAccountVerificationStep
string
StringWrappedTypeId
object
2 properties 2 required
CreateLinkedAccountRequest
object
8 properties 4 required
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…
CurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties 2 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
Iban
object
Bank details
2 properties 1 required
Error
object
2 properties
LinkedAccountVerificationStepStatus
string
LinkedAccount
object
12 properties 5 required
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
Tag
string
The tag field is a custom field that can be used to search and filter.
AccountNumberAndSortCode
object
Bank details
3 properties 2 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. -…
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…
LinkedAccountVerificationRun
object
5 properties 1 required
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
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…
LinkedAccountVerificationTransferInstruction
object
3 properties 2 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…
LinkedAccountVerificationRunState
string
LinkedAccountMicroDepositVerification
object
2 properties 1 required
FieldValidationType
string
FieldValidation
object
2 properties
ClientInvalidRequest
object
2 properties
VerifyRequestByAccountIdVerificationStep
string
LinkedAccountRunRequestState
string
VerifyRequestByAccountIdVerificationState
string
VerifyStepsRequestConflictErrorCode
string
FieldValidationErrors
object
2 properties
VerifyStepsRequestConflict
object
1 property
DefaultError
object
A default error model in case of errors other than 400, 409 or 504.
1 property
LinkedAccountRunRequest
object
1 property
VerifyRequestByAccountId
object
2 properties
MessageValidation
object
2 properties
LinkedAccountEventType
string
LinkedAccountEvent
object
3 properties 3 required

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
Weavr Access Tokens API
Weavr Accounts API
Weavr Additional Factors API
Weavr Authentication Factors API
Weavr Authorised Signatories API
Weavr Authorised Users API
Weavr Buyer Authorised Users API
Weavr Buyers API
Weavr Card Payments API
Weavr Cards API
Weavr Confirmation Challenges API
Where this information came from

This is an independent, third-party profile of Weavr Linked Accounts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.