Retrieve the results

PreviousSend your first request NextManage your team

Last updated 1 year ago

Retrieve the results

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

Request

The results you got from the Softcheck quickscreen creation call indicate that we have received your request and are actively working on it. You can see this by checking the report_status field, which will likely be marked as ANALYZING. These results will not be updated in real-time. To retrieve the updated versions, you can set up a , 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. Once it is, 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 send back, 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 , 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 the URL.

Choose the URL that corresponds to your industry
In the URL, replace <applicationID> with your application's ID

"https://demo-api.certn.co/hr/v1/applicants/<applicationID>"

"https://demo-api.certn.co/api/v2/applicants/<applicationID>"

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:

import requests
import json

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

# Gets the application ID from the previous request
with open("softcheckDemo.json") as f:
  softcheckResponse = json.load(f)
  
applicationID = softcheckResponse['id']

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


### Replace <token> with your API Key
headers = { "Authorization": "Bearer <token>" }

### Replace <URL> with the URL that corresponds to your industry and
### append the application ID
url = "<URL>"

# Sends 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 "resultsSoftcheckDemo.json"
with open("resultsSoftcheckDemo.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 resultsSoftcheckDemo.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

Here are some errors you may encounter when doing this exercise, and how to fix them.‌

401 Unauthorized

403 Forbidden

404 Not found

You may receive a 404 Not found if:‌

The application ID couldn't be found

"detail": "Not found."

The application ID is a string of letters

<HTML Page> NOT FOUND

How to fix this issue

PreviousSend your first request NextManage your team

Last updated 1 year ago

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

Request

Choose your endpoint

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

Set up your URL

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

Choose the URL that corresponds to your industry
In the URL, replace <applicationID> with your application's ID

"https://demo-api.certn.co/hr/v1/applicants/<applicationID>"

"https://demo-api.certn.co/api/v2/applicants/<applicationID>"

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:

import requests
import json

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

# Gets the application ID from the previous request
with open("softcheckDemo.json") as f:
  softcheckResponse = json.load(f)
  
applicationID = softcheckResponse['id']

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


### Replace <token> with your API Key
headers = { "Authorization": "Bearer <token>" }

### Replace <URL> with the URL that corresponds to your industry and
### append the application ID
url = "<URL>"

# Sends 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 "resultsSoftcheckDemo.json"
with open("resultsSoftcheckDemo.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 resultsSoftcheckDemo.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

Here are some errors you may encounter when doing this exercise, and how to fix them.‌

401 Unauthorized

Find this error in .

403 Forbidden

Find this error in .

404 Not found

You may receive a 404 Not found if:‌

The application ID couldn't be found

"detail": "Not found."

The application ID is a string of letters

<HTML Page> NOT FOUND

How to fix this issue

Append your to the end of the URL and make sure it is in the proper format.

Error codes