v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Reveal employee SSN

Reveal unmasked SSN. Reach out to Check to get support for this feature.

get/employees/{employee}/reveal

Path parameters

employeestring required

The ID of the employee whose SSN you want to reveal

Response

200

idstring

first_namestring

last_namestring

{"stackTrail":"paths:/employees/{employee}/reveal:get:responses:200:content:application/json:schema:properties:middle_name","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/employees/{employee}/reveal:get:responses:200:content:application/json:schema:properties:email","oasType":"schema","type":"unknown"}

dobstring

ssnstring

ssn_last_fourstring

ssn_validation_statusstring

{"stackTrail":"paths:/employees/{employee}/reveal:get:responses:200:content:application/json:schema:properties:payment_method_preference","oasType":"schema","type":"unknown"}

companystring

workplacesstring[]

primary_workplacestring

start_datestring

{"stackTrail":"paths:/employees/{employee}/reveal:get:responses:200:content:application/json:schema:properties:termination_date","oasType":"schema","type":"unknown"}

activeboolean

w2_electronic_consent_providedboolean

metadataobject

Example response

{
  "id": "emp_1ATPRmtf6XBdR6jDa9M5",
  "first_name": "Bob",
  "last_name": "Jones",
  "dob": "1970-05-29",
  "ssn": "123456789",
  "ssn_last_four": "6789",
  "ssn_validation_status": "invalid",
  "onboard": {
    "status": "needs_attention",
    "remaining_steps": [
      "withholdings"
    ],
    "payment_method": [
      "payment_method_preference_set"
    ],
    "withholdings": [
      {
        "id": "jur_KVWAwwuRWhlJoKGuO8sg",
        "name": "California",
        "status": "needs_attention"
      }
    ]
  },
  "company": "com_dsE2Y4wCMg77HGlJB0Mk",
  "workplaces": [
    "wrk_164u8lrvjkdjdssiidd9"
  ],
  "primary_workplace": "wrk_164u8lrvjkdjdssiidd9",
  "start_date": "2019-03-01",
  "active": true,
  "residence": {
    "line1": "630 Bedford Road",
    "city": "Tarrytown",
    "state": "NY",
    "postal_code": "10591",
    "country": "US"
  }
}