For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieving entity questionnaire answers

When an entity has finished processing, you can retrieve the answers from the questionnaire, product, and plan selection logic blocks.

If your flow contains a questionnaire or product and plan logic block using Flow Logic, use this endpoint to retrieve the answers inputted by the entity during the verification process.


Retrieving questionnaire answers

POST /api-entity-questionnaire

Retrieve entity questionnaire, product, and plan selection answers.

Name
Value

Content-Type

multipart/form-data

Authorization

Bearer YOUR_TOKEN

Body

Name
Type
Description

applicantId

string

Unique applicantId generated on entity creation (required)

Request

curl --location 'https://enterprise.personr.co/api/1.1/wf/api-entity-questionnaire' \
--form 'applicantId="4242424242424x424242424242424242"'

Response

{
    "applicantId": "1726733114679x00000000000",
    "flow": "Example Flow",
    "sourceKey": "Example Source Key",
    "externalUserId": [
    "Example External User ID", 
    "Another External User ID"
    ],
    "selectedProducts": [
    "Product A"
    ],
    "selectedProductIds": [
    "ProductA-20394"
    ],
    "selectedPlans": [
    "Plan A"
    ],
    "selectedPlanIds": [
    "Plan A-20394"
    ],
    "questionnaire": [
        {
            "flowQuestion": "Example Question",
            "questionId": "1724124467705x000000000000",
            "internalQuestionId": "Example Internal Question ID",
            "flowAnswer": [
                "No",
                "Yes"
            ]
        },
        {
            "flowQuestion": "Another Example Question",
            "questionId": "1724124485940x00000000000",
            "internalQuestionId": "Example Internal Question ID",
            "flowAnswer": "Yes"
        }
    ]
}

Last updated

Was this helpful?