Verify Email (verify_email)

Verify an email address for various purposes. The system will send an email to the address containing a security code for verification.

verify_email(verify_email: str, type: str, url_parameters=None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • verify_email (str) – Email address to be verified.
  • type (str) – Purpose of the email verification call.
  • url_parameters – [Optional] Extra parameters that can be attached to the verify email link URL.
  • passthrough (Optional[Any]) – [Optional] Used to pass data through the websocket, which may be retrieved via the echo_req output field.
  • req_id (Optional[int]) – [Optional] Used to map request to response.
Returns:

req_id
Return type:

int

Example

binary.api.verify_email(
    'test@mailinator.com'
    type='account_opening'
)

See also