Skip to content
/
Get a user

Get a user

Request

Retrieves the user identified by the user_id path parameter.

Security
auth_token and api-key
Path
user_idstring(UserId)^[0-9]+$required

The unique identifier for the user.

curl -i -X GET \
  'https://sandbox.weavr.io/multi/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

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

The first name of the user.

surnamestring, <= 100 charactersrequired

The last name of the user.

emailstring, (email)(Email)required

E-mail Address of the user

mobileobject(Mobile)
activebooleanrequired

The state of the user. If the active attribute is false, then the user will not be able to log in.

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)
Items Enum:"CARD_ASSIGNEE""CARDS_MANAGEMENT_ROLE""FUNDS_MANAGEMENT_ROLE""ACCESS_MANAGEMENT_ROLE""ADMIN"
Response
{
  "id": "string",
  "identity": {
    "type": "CONSUMER",
    "id": "string"
  },
  "name": "string",
  "surname": "string",
  "email": "user@example.com",
  "mobile": {
    "countryCode": "stri",
    "number": "string"
  },
  "active": true,
  "dateOfBirth": {
    "year": 1900,
    "month": 1,
    "day": 1
  },
  "tag": "string",
  "countryOfResidence": "st",
  "locale": "en-GB",
  "brand": "string",
  "roles": [
    "CARD_ASSIGNEE"
  ]
}