v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Users

Update User Details

Update the profile details for the given user

When updating Payor users with the role of payor.master_admin a verificationCode is required

post/v2/users/{userId}/userDetailsUpdate

Path parameters

userIdstring uuid required

The UUID of the User.

Request body

primaryContactNumberstring nullable

The main contact number for the user

secondaryContactNumberstring nullable

The secondary contact number for the user

firstNamestring nullable

lastNamestring nullable

emailstring email nullable

the email address of the user

smsNumberstring nullable

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

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

The type of the MFA device

verificationCodestring nullable

<p>Optional property that MUST be suppied when manually verifying a user</p> <p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p>

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "primaryContactNumber": "11235555555",
  "mfaType": "TOTP",
  "smsNumber": "11235555555",
  "secondaryContactNumber": "11235555550",
  "email": "foo@example.com",
  "verificationCode": "123456"
}

Response

request completed okay