VEvelopaymentsapi
Users

Get User

Changed on

Get a Single User by Id.

get/v2/users/{userId}

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

Path parameters

userIdstring uuid required

The UUID of the User.

Response

Get User Details

idstring uuid

The id of the user

status'ENABLED' | 'DISABLED' | 'PENDING'

The status of the user when the user has been invited but not yet enrolled they will have a PENDING status

emailstring email

the email address of the user

smsNumberstring

The phone number of a device that the user can receive sms messages on

primaryContactNumberstring

The main contact number for the user

secondaryContactNumberstring

The secondary contact number for the user

firstNamestring
lastNamestring
entityIdstring uuid

The payorId or payeeId or null if the user is not a payor or payee user

companyNamestring

The payor or payee company name or null if the user is not a payor or payee user

userType'BACKOFFICE' | 'PAYOR' | 'PAYEE'

Indicates the type of user. Could be BACKOFFICE, PAYOR or PAYEE.

mfaType'SMS' | 'YUBIKEY' | 'TOTP'

The type of the MFA device

mfaStatus'REGISTERED' | 'UNREGISTERED' | 'VERIFIED'

The status of the MFA device

lockedOutboolean

If true the user is currently locked out and unable to log in

lockedOutTimestampstring date-time nullable

A timestamp showing when the user was locked out If null then the user is not currently locked out

Example response

{
  "lastName": "Doe",
  "companyName": "Acme Corp",
  "roles": [
    "payor.admin"
  ],
  "lockedOutTimestamp": "2000-01-23T04:56:07.000+00:00",
  "smsNumber": "11235555555",
  "entityId": "7fffa261-ac68-49e6-b605-d24a444d9206",
  "mfaStatus": "REGISTERED",
  "firstName": "John",
  "primaryContactNumber": "11235555555",
  "mfaType": "TOTP",
  "lockedOut": true,
  "id": "8bbf301c-948f-4445-b411-357eec53e441",
  "userType": "PAYOR",
  "email": "foo@example.com",
  "secondaryContactNumber": "11235555550",
  "status": "ENABLED"
}

Changes

  • 05c3f09fc50aRevision changes
    • warning

      added the new VERIFIED enum value to the response property for the response status

  • 12abf05c40faRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status