SSN Trace (US only)
SSN Trace API is used to verify the user's identity and and details associated with the user.
Social Security Trace in Background Checks
Social Security trace searches verify an applicant's name and address history by checking the validity of their Social Security number (SSN). This helps determine which jurisdictions to examine further.
Background Check Role
SSN trace often precedes a National Criminal Database (NatCrim) search to identify potential criminal records, helping organizations evaluate applicant risks.
Information Retrieved
The search gathers names, addresses, and phone numbers associated with the SSN from various data sources for accurate verification.
API Authentication
Before using the SSN trace API, you must authenticate by logging in and obtaining an access token. Include this token in the Authorization header of your request.
Required Parameters
Ensure to include the following key parameters when crafting your JSON request for the SSN trace method:
ssn: The applicant's Social Security Number (mandatory).
firstName: The applicant's first name.
lastName: The applicant's last name.
maxAddressYears: The maximum number of years to trace address history.
Example Request
To execute the SSN trace method using cURL, use the sample request below. Replace the placeholder values as needed:
Ensure that the Social Security Number (SSN) and other required fields are correctly provided to achieve accurate results. The use of placeholders helps in adapting the request to specific applications.
Understanding the Parameters
Below is a detailed explanation of the request and response body parameters used in executing the SSN trace method. Each parameter, along with its data type and description, is outlined to provide clarity on the required and optional fields for making successful API calls.
Request Body Parameters
ssn
string
Yes
Social Security Number. Accepts 9 digit social security number in format xxx-xx-xxxx.
firstName
string
No
First name of the subject. If entered, only results that match both SSN and firstName will be returned.
lastName
string
No
Last name of the subject. If entered, only results that match both SSN and lastName will be returned.
MaxAddressYears
string
No
Filter out any addresses which are older than x years.
Request Response Data
https://irbis.espysys.com/api/request-monitor/api-usage/{id}?key={API key}
Request to get a lookup data of a request with an id.
"id" parameter has to be passed in the path of a request - ID of a request to get lookup data for.
Example Path Variables
id: The unique identifier for the request you wish to look up.
API key: Your specific API key for authentication purposes.
CURL Example
Replace <id> with the request ID you are querying and <API_Key> with your actual API key.
Search Response Schema
Response Body Parameters
General Parameters
name: object - Person's Name.ssn: string - Social Security Number.ssnDates: string - Year associated with the SSN.ssnLocation: string - Location associated with the SSN.ssnAlternateLocation: string - Alternative location associated with the SSN.socialSecurityNumbers[]: array - Array of social security numbers.dob: string - Date of Birth.age: integer - Person's age.dod: string - Date of Death.datesOfDeath[]: array - Array of dates of death.deathRecords: object - Death Records associated with the SSN.isDeceased: boolean - Indicates if the person is deceased or not.
aliases[]: array - Array of Aliases.addresses[]: array - Array of Addresses.phoneNumbers[]: array - Array of Phone Numbers.emailAddresses[]: array - Array of Email Addresses.emailAddress: string - Email Address.
fullName: string - Individual's Full Name.countyStates: array - Array of County States.
Person's Name Parameters
prefix: string - Individual's name prefix.firstName: string - Individual's first name.middleName: string - Individual's middle name.lastName: string - Individual's last name.suffix: string - Individual's suffix.publicFirstSeenDate: string - Individual's public first seen date.
Alias Parameters
referenceId: integer - Alias reference ID.prefix: string - Alias name prefix.firstName: string - Alias first name.middleName: string - Alias middle name.lastName: string - Alias last name.suffix: string - Alias suffix.publicFirstSeenDate: string - Alias public first seen date.fullName: string - Alias full name.
Social Security Number Parameters
ssn: string - Individual's social security number.dates: string - Dates used.location: string - State where SSN was issued.
Address Parameters
referenceId: integer - Address reference ID.houseNumber: string - House number.streetPreDirection: string - Street pre-direction.streetName: string - Street name.streetPostDirection: string - Street post-direction.streetType: string - Street type.unit: string - Unit (apartment, suite, etc.).unitType: string - Type of unit.city: string - City.state: string - State.county: string - County.zip: string - ZIP code.zip4: string - ZIP+4 code.latitude: string - Latitude.longitude: string - Longitude.firstReportedDate: string - First reported date.lastReportedDate: string - Last reported date.fullAddress: string - Full address.
Phone Number Parameters
phoneNumber: string - Phone number.company: string - Company associated with the phone number.location: string - Location of the phone number.phoneType: string - Type of phone.isConnected: boolean - Indicates if the phone is connected or not.firstReportedDate: string - First reported date.lastReportedDate: string - Last reported date.
Country State Parameters
county: string - County.state: string - State.
Last updated