Resources

Resource articles about Certn API application parameters, regional codes, error codes, and report field mappings.

Package settings

Package settings are optional settings which relate to types of checks. These can be defined when running a check or when setting up a package of checks to run later.

Package settings

settings field

Relevant Check

Notes

requested_countries

optional, default superteam country. Accepts ISO country code format.

us_criminal_record_check_years

optional, default team setting

employer_questionaire_id

employer_references_min

employer_references_max

employer_references_years

employer_references_years_or_individually

optional, default "INDIVIDUALLY". One of: "YEARS", or "INDIVIDUALLY"

address_questionaire_id

address_references_min

address_references_max

address_references_years

address_references_years_or_individually

optional, default "INDIVIDUALLY". One of: "YEARS", or "INDIVIDUALLY"

employment_verification_min

employment_verification_max

employment_verification_years

employment_verification_years_or_individually

optional, default "INDIVIDUALLY". One of: "YEARS", or "INDIVIDUALLY"

education_verification_min

education_verification_max

education_verification_level

optional, default "ALL". One of: "ALL", or "HIGHEST".

credential_verification_min

credential_verification_max

credential_verification_level

optional, default "ALL". One of: "ALL", or "HIGHEST".

optional, default ""

volunteer_organization

optional, default ""

role_or_position_title

optional, default ""

optional, one of #employment_sector-values

Error codes

A list of API error codes and how to fix them.

400 Bad Request

You may receive a 400 Bad Request if:‌

There are issues in the body of your request

A required field is missing.

"information": { "addresses": ["This field is required."] }

How to fix this issue

Add all the required fields to the body of your request.

You used the wrong format or data type for a field.

"city": ["Not a valid string."]

How to fix this issue

Format all your fields according to their data type.

There's an issue with your account

Your account isn't configured to run this check or your account does not have payment configured.

"request_equifax": ["Account not configured to \"request_equifax\".
 Please contact support@certn.co to update your plan."]

How to fix this issue

Contact our support team to have your account configured for this check or to confirm that your payment method is correctly configured.

For a demo account, use this payment method.

Something is preventing your request from completing

You tried to generate a report, but the application is still processing.

"non_field_errors": ["Cannot generate report for incomplete hr applicant."]
or
"non_field_errors": ["Cannot generate report for incomplete applicant."]

How to fix this issue

Wait for the application's status field to show Returned before generating the final report.

You requested a check with a min and a max but set your min value to a number greater than your max value.

"non_field_errors": [
    "employer_references_max must be greater than employer_references_min."
]

How to fix this issue

Edit the request's check settings to make sure that any min values are less than or equal to the corresponding max values.

401 Unauthorized

You may receive a 401 Unauthorized if:‌

Your authorization header is missing or incorrect

You sent your request without an authorization header.