Invite a User

Create a User and invite them to the system

post/v2/users/invite

Request body

emailstring email required

the email address of the invited user

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

<p>The MFA type that the user will use</p> <p>The type may be conditional on the role(s) the user has</p>

smsNumberstring required

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

primaryContactNumberstring required

The main contact number for the user

secondaryContactNumberstring nullable

The secondary contact number for the user

rolesstring[] required

The role(s) for the user The role must exist The role can be a custom role or a system role but the invoker must have the permissions to assign the role System roles are: velo.backoffice.admin, velo.payor.master_admin, velo.payor.admin, velo.payor.support, velo.payee.admin, velo.payee.support

firstNamestring

lastNamestring

entityIdstring uuid nullable

The payorId or payeeId or null if the user is a backoffice admin

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

Will default to PAYOR if not provided but entityId is provided

verificationCodestring nullable

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

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "primaryContactNumber": "11235555555",
  "mfaType": "TOTP",
  "roles": [
    "velo.payor.admin"
  ],
  "smsNumber": "11235555555",
  "entityId": "7fffa261-ac68-49e6-b605-d24a444d9206",
  "userType": "PAYEE",
  "email": "foo@example.com",
  "secondaryContactNumber": "11235555550",
  "verificationCode": "123456"
}

Response

No Content. The user was invited successfully

Changes

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

Nov 3, 202112abf05c40fa1See the full diff
- ○
  added the new optional request property userType
  new-optional-request-property
Sep 25, 2020dd71433847a6530See the full diff
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 400
  response-property-type-changed
- ▲
  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 409
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 412
  response-property-type-changed
- ○
  added the optional property errors/items/errorCode to the response with the 400 status
  response-optional-property-added
- ○
  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 409 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 412 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 400 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 409 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 412 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 400 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 409 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 412 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 400 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 409 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 412 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/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
- ○
  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
- ●
  changed the pattern of the request property primaryContactNumber from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$
  request-property-pattern-changed
- ●
  changed the pattern of the request property secondaryContactNumber from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$
  request-property-pattern-changed
- ●
  changed the pattern of the request property smsNumber from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$
  request-property-pattern-changed
Jun 24, 2020aded220b0d7b2See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 412
  response-body-type-changed
- ▲
  the errors/items/ response's property type/format changed from object/ to / for status 412
  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
Feb 27, 20207c8cfeb599522See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 409
  response-body-type-changed
- ▲
  the errors/items/ response's property type/format changed from object/ to / for status 409
  response-property-type-changed
This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 28, 20201b2abf26b5d665See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 400
  response-body-type-changed
- ▲
  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 400
  response-property-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 400
  response-property-enum-value-added
- ●
  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 409
  response-property-enum-value-added
- ●
  added the new requestParam enum value to the errors/items/locationType response property for the response status 412
  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