Developer Centre
Platform LoginStatus
  • Getting started
    • Integration types
    • Generating an authentication token
    • Using basic authentication
  • Applicants
    • Creating an applicant
    • Generating a verification link
    • Uploading documents to an applicant
      • Supported Documents and Types
    • Requesting to start the verification process
  • Applicant Results
    • Retrieving applicant verification results
      • Understanding applicant rejection labels
      • Setting up a webhook
    • Downloading verified documents
  • Entities
    • Check types and coverage
    • Creating an entity
    • Generating a verification link
    • Uploading documents to an entity
      • Supported Documents and Types
    • Linking a UBO to an entity
    • Requesting to start the verification process
  • Entity Results
    • Retrieving entity verification results
      • Understanding entity rejection labels
      • Setting up a webhook
    • Retrieving entity ownership structures
    • Retrieving entity questionnaire answers
  • Anti-Money Laundering
    • Retrieving AML results
  • Database Verification
    • Applicants
      • Verifying applicant identity data
    • Entities
      • Verifying entity information
  • Pages
    • Overview
    • Creating a Page
    • Verifying with Pages
  • Domain Names
    • Overview
    • Linking your domain
  • Flow Logic
    • Overview
  • Workspaces
    • Switching Workspaces
  • Modules
Powered by GitBook
On this page

Was this helpful?

  1. Entity Results

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"'
var axios = require('axios');
var FormData = require('form-data');
var data = new FormData();
data.append('applicantId', '4242424242424x424242424242424242');

var config = {
  method: 'post',
maxBodyLength: Infinity,
  url: 'https://enterprise.personr.co/api/1.1/wf/api-entity-questionnaire',
  headers: { 
    ...data.getHeaders()
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});
var form = new FormData();
form.append("applicantId", "4242424242424x424242424242424242");

var settings = {
  "url": "https://enterprise.personr.co/api/1.1/wf/api-entity-questionnaire",
  "method": "POST",
  "timeout": 0,
  "processData": false,
  "mimeType": "multipart/form-data",
  "contentType": false,
  "data": form
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
require "uri"
require "net/http"

url = URI("https://enterprise.personr.co/api/1.1/wf/api-entity-questionnaire")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
form_data = [['applicantId', '4242424242424x424242424242424242']]
request.set_form form_data, 'multipart/form-data'
response = https.request(request)
puts response.read_body
import requests

url = "https://enterprise.personr.co/api/1.1/wf/api-entity-questionnaire"

payload={'applicantId': '4242424242424x424242424242424242'}
files=[

]
headers = {}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

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"
        }
    ]
}
{
    "statusCode": 400,
    "message": "Error: incorrect applicantId provided"
}
PreviousRetrieving entity ownership structuresNextRetrieving AML results

Last updated 7 months ago

Was this helpful?