generateEmailVerificationCode
You can use this method to send a verification code to a specific email address and verify that a user has access to it. This is done to allow the email to be used as contact information or to be assigned to a specific account.
If successful, the request generates an 8 digits code and sends it to the specified email address.
Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
String | No | The email address where the verification code will be sent. | |
purpose | Integer | No | Determines the purpose of the verification code. Possible values:
|
Return value
If successful, this method returns a String attribute, result
, which will always have the null
value.
Examples
Request:
{ "params": { "email" : "[email protected]", "purpose": 1 }, "jsonrpc": "2.0", "method": "generateEmailVerificationCode", "id": "60357f0e-94da-463c-ba36-f50f2ef8c34f" }
Response:
{ "id":"60357f0e-94da-463c-ba36-f50f2ef8c34f", "jsonrpc":"2.0", "result": null }