POST web_api/securelink/security_codes/{id}/verifications

Verify that the Security Code value given to you by your end user matches the value that was sent to the phone number or email address in the Security Code request.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The SecureLink RequestId value that was returned in the POST request's response body should be included in the GET request's URL to refer to that specific item.	integer	Required

Body Parameters

The SecurityCode value that your user said was sent to their phone number or email address should be included in the request URL.

string

Request 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

The response body will contain a SecureLinkCodeVerificationResult object. Refer to the "Verified" field to see if the Security Code value in your POST request matched to the Security Code value that was sent to the end user. If the "Verified" value is false, see the "ErrorMessage" value to get the reason for the invalid verification.

SecureLinkCodeVerificationResult

Name	Description	Type	Additional information
Verified	Has the code been verified yet?	boolean	None.
ErrorMessage	Only populated if there is an error processing the request	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Verified": true,
  "ErrorMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<SecureLinkCodeVerificationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.giact.com/verificationservices/v5">
  <ErrorMessage>sample string 1</ErrorMessage>
  <Verified>true</Verified>
</SecureLinkCodeVerificationResult>