Create a new Candidate Story

Request

Create a new Candidate Story for the input report_id.

Security

basic_auth

Path

report_idstringrequired

Create an candidate story for the input report_id.

Bodyapplication/jsonrequired

contentstringrequired

Additional information provided by Candidate.

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

record_idstring

ID of the Record existing on a Screening to which the Candidate Story is linked. When no record ID is provided, the Candidate Story is considered General Information.

Example:"af3393b7d751206c7c67b6e5"

documentsArray of objectsrequired

An array of documents to attach to the Candidate Story. Can be empty.

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/reports/{report_id}/candidate_stories' \
  -H 'Content-Type: application/json' \
  -d '{
    "content": "Since my case, I have received the following certifications (see attachments)",
    "record_id": "af3393b7d751206c7c67b6e5",
    "documents": [
      {
        "filename": "evidence_of_rehab.pdf",
        "tempfile": "https://tempfilebucket.aws.example.com/abYwtudnakfnafl",
        "type": "application/pdf"
      }
    ]
  }'

Responses

Candidate Story was successfully created

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": [
    { … }
  ]
}