---
schema_version: "1"
id: 83b9a08dd5f87c680d043565d71f77c05967af38fa48041d085b071e903ef949
title: Get Assessment Response Summary
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/actions_obj_get_assessment_response_summary.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/actions_obj_get_assessment_response_summary.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 009a9dc1d1d78b389a4118b445d25ff6d566d69e430283ff74488c2b9a9a0717
description: Get Assessment Response Summary makes it easy to use a flow to trigger server-side document generation using Document Generation.
---
# Get Assessment Response Summary

Get Assessment Response Summary makes it easy to use a flow to trigger server-side document generation using Document Generation.

In the Discovery Framework, the responses from an assessment are stored in the AssessmentQuestionResponse object and the form metadata stays in the OmniScript. You can use this invocable action to pass assessment summary data to downstream processes. This invocable action provides summary JSON code that can be consumed in Document Generation workflows to generate documents.

The Get Assessment Response Summary invocable action takes an assessment ID as input to get the OmniScript (OmniProcess) ID, which is used to retrieve the OmniScript. The assessment ID also retrieves the assessment response and merges the response with the OmniScript to create an assessment summary response in the summary JSON code.

This object is available in API version 56.0 and later.

## Supported REST HTTP Methods

**URI**: /services/data/vXX.X/actions/standard/getAssessmentResponseSummary

Where XX.X is the latest API version.

**Formats**: JSON

**HTTP Methods**: POST

**Authentication**: Authorization: Bearer TOKEN

Where TOKEN is a variable.

## Inputs

| Input | Type | Description |
| --- | --- | --- |
| assessmentId | ID | Required. The ID of the assessment record for which to summarize responses. |

## Outputs

| Output | Type | Description |
| --- | --- | --- |
| assessmentResponseSummary | string | A JSON string containing the summary assessment question texts and responses for the specified assessment record. The response summary structure follows the structure of the OmniScript. |

## Usage

**Sample Input**

When exposing the Get Assessment Response Summary invocable action in a REST API, you can use the following format to pass input, which includes the assessmentId and its value.

{
  "inputs" : \[ {"assessmentId" : "0U3RO00000005FN0AY"} \]
}

**Sample Output**

In this example, the first line indicates the OmniScript type, subtype, and language. For each step, there are multiple questions that appear in the OmniScript. You can use this information in a downstream process, such as PDF file rendering using Document Generation.

  "KYC\_Individual\_English": {
    "Step1": {
      "label": "Identity Details",
      "value": {
        "LC\_Survey\_Question\_2": {
          "label": "Full Name",
          "value": "Joe Smith"
        },
        "DateofBirth\_m": {
          "label": "Date of Birth",
          "value": "Thu Jul 27 00:00:00 GMT 2000"
        },
        "Gender\_m": {
          "label": "Gender",
          "value": "Female"
        },
        "EmailAddress\_m": {
          "label": "Email Address",
          "value": "Joe.Smith@company.com"
        },
        "PAN": {
          "label": "PAN",
          "value": "QWEASDZXC"
        }
      }
    },
    "Step2": {
      "label": "Address Details",
      "value": {
        "Address\_CorrespondenceAdd\_Corporate": {
          "label": "Address of Correspondence",
          "value": "100 Some St, San Francisco, CA 12345, United States"
        },
        "Address\_ContactDetails\_Corporate": {
          "label": "Telephone/Mobile",
          "value": "1616111233"
        },
        "Alternate\_Contact": {
          "label": "Alternate Mobile Number",
          "value": "1911212123"
        }
      }
    },
    "Step3": {
      "label": "Account Declaration",
      "value": {
        "Account\_declaration": {
          "label": "I declare that I have following deposit accounts with your/
other bank's branches :",
          "value": \[
            {
              "Bank": {
                "label": "Bank",
                "value": "Acme1"
              },
              "Branch": {
                "label": "Branch",
                "value": "Mission St"
              },
              "Type\_of\_Account": {
                "label": "Type of Account",
                "value": "Checking"
              },
              "Account\_Number": {
                "label": "Account Number",
                "value": "12345678"
              }
            },
            {
              "Bank": {
                "label": "Bank",
                "value": "Acme2"
              },
              "Branch": {
                "label": "Branch",
                "value": "Mission St"
              },
              "Type\_of\_Account": {
                "label": "Type of Account",
                "value": "Savings"
              },
              "Account\_Number": {
                "label": "Account Number",
                "value": "1234567890"
              }
            }
          \]
        }
      }
    },
    "Step4": {
      "label": "Declaration",
      "value": {
        "Declaration\_m": {
          "label": "The customer declares and certifies that the information in this 
form is true and correct. Any pre-filled sections of this form must be reviewed prior
 to signing and submitting, to ensure the information accurately conveys the new 
account details.",
          "value": "true"
        }
      }
    }
  }
}