Verify that the provided code matches One-Time Passcode (OTP) sent via Email during /email-otps.
POST {{baseUrl}}/email-otps
Take in and code in the request body. It checks if the provided
code matches the one-time password generated for the OTP request and
returns the result.
This API is mandatory.
Request Body
{"emailAddress"=>"john.dunne@domain.com", "locale"=>"en-US", "countryCode"=>"US", "userConsent"=>"ACCEPT", "pds"=>"ZGZnZGVmZ2RnZGVnZXJnZXJncmRnZXJ5aGdld3J0eWJld3J5dHdleXd5d3l3cmFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh", "sdkAuditEvents"=>[{"dateTime"=>"2020-01-28T13:16:01.714-05:00", "softwareVersion"=>"1.0.0", "userProfileId"=>"df52649e-4096-456a-bca0-751ee470009f", "sessionId"=>"123ae1aa-6744-433e-879d-7da48d631234", "transactionGroupId"=>"28eae1aa-6744-433e-879d-7da48d63e89a", "logRequestFlow"=>"CoreSDK-TP", "logEvent"=>"ID Enrollment", "logEventType"=>"User Profile Creation", "osVersion"=>"Android 5.0", "deviceMake"=>"Samsung S10", "type"=>"audit", "audit"=>{"privacyPolicy"=>"1.0.0", "userBiometricConsent"=>"TRUE", "event"=>"Document Scan", "eventType"=>"Enrollment", "result"=>"TRUE", "eventGeneratedSource"=>"CoreSDK", "owner"=>"TP"}}], "tpAuditMetadata"=>{"sessionId"=>"be3ad617-04ad-43e1-a438-79425b6511b6", "transactionGroupId"=>"be3ad617-04ad-43e1-a438-79425b6511b6"}, "arid"=>"a15fa6de-b199-11eb-8529-0242ac130003", "sdkVersion"=>"2.3.0"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-User-Identity | string | JWT token for session validation. Returned as response header in previous API calls with key X-User-Identity. | |
X-Encrypted-Payload | boolean | An indicator that the request is encrypted or indicates that the client is able to receive an encrypted response. If not set, the payload will be treated as plaintext. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"otpId":"47281d64-9784-400f-9dfe-c098e9a92bc6","pds":"ZGZnZGVmZ2RnZGVnZXJnZXJncmRnZXJ5aGdld3J0eWJld3J5dHdleXd5d3l3cmFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh","transactionId":"3a86f4b9-bc2d-4fac-822e-0488aafb8971"}