Retrieve an existing SSN Trace

SSN Trace/

Retrieve an existing SSN Trace

Request

Returns an existing SSN Trace with the input ID.

Security

basic_auth

Path

idstringrequired

ID of the SSN Trace to retrieve.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/ssn_traces/{id}'

Responses

SSN Trace details

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstring

Value:"ssn_trace"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/ssn_traces/539fd88c101897f7cd000001"

statusstring(ScreeningStatusNonReportable)

Status of the screening.

Enum:"complete""pending"

Example:"complete"

resultstring or null

Result of the screening.

Note: The result parameter will always return a null value because this is a non-reportable screening.

Enum:"clear""consider"

Example:null

created_atstring, (date-time)

Time at which the screening was created.

Example:"2014-01-18T12:34:00Z"

completed_atstring, (date-time)

Time at which the screening was completed.

Example:"2014-01-18T12:35:30Z"

turnaround_timeinteger

Number of seconds the screening took to complete, calculated from created_at to completed_at.

Example:90

cancellation_reasonstring

See cancellation reasons section for possible values.

Example:null

cancellation_reason_descriptionstring

See cancellation reasons section for possible values.

Example:null

ssnstring

Candidate’s social security number. This value will be redacted in all return calls, except for the last four digits.

Example:"XXX-XX-4645"

no_databoolean

No data was returned for the input Candidate PII.

Default:false

dob_mismatchboolean

If true, the name on the SSN Trace matches the candidate's provided information, but the DOB does not.

Default:false

name_mismatchboolean

If true, the DOB associated with the addresses returned from the SSN Trace matches the candidate's input DOB, but the name does not.

Default:false

data_mismatchboolean

If true, information returned from the SSN Trace does not match any of the candidate’s provided information.

Default:false

thin_fileboolean

No information found.

Default:false

invalid_issuance_yearboolean

If true, the input SSN has a year of issuance that precedes the candidate's reported year of birth.

Default:false

death_indexboolean

If true, the input SSN is listed on the Social Security Administration's “Death Master File”.

Default:false

ssn_already_takenboolean

If true, another Candidate with same SSN already exists in our system.

Default:false

issued_yearinteger

The year the ID was issued.

Example:1993

issued_statestring

The US state where the ID was issued.

Example:"CA"

addressesArray of any

This field has been deprecated and will return an empty array.

aliasesArray of any

This field has been deprecated and will return an empty array.

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "ssn_trace",
  "uri": "/v1/ssn_traces/539fd88c101897f7cd000001",
  "status": "complete",
  "result": null,
  "created_at": "2014-01-18T12:34:00Z",
  "completed_at": "2014-01-18T12:35:30Z",
  "turnaround_time": 90,
  "cancellation_reason": null,
  "cancellation_reason_description": null,
  "ssn": "XXX-XX-4645",
  "no_data": false,
  "dob_mismatch": false,
  "name_mismatch": false,
  "data_mismatch": false,
  "thin_file": false,
  "invalid_issuance_year": false,
  "death_index": false,
  "ssn_already_taken": false,
  "issued_year": 1993,
  "issued_state": "CA",
  "addresses": [],
  "aliases": []
}