VEvelopaymentsapi
Users

Invite a User

Changed on

Create a User and invite them to the system

post/v2/users/invite

Request

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

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

  • 12abf05c40faRevision changes
    • info

      added the new optional request property

  • dd71433847a6Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated