v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Reveal contractor SSN

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

get/contractors/{contractor}/reveal

Path parameters

contractorstring required

The ID of the contractor whose SSN you want to reveal

Response

200

idstring

typestring

companystring

{"stackTrail":"paths:/contractors/{contractor}/reveal:get:responses:200:content:application/json:schema:properties:primary_workplace","oasType":"schema","type":"unknown"}

first_namestring

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

last_namestring

{"stackTrail":"paths:/contractors/{contractor}/reveal:get:responses:200:content:application/json:schema:properties:business_name","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/contractors/{contractor}/reveal:get:responses:200:content:application/json:schema:properties:dob","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/contractors/{contractor}/reveal:get:responses:200:content:application/json:schema:properties:start_date","oasType":"schema","type":"unknown"}

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

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

ssnstring

ssn_last_fourstring

ssn_validation_statusstring

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

{"stackTrail":"paths:/contractors/{contractor}/reveal:get:responses:200:content:application/json:schema:properties:ein","oasType":"schema","type":"unknown"}

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