POST web_api/securelink/security_codes/email
Submit a new SecureLink Security Code request via Email. An out-of-band secret code is sent to the end user; the code is not exposed to the API consumer.
Request Information
URI Parameters
None.
Body Parameters
The email address to send the Security Code to should be included in the request body.
stringRequest Formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A object containing the RequestId needed to check verification status via the GET action.
SecureLinkRequestResult| Name | Description | Type | Additional information |
|---|---|---|---|
| SecureLinkRequestId |
The SecureLink RequestId value that you will use to retrieve the result of the user response |
integer |
None. |
| ErrorMessage |
Only populated if there is an error processing the request |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"SecureLinkRequestId": 1,
"ErrorMessage": "sample string 1"
}
application/xml, text/xml
Sample:
<SecureLinkRequestResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.giact.com/verificationservices/v5"> <ErrorMessage>sample string 1</ErrorMessage> <SecureLinkRequestId>1</SecureLinkRequestId> </SecureLinkRequestResult>