---
title: "SSN Check"
method: POST
path: "/api/private-ssn/verify"
tags: ["ssn"]
---

# SSN Check

`POST /api/private-ssn/verify`

Private SSN verification job

## Headers

- `content-type` string
- `accept` string
- `x-test-request` string

## Request body

- PrivateSsnRequest
  - `firstName` string, required — First name linked to this phone number in the request. The request must contain the firstname or lastname to be successful
  - `lastName` string, required — Last name linked to the phone number in the request. The request must contain the firstname or lastname to be successful
  - `phone` string, required — The phone number of the individual for this request. Formatted in E.164 formatting for international numbers including the leading plus sign. For example +12065551111
  - `ssn` string, required — The last 4 or full 9 digits of the social security number in the request
  - `email` string — Email linked to the phone number in the request
  - `dob` string — Date of birth identifier used as qualifying input. Date should be in ISO 8601 format https://en.wikipedia.org/wiki/ISO_8601
  - `address` BaseAddress — Address
    - `unit` string — Unit number.
    - `streetAddress` string — Street Address.
    - `city` string — City.
    - `state` string — Two-character state code associated with the phone number. [state code](https://www.faa.gov/air_traffic/publications/atpubs/cnt_html/appendix_a.html)
    - `postalCode` string — Postal Code.
    - `country` string — The [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
  - `properties` ApijobsProperties[] — List of arbitrary customer supplied properties
    - `name` string — Name of the property
    - `value` string — Value of the property

## Response `200`

Success

- PrivateSsnResponse
  - `id` string
  - `status` string
  - `completed` boolean
  - `submitted` string
  - `updatedAt` string
  - `request` object
    - `type` string
    - `paramaters` object
      - `phone` string
      - `email` string
  - `result` object
    - `ssnMatch` boolean
    - `cip` SsnCipResult — CIP (Customer Identification Program) per-element outcome. Only returned when CIP scoring is enabled for the account. Does not affect ssnMatch.
      - `version` integer, required — CIP model version.
      - `pass` boolean, required — CIP pass/fail. The identity matched, the subject is not reported deceased, and a submitted date of birth did not mismatch.
      - `ssn` object, required — The SSN element alone, independent of the name, date of birth and deceased signals.
        - `match` boolean, required — The submitted SSN matched.
      - `name` object — Optional. Omitted when no name match result is available.
        - `match` boolean, required — The name matched the SSN holder.
      - `dob` object — Optional. Omitted when the request did not include a date of birth.
        - `match` boolean, required — The date of birth matched the SSN holder.
      - `deceased` boolean, required — The subject is reported deceased.
  - `errors` Error[] — List of errors for unsuccessful completed ssn jobs.
    - `type` 'InvalidRequestError' | 'FaceMatchError' | 'NameMatchError' | 'BarcodeMatchError' | 'BirthDateMatchError' | 'ExpiredIdError' | 'InvalidIdPhotoError' | 'InvalidUserPhotoError' | 'AuthenticationError' | 'ConnectionError' | 'UnknownSystemError' | 'TooManyRequestsError' | 'UnprocessableContentError' — Error type code. - InvalidRequestError - The request is invalid. - Parameters sent in the request are invalid. - FaceMatchError - The face match score was lower than the threshold. - Category: faceMatch - Faces obtained from the ID and Selfie images do not match. - NameMatchError - The name match score was lower than the threshold. - The name provided by the user and the name extracted from the ID do not match. - Eg: User Provided Name - Dave Smith, Extracted Name - David Smith - BarcodeMatchError - The barcode match score was lower than the threshold. - The data provided by the user and the data extracted from the barcode do not match. - Eg: User Provided Name - Dave Smith, Extracted Name - David Smith - BirthDateMatchError - The birth date match score was lower than the threshold. - The birth date provided by the user and the data extracted from the ID do not match. - Eg: User Provided DOB - 01/09/1992, Extracted DOB - 09/01/1992 - Eg: User Provided DOB - 11/09/1992, Extracted DOB - 12/09/1992 - ExpiredIdError - The ID’s expiration date has passed. - The expiration date extracted from the ID indicates that it has expired. - InvalidIdPhotoError - The ID is invalid. - Category: id - The image submitted does not qualify as an ID. The ID image may be of lower quality, have blur, glare or it may be too dark, and hence the data could not be extracted. - InvalidUserPhotoError - The user photo (selfie) is invalid. - Category: selfie - The image submitted does not qualify as a selfie. - AuthenticationError - The request could not be authenticated. - The key could not be verified. - ConnectionError - A connection error occurred while communicating to the Vouched service. - UnknownSystemError - A unknown system error occurred. - TooManyRequestsError - the Vouched service has throttled this request. - Retry your request later. - UnprocessableContentError - The request contains incorrectly formatted or missing data. - The server understood the content type of the request content, and the syntax of the request content was correct, but it was unable to process the contained instructions. - Eg: Submitted data contains invalid characters - Eg: Required data is missing
    - `message` string — Details on the occurring error.
    - `warning` boolean — Is this a warning?
    - `suggestion` string — A suggestion for matching name.
  - `signals` unknown[] — List of signals affecting the request
    - unknown

## Other responses

- `400` — InvalidRequestError - The request is invalid.
- `401` — AuthenticationError - The request could not be authenticated.
- `404` — ConnectionError - A connection error occurred while communicating to the Vouched service.
- `429` — TooManyRequestsError - the Vouched service has throttled this request.
- `500` — UnknownSystemError - A unknown system error occurred.

---

[API](https://skmtc.dev/vouched/apis/vouched-api.md) · [All operations](https://skmtc.dev/vouched/apis/vouched-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vouched/vouched-api/revisions/e6b14826bf7f/schema)