Skip to content

Candidate Stories

Candidate Stories allows candidates with records the opportunity to share additional context about themselves and their background checks. Once submitted, these stories will be available to customers in the candidate’s report in the Checkr Dashboard.

For more information, please see Candidate Stories: Improving understanding of the past and present in the Checkr Help Center.

Operations

Retrieve a Candidate Story

Request

Returns the existing Candidate Story corresponding to the input ID.

Security
basic_auth
Path
idstringrequired

ID of the Candidate Story.

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

Responses

Candidate Story details

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"
objectstringread-only
Value:"candidate_story"
uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/candidate_stories/e44aa283528e6fde7d542194"
report_idstring

ID of the Report to which the Candidate Story is linked.

Example:"af3393b7d751206c7c67b6e5"
recordobject or null

Simplified representation of linked record. If null, Candidate Story is considered general information about the Candidate.

contentstring

Additional information provided by Candidate.

Example:"Since my case, I have received the following certifications (see attachments)"
created_atstring, (date-time)

Time at which the Candidate Story was created.

Example:"2020-04-17T07:48:34Z"
documentsArray of objects(CandidateStoryDocument)

Attached documents provided by Candidate.

Response
{
  "id": "e44aa283528e6fde7d542194",
  "object": "candidate_story",
  "uri": "/v1/candidate_stories/e44aa283528e6fde7d542194",
  "report_id": "af3393b7d751206c7c67b6e5",
  "record": {
    "id": "4e2a551f79e0095b35d4d3ca",
    "case_number": "NMND78D",
    "charge": "LIGHT OFFENSE",
    "offense_date": "2020-01-20",
    "location": "San Mateo, CA"
  },
  "content": "Since my case, I have received the following certifications (see attachments)",
  "created_at": "2020-04-17T07:48:34Z",
  "documents": [
    { … }
  ]
}
© Checkr, Inc.