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 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 54 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.2.0, at version v3.

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

13 operations 11 paths 19 schemas 3 GET1 PATCH9 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 3

Weavr Setup API declares 3 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).

  • 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.

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), UserIdentitiesGetResponseSchema (3 properties), Date (3 properties), Mobile (2 properties). Each schema is shown below with its type and property counts.

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

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
Where this information came from

This is an independent, third-party profile of Weavr Setup 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.