Retrieve the results

You'll need to know how to create an application before you can follow the instructions in this section.

Request

The results you got from the Softcheck quickscreen creation call indicate that we received your request and are actively working on it. You can see this by checking the report_status field, which will likely be ANALYZING. These results will not be updated in real-time. To retrieve the updated versions, you can set up a webhook, or send requests to one of our endpoints.

Choose your endpoint

In this guide, we'll show you how to send requests to our API to retrieve the status of your application via our endpoints. When using this method, keep sending requests until the field report_status is marked as COMPLETE. Then, you can view your final report.

We'll use the /applicants endpoint, which allows you to retrieve the report as a JSON object.

Once your report is ready, you can download it as a PDF or HTML file via our /reports endpoint.

Get your application ID

To tell the API which application to retrieve, you need to provide it with the right application ID. You'll find it in the response of the creation call, under id. We use universally unique identifiers (UUIDs), so it'll be formatted like this:123e4567-e89b-12d3-a456-426614174000

Set up your URL

Once you have your application ID, append it to /applicants URL.

1. Choose the URL that corresponds to your industry

2. In the URL, replace {application_id} with your application's ID

Human Resources

applicant_url = f"https://demo-api.certn.co/api/v1/hr/applicants/{application_id}/"

Property Management

applicant_url = f"https://demo-api.certn.co/api/v1/pm/applicants/{application_id}/"

Send the request

Now we're ready to bring it all together. Our /applicants endpoint accepts GET requests, so make sure that is what you use.

Here is what your full script may look like when using Python:

Python

import requests
import json

############### Optional ###############

# Gets the application ID from the previous request
with open("softcheck_demo.json") as f:
  softcheck_response = json.load(f)
  
application_id = softcheck_response.get('id')

############# End Optional ##############

# Use your access token in the header.
headers = { "Authorization": f"Bearer {access_token}" }

# URL to retrieve the applicant details, determined by your industry
url = applicant_url

# Send the HTTP request to the API via GET
result = requests.get(url, headers=headers)

############### Optional ###############

# Brings errors to the forefront
result.raise_for_status()

# Writes the contents of the report to a file 
# named "results_softcheck_demo.json"
with open("results_softcheck_demo.json", "w") as f:
    f.write(result.text)
  
############# End Optional ##############

In the previous example, we saved the results of the call to a new file named results_softcheck_demo.json.‌

With everything set properly and a good internet connection, you should receive a response status of 200 OK.

200 OK

[...] "id": "<number>" [...] "report_status": "COMPLETE" [...]

Errors

Please see Error codes for more details on types of errors, and how to resolve them.

Error codes