Setup

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

Operations

Register a user

Request

Creates a user linked to the logged-in corporate or consumer identity.

Once on-boarded, users have access to all instruments (cards and accounts) of the identity.

Application-specific permissions to limit what each user can view and do need to be implemented in your application.

In order to Create an Authorised User you would need a stepped-up token. Before calling /multi/users you need to step-up ( issue a challenge multi/stepup/challenges/otp/{channel} )

More details on how to step-up a token can be found here Step-Up

Security

auth_token and api-key

idempotency-refstring

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Bodyapplication/jsonrequired

namestring, [ 1 .. 50 ] charactersrequired

The first name of the user.

surnamestring, [ 1 .. 50 ] charactersrequired

The last name of the user.

emailstring, (email)(Email)required

E-mail Address of the user

mobileobject(Mobile)

dateOfBirthobject(Date)

Date of birth of the authorised user.

tagstring, <= 50 characters(Tag)^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

countryOfResidencestring, = 2 characters^[A-Z]+$

localestring, <= 5 characters(UserLocale)^[a-z]{2}(-[A-Z]{2})?$

BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.

Example:"en-GB"

brandstring, <= 25 characters(Brand)^[a-zA-Z0-9]+$

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.

rolesArray of strings(UserPredefinedRole)

Optional roles to assign to the user. For a full description of the permissions associated with each role, see our product documentation.

Items Enum:"CARD_ASSIGNEE""CARDS_MANAGEMENT_ROLE""FUNDS_MANAGEMENT_ROLE""ACCESS_MANAGEMENT_ROLE""ADMIN"

curl -i -X POST \
  https://sandbox.weavr.io/multi/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "name": "string",
    "surname": "string",
    "email": "user@example.com",
    "mobile": {
      "countryCode": "stri",
      "number": "string"
    },
    "dateOfBirth": {
      "year": 1900,
      "month": 1,
      "day": 1
    },
    "tag": "string",
    "countryOfResidence": "st",
    "locale": "en-GB",
    "brand": "string",
    "roles": [
      "CARD_ASSIGNEE"
    ]
  }'

Responses

Success

Headers

request-refstringrequired

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

Bodyapplication/json

idstring^[0-9]+$required

The unique identifier of the user.

identityobject(IdentityId)required

The identity that the user belongs to.

namestring, <= 100 charactersrequired