v1

latestOpenAPI 3.1.0Apache 2.02026-07-24196597.7 KB

ssn

SSN Check

Private SSN verification job

post/api/private-ssn/verify

Headers

content-typestring

acceptstring

x-test-requeststring

Set value to true to test a request using test SSNs. The following SSN values will result in ssnMatch=true ['2345', '2245', '7788', '903526700', '912765604', '933887700']. Any other SSN will result in ssnMatch=false.

Request body

firstNamestring required

First name linked to this phone number in the request. The request must contain the firstname or lastname to be successful

lastNamestring required

Last name linked to the phone number in the request. The request must contain the firstname or lastname to be successful

phonestring 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

ssnstring required

The last 4 or full 9 digits of the social security number in the request

emailstring

Email linked to the phone number in the request

dobstring

Date of birth identifier used as qualifying input. Date should be in ISO 8601 format https://en.wikipedia.org/wiki/ISO_8601

Response

Success

idstring

statusstring

completedboolean

submittedstring

updatedAtstring

Example response

{
  "errors": [
    {
      "suggestion": "John Smith"
    }
  ]
}