VEvelopaymentsapi
Users

Register SMS Number

Changed on

Register an Sms number and send an OTP to it

Used for manual verification of a user

The backoffice user initiates the request to send the OTP to the user's sms

The user then reads back the OTP which the backoffice user enters in the verifactionCode property for requests that require it

post/v2/users/registration/sms

Request

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

Request body

smsNumberstring required

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

Example request

{
  "smsNumber": "11235555555"
}

Response

request completed okay

Changes

  • 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

    • 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/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

  • 75bb7af5ae63Revision changes
    • warning

      changed the pattern of the request property from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$