Validates caller-provided answers against the active identity verification
session and returns whether verification succeeded.
This action is available in API version 68.0 and later.
Supported REST HTTP Methods
URI: /services/data/vXX.X/actions/standard/validateIdVerifAnswers
Where XX.X is the latest API version.
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer TOKEN
Where TOKEN is your OAuth access token.
Inputs
| Input | Type | Description |
|---|---|---|
| callerAnswers | Array | Required A JSON array of caller-provided answers, where each object contains label, answer, and developerName properties. |
| verificationContext | Reference | Required The identity verification context, which is updated with verifiers upon output. |
Outputs
| Output | Type | Description |
|---|---|---|
| verificationSuccessful | Boolean | Indicates whether all caller-provided answers match the active identity verification session. |
Example
Sample Request
{
"inputs": [
{
"verificationContext": {
"processDefinition": {
"developerName": "StandardIdentityVerification"
}
},
"callerAnswers": [
{
"label": "Date of Birth",
"answer": "1985-03-22",
"developerName": "DateOfBirth"
},
{
"label": "ZIP Code",
"answer": "94105",
"developerName": "ZipCode"
}
]
}
]
}
Sample Response
[
{
"verificationSuccessful": true,
"verificationContext": {
"isSuccess": true,
"verifiedResult": {
"verifiers": [
{
"developerName": "DateOfBirth",
"verificationState": "Verified"
},
{
"developerName": "ZipCode",
"verificationState": "Verified"
}
]
}
}
}
]