Overview
Sterling uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate a success, codes in the 4xx range indicate a request that failed given the information provided (e.g. a required parameter was omitted, format issues, etc.), and codes in the 5xx range indicate an error with Sterling's servers.
When a request is valid but does not complete successfully, we return a 400# error code. Below you'll find more detailed information about the possible errors you can expect.
Error Format
The expected format for an error is as follows:
Error Format
{ "code": "400#[optional-object]?[optional-reason]", "message": "[optional-message]" }
ErrorCode Format
- Example: 400#dob?format
- HTTP error code (i.e.
400#) - Offending field when relevant (e.g.
dob) - Brief message when applicable (e.g.
formatorrequired)
ErrorMessage Format
- The error message provides more context as to why the error occurred (e.g.
"message": "dob must be in the format of YYYY-MM-DD")
Example:
{
"code": "400#dob?format",
"message": "dob must be in the format of YYYY-MM-DD"
}Since the error
messagecan change from time to time, we highly recommend you key off of the errorcodeif you plan implement any automation for errors.
Candidate Validation Errors
Required Fields
code | reason |
|---|---|
| addressLine is required if address is present |
| countryCode is required if address is present |
| postalCode is required if address is present |
| Candidate is missing required field for identity verification: address.city |
| Candidate is missing required field for identity verification: address.addressLine |
| Candidate is missing required field for identity verification: address.state |
| Candidate is missing required field for identity verification: address.zip |
| Candidate is missing required field for identity verification: dob |
| Candidate is missing required field for package: dob |
| Candidate is missing required field for package: middleName (or confirmedNoMiddleName set to true) |
Examples
Error Message
{
"errors": [
{
"code": "400#givenName",
"message": "givenName is required"
}
]
}Solution
Include the "givenName" field in the candidate object:
{
//...
"givenName": "John",
//...
}Error Message
{
"errors": [
{
"code": "400#address.addressLine",
"message": "if address is provided, addressLine is required"
}
]
}Solution
In the "address" sub-object, include a "addressLine" field:
{
//...
"givenName": "John",
//..
"address": {
"addressLine": "123 Example Street",
"municipality": "ATLANTA",
//..
}
}Format Validation Errors
code | reason |
|---|---|
| dob must be in the format of YYYY-MM-DD |
| ssn is not in the expected format |
| phone is not in the expected format |
| email is not in the expected format |
| regionCode format |
| postalCode format |
| countryCode format |
Screening Errors
code | reason |
|---|---|
| An adverse action has already been initiated for this screening |
| Adverse Action has not been configured for this account |
| Screening is not eligible for adverse action at this time |
| This report does not allow you to include the reason for initiating Adverse Action. Please remove the reportItemId(s) and resubmit. |
| clientReferenceId already in use |
| email already in use |
| Trusted identifier already assigned to this candidate |
| fileName is required |
| fileName is required |
| licenseNumber is not in the expected format |
| issuingAgency is not in the expected format |
| Too many incorrect answers |
| Answer given for questionId {1-4} does not match any option |
| Candidate {id} is missing required field for identity verification: address.city |
| Candidate {id} is missing required field for identity verification: address.addressLine |
| Candidate {id} is missing required field for identity verification: address.state |
| Candidate {id} is missing required field for identity verification: address.postalCode |
| Retry limit exceeded |
| candidateId must be a valid candidateId associated with the authenticated account |
| All kba questions must be answered |
| candidateId must be a valid candidateId associated with the authenticated account |
| packageId must be an active packageId associated with the authenticated account |
| trusted user must be a valid, active trusted user |
| documentType must be one of: [end-user-agreement, disclosure-and-authorization] |
| party must be one of: [candidate, trusted-user] |
| candidateId must be a valid candidateId associated with the authenticated account |
| Invalid value some-bad-value in field: ticketing |
| documentType must be one of: [end-user-agreement, disclosure-and-authorization] |
| trusted user must be a valid, active trusted user |
| party must be one of: [candidate, trusted-user] |
| schedule.startAt must be a UTC time with date, hours, and minutes, like 2016-10-30T20:00:00.000Z |
| A subscription already exists for this candidate and package |
| schedule.endAt must be a UTC time with date, hours, and minutes, like 2016-10-30T20:00:00.000Z |
| A subscription already exists for this candidate and package |
| Candidate {id} is missing required field for package {id}: dob. |
| Candidate {id} is missing required field for package {id}: middleName. |
| Trusted identifier already assigned to this candidate |
| identity id must belong to a verified identity |