Retrieving entity questionnaire answers

When an entity has finished processing, you can retrieve the answers from the custom questionnaire.

If your flow contains a custom questionnaire, 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 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

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

Node.js

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);
});

Javascript

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);
});

Ruby

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

Python

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

200

{
    "status": "success",
    "response": {
        "flowQuestions": [
            "Question 1",
            "Question 2"
        ],
        "flowAnswers": [
            "Answer 1",
            "Answer 2"
        ]
    }
}

400

{
    "statusCode": 400,
    "message": "Error: incorrect applicantId provided"
}