Serialize Identity Verification Context Action

Returns a JSON array of identity verification field descriptors that an Agentforce agent uses to collect caller answers.

This action is available in API version 68.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/serializeVerificationContext

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
verificationContext	Reference	Required An Apex `id_verification__VerificationContext` record that represents the active identity verification session.

Outputs

Output	Type	Description
verificationFields	Array	A JSON array of verification field descriptors with empty answer placeholders. For example, `[{"label":"Date of Birth","answer":"","developerName":"Birthdate_Field"}]`. The agent populates each answer and passes the array as callerAnswers to the Identity Verification flow.

Example

Sample Request

{
        "inputs": [
        {
        "verificationContext": {
        "processDefinition": {
        "developerName": "StandardIdentityVerification"
        }
        }
        }
        ]
        }

Sample Response

[
        {
        "verificationFields": [
        {
        "label": "Date of Birth",
        "answer": "",
        "developerName": "Birthdate_Field"
        },
        {
        "label": "ZIP Code",
        "answer": "",
        "developerName": "ZipCode_Field"
        }
        ]
        }
        ]