Skip to content

SSN

The SSN resource allows you to retrieve a candidate's encrypted SSN.

Note: Access to this endpoint requires an RSA key-pair for encryption. See Configuring Encryption for Candidate SSN Endpoint for information on how to generate encryption keys. Work with your Checkr Customer Success Manager to enable this feature for your account.

Operations

Get a candidate's encrypted SSN

Request

Returns an encrypted SSN for the input candidate_id.

Security
basic_auth
Path
candidate_idstringrequired

The candidate's ID.

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

Responses

Candidate's encrypted SSN

Bodyapplication/json
encrypted_ssnstring

The candidate's SSN: encrypted, then encoded using Base64. Null if no SSN exists for the candidate.

Example:"hyYMhDje9dVUEPKU9myy7OFJ7R27pj0pmlegFlka99I="
Response
{
  "encrypted_ssn": "hyYMhDje9dVUEPKU9myy7OFJ7R27pj0pmlegFlka99I="
}
© Checkr, Inc.