Api Function Name

dp_45000_setup_2fa_send_email

This API is Live

This API is used during the 2fa setup process when the user wants to create/activate 2fa on their account using the EMAIL method.

This API is created to prove we can send Emails to the user’s email account.

This API will then send the user the email containing a 6 digit code.

End Point URL

The url end point is: https://api.arcticspascore.com/live/

Parameters

action Type Example Required Description
action varchar dp_45000_setup_2fa_send_email yes
session_token varchar 123abc yes

This will be the session token of the logged in user.

We will get the email address from the users session.
email email joe@bloggs.com yes

This will be the email where we send the verification code.

Response Codes

Response Code Response Message
45000 session_token was empty
45001 session_token is not valid
45002 email cannot be empty
45003 email address is not valid format
45004 error connecting to email gateway
45005 error sending email {$mailgun_message}
45999 email sent to {$email}

Example Responses

Response Code Response Format Example
45999 json 
{
    "MainResponse": {
        "APIName": "Arctic Spas Core Live API",
        "APIFunctionName": "dp_45000_setup_2fa_send_email",
        "HttpResponseCode": 200,
        "RequestID": 1669410,
        "QueryDateTimeGMT": "2022-06-06 19:40:07",
        "ResponseTime": 0.69470500946044921875,
        "ResponseCode": 45999,
        "ResponseMessage": "email sent to joe@bloggs.com"
    },
    "Code": 860166,
    "CodePart": "8****6",
    "CodePartText": "Your code starts with 8 and ends in 6"
}