Skip to content
/
Get a user

Get a user

Request

Retrieves the user identified by the user_id path parameter.

Required user role: ADMIN

Security
apiKey and authToken
Path
user_idstring^[0-9]+$required

The unique identifier for the user.

Example:110747174434373672
curl -i -X GET \
  https://sandbox.weavr.io/payment-run/v1/users/110747174434373672 \
  -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.

buyerIdstring^[0-9]+$required

The identifier for the identity.

namestring, <= 100 charactersrequired

The first name of the user.

surnamestring, <= 100 charactersrequired

The last name of the user.

emailstring, (email)required

E-mail Address of the user

mobileobject

Mobile number of the user

activebooleanrequired

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

dateOfBirthobject

Date of birth of the authorised user.

rolesArray of strings, non-emptyrequired

Roles define the level of access assigned to the user.

  • CREATOR: Users assigned this role can create, view and update payment runs.
  • CONTROLLER: Users assigned this role can view and link their company's bank accounts as well as fund payment runs.
Items Enum:"CREATOR""CONTROLLER"
addedByobject
Response
{
  "id": "string",
  "buyerId": "string",
  "name": "string",
  "surname": "string",
  "email": "user@example.com",
  "mobile": {
    "countryCode": "string",
    "number": "string"
  },
  "active": true,
  "dateOfBirth": {
    "year": 1900,
    "month": 1,
    "day": 1
  },
  "roles": [
    "CREATOR"
  ],
  "addedBy": {
    "rolesNames": [ … ],
    "userId": "string"
  }
}