Enable Social Security Number (SSN) Field

import Finch from '@tryfinch/finch-api';

const client = new Finch({
  clientId: 'My Client ID',
  clientSecret: 'My Client Secret',
});

const session = await client.connect.sessions.new({
  // Your internal identifiers for this employer
  customer_id: 'impressive-coinsurance-inc',
  customer_name: 'Impressive Coinsurance Inc',

  // `ssn` is its own scope — request it alongside `individual`
  products: ['company', 'directory', 'individual', 'employment', 'payment', 'pay_statement', 'ssn'],

  // Required for the redirect flow; omit it for the embedded flow
  redirect_uri: 'https://example.com/finch/callback',

  // 'finch' creates a test session — omit this field entirely for production
  sandbox: 'finch',
});

{
  "session_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "connect_url": "https://connect.tryfinch.com/authorize?session=f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

curl https://api.tryfinch.com/employer/individual \
-H "Authorization: Bearer <your_access_token>" \
-H "Finch-API-Version: 2020-09-17" \
-X "POST" \
-H "Content-Type: application/json" \
-d '{
  "options": {
    "include": ["ssn"]
  },
  "requests": [{ "individual_id": "f3ddb1f4-dfa4-4e1d-bfed-bdfd0645b613"}]
}'

{
  "responses": [
    {
      "individual_id": "f3ddb1f4-dfa4-4e1d-bfed-bdfd0645b613",
      "code": 200,
      "body": {
        "id": "f3ddb1f4-dfa4-4e1d-bfed-bdfd0645b613",
        "ssn": "143782004",
        "encrypted_ssn": null,
        "first_name": "Angelica",
        "last_name": "Flatley",
        ...
      }
    }
  ]
}

{
  "responses": [
    {
      "individual_id": "f3ddb1f4-dfa4-4e1d-bfed-bdfd0645b613",
      "code": 200,
      "body": {
        "id": "f3ddb1f4-dfa4-4e1d-bfed-bdfd0645b613",
        "ssn": null,
        "encrypted_ssn": "vlIRzYJ5jk3TDanW3T0Fg2cVyHXPvBbtm.zymmLpbVlrnDUsaW0kbmNnkneTyYJRsJKozu",
        "first_name": "Angelica",
        "last_name": "Flatley",
        ...
      }
    }
  ]
}