Countries3

Currencies1

Funding6

Funding Manager Private2

Login4

Payee Invitation8

Payee Payment Channels7

Payees12

Payment Audit Service8

Payment Audit Service (Deprecated)8

Payor Hierarchy1

Payors6

Payors Private1

Payouts9

Source Accounts8

Tokens1

Transactions3

Users16

Webhooks5

Users

Get User

Get a Single User by Id.

get/v2/users/{userId}

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

Changed in 8 of the 50 revisions of this API.10424

Jul 13, 202605c3f09fc50a1See the full diff
- ●
  added the new VERIFIED enum value to the mfaStatus response property for the response status 200
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 3, 202112abf05c40fa2See the full diff
- ○
  added the optional property companyName to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property userType to the response with the 200 status
  response-optional-property-added
Sep 25, 2020dd71433847a6318See the full diff
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 401
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 403
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 404
  response-property-type-changed
- ○
  added the optional property errors/items/errorCode to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 404 status
  response-optional-property-added
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 13, 202075bb7af5ae633See the full diff
- ○
  the primaryContactNumber response's property pattern was changed from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$ for the status 200
  response-property-pattern-changed
- ○
  the secondaryContactNumber response's property pattern was changed from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$ for the status 200
  response-property-pattern-changed
- ○
  the smsNumber response's property pattern was changed from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$ for the status 200
  response-property-pattern-changed
Jun 24, 2020aded220b0d7b2See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 404
  response-body-type-changed
- ▲
  the errors/items/ response's property type/format changed from object/ to / for status 404
  response-property-type-changed
This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 28, 20201b2abf26b5d643See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 403
  response-body-type-changed
- ▲
  the errors/items/ response's property type/format changed from object/ to / for status 401
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from object/ to / for status 403
  response-property-type-changed
- ●
  added the new requestParam enum value to the errors/items/locationType response property for the response status 401
  response-property-enum-value-added
- ●
  added the new requestParam enum value to the errors/items/locationType response property for the response status 403
  response-property-enum-value-added
- ●
  added the new requestParam enum value to the errors/items/locationType response property for the response status 404
  response-property-enum-value-added
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 11, 2019a0b19fa311c01See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 15, 2019ced8e167a97c1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history