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

Weavr Setup API

Register and manage the lifecycle of users that can access an identity, including authorised users invited by a Corporate or Consumer root user.

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

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

This API exposes 13 operations across 11 paths, and defines 19 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.

13 operations 11 paths 19 schemas 3 GET1 PATCH9 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
Resource Areas
1

Authentication & Security 2

Weavr Setup 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 13

Across 11 paths, the API surfaces 13 operations — 3 GET, 1 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Setup 13

Register and manage the lifecycle of users that can access an identity, including authorised users invited by a Corporate or Consumer root user.

POST
/users
Register a user
userCreate 1 param body → 200400401403404409429500
GET
/users
Get all users
usersGet 6 params → 200400401403404429500503
GET
/users/{user_id}
Get a user
userGetById 1 param → 200400401403404429500503
PATCH
/users/{user_id}
Update a user
userUpdate 2 params body → 200400401403404409429500
GET
/identities
Get linked identities
userIdentities 2 params → 200400401403404409500503
POST
/users/{user_id}/invite
Invite a user to become an authorised user
userInviteSend 2 params → 204400401403404409429500
POST
/users/{user_id}/invite/validate
Validate a user's invite
userInviteValidate 1 param body → 204400401403404409429500
POST
/users/{user_id}/invite/consume
Consume a user's invite
userInviteConsume 2 params body → 200400401403404409410429
POST
/users/verification/email/send
Send an email verification code to a user
authorisedUserEmailVerificationCodeSend 1 param body → 204400401404409429500503
POST
/users/verification/email/verify
Verify email of the authorised user
authorisedUserEmailVerify body → 204400401403409429500503
POST
/users/{user_id}/deactivate
Deactivate an authorised user
userDeactivate 1 param → 204400401403404429500503
POST
/users/{user_id}/activate
Reactivate an authorised user
userActivate 1 param → 204400401403404429500503
POST
/users/kyc
Start KYC to elevate an authorised user to signatory
userKyc → 200400401403404409500503

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are User (13 properties), Date (3 properties), UserIdentitiesGetResponseSchema (3 properties), IdentityId (2 properties). Each schema is shown below with its type and property counts.

Brand
string
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.
UserId
string
Date
object
3 properties 3 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
TokenError
object
The used token is expired or not found
1 property
UserLocale
string
BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
SensitivePassword
object
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 ot…
1 property 1 required
VerificationCode
string
A randomly generated one-time use code used to verify the user's email address or mobile number.
Nonce
string
A randomly generated one-time use code.
Email
string
E-mail Address of the user
UserIdentity
object
2 properties 2 required
IdentityId
object
2 properties 2 required
TokenResponse
object
1 property
Mobile
object
2 properties 2 required
UserIdentitiesGetResponseSchema
object
3 properties 3 required
User
object
13 properties 6 required
UserPredefinedRole
string
Error
object
2 properties
Tag
string
The tag field is a custom field that can be used to search and filter.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-setup-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