Skip to main content

Overview

Verifies a phone number corresponding to an account that is being created. When creating an account using /Account/Create, the account is at first disabled. This means, it cannot be used actively in the API. To enable an account, you need to verify the e-mail address provided when creating the account. If providing a phone number, you need to verify the phone number as well. If not providing a phone number you can skip this step. The account creation call will send an e-mail with a code to the e-mail address, as well as an SMS to the phone number, if such is provided. The code sent to the phone number needs to be provided in a call to this resource, together with the phone number

HTTP request

POST /Agent/Account/VerifyPhoneNr

Authentication

No authentication required.

Request (JSON)

{
	"phoneNr":Required(Str(PPhoneNr)),
	"code":Required(Int(PCode))
}

Input parameters

ParameterDescription
PPhoneNrPhone number of the user.
PCodeCode sent to the user to verify the phone number.

Response (JSON)

{
	"phoneNr":Required(Str(PPhoneNr)),
	"userName":Required(Str(PUserName))
}

Response parameters

ParameterDescription
PPhoneNrPhone number of the user.
PUserNameUser Name of account.

Notes

This endpoint uses the request schema notation described in Pattern matching.