Get a candidate's encrypted SSN

Returns an encrypted SSN for the input candidate_id.

Security

basic_auth

candidate_idstringrequired

The candidate's ID.

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

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="
}