CHcheckhq

Reveal contractor SSN

Reveal the unmasked SSN of a contractor. Reach out to Check to get support for this feature.

get/contractors/{contractor}/reveal

Request

Path parameters

contractorstring required

The ID of the contractor whose SSN you want to reveal

Response

200

idstring
typestring
companystring
primary_workplaceunknown
first_namestring
middle_nameunknown
last_namestring
business_nameunknown
dobunknown
start_dateunknown
termination_dateunknown
emailunknown
ssnstring
ssn_last_fourstring
ssn_validation_statusstring
payment_method_preferenceunknown
einunknown
metadataobject
1099_nec_electronic_consent_providedboolean

Example response

{
  "id": "ctr_Ks81mETRnHgsZ5tLV0cB",
  "type": "individual",
  "company": "com_dsE2Y4wCMg77HGlJB0Mk",
  "first_name": "Bob",
  "last_name": "Jones",
  "ssn": "123456789",
  "ssn_last_four": "6789",
  "ssn_validation_status": "invalid",
  "onboard": {
    "status": "blocking",
    "blocking_steps": [
      "address"
    ],
    "remaining_steps": [
      "address"
    ],
    "payment_method": [
      "payment_method_preference_set"
    ],
    "address": [
      "address_submitted"
    ]
  },
  "address": {
    "country": "US"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.