Get TIN (SSN) check results

Returns the TIN (SSN) check results.

Overview

Use this method to get the data extracted from the external sources using the applicant TIN (SSN).

The following page provides response examples for the United States.

Response explained

The response represents a singleton list of checks.

Root variables

The root variables are the core TIN check result data items. Some of them may include nested attributes and element fields.

FieldTypeDescription
answerStringСheck answer:
  • GREEN — the check has passed successfully. Data found in the database and matched the applicant data.
  • RED — the check shows a high risk indication. Data found but the applicant data does not match the database record. In some cases, it may also mean that no data was found. Please see the response examples for more information
  • YELLOW — data not found.
checkTypeStringIndicates that it is a TIN check type.
createdAtDateDate and time (UTC) of the latest TIN check result.
idStringUnique identifier of the check.
inputDocObjectRepresents the data used for the TIN check.
extractedDocObjectExternal check source data. It may not be present if the data is not received.
tinCheckInfoObjectIncludes TIN check results.
violationsArray of stringsIndicates violations that were found:
  • NAME_MISMATCH — the name does not match the database record.
  • BDATE_MISMATCH — the date of birth does not match the database record.
  • DATA_NOT_FOUND — data not found.

inputDoc attributes

The following table explains the inputDoc attributes representing the data taken from the provided document.

FieldTypeDescription
idDocTypeStringA type of the document provided for verification. For example, TAX_PAYER_NUMBER_DOC, ID_CARD, PASSPORT, DRIVERS.
countryStringAlpha-3 country code (for example, DEU, GBR, ARG, and so on).
firstNameStringFirst name provided by the applicant.
middleNameStringMiddle name provided by the applicant.
lastNameStringLast name provided by the applicant.
numberStringTax Identification number provided by the applicant.
dobDateDate of birth provided by the applicant.
phoneStringPhone number provided by the applicant

extractedDoc attributes

The extractedDoc object includes the data obtained from the external source during the TIN check.

FieldTypeDescription
countryStringAlpha-3 country code (for example, DEU, GBR, ARG, and so on).
firstNameStringApplicant first name.
middleNameStringApplicant middle name.
lastNameStringApplicant last name.
addressesList of ObjectsThe list of addresses extracted from the external check sources.

addresses attributes

The following table explains the addresses element fields containing the applicant address details extracted from external sources.

FieldTypeDescription
streetStringThe street where the applicant lives and/or is registered.
streetEnStringAutomatic transliteration of the applicant street into Latin.
subStreetStringAdditional information related to the applicant street. This could be a house number or any other details.
stateStringThe state, region, district, county or another territorial entity inside a country, if applicable.
stateEnStringAutomatic transliteration of the applicant state, region, district, county, or another territorial entity inside a country into Latin.
buildingNumberStringBuilding number.
townStringThe city, town, or another settlement where the applicant lives and/or is registered.
townEnStringAutomatic transliteration of the city, town, or another settlement where the applicant lives and/or is registered into Latin.
postCodeStringAddress postal code.
startDateDateThe date of starting using the address as residential.
endDateDateThe date of changing the residential address.
countryStringAlpha-3 country code (for example, DEU, GBR, ARG, and so on).
formattedAddressStringAddress in an human-readable format.
providedLocationPositionObjectContains the locationCoords object that includes geographical coordinates — the position's latitude and longitude in decimal degrees.

tinCheckInfo attributes

The following table describes the tinCheckInfo attributes representing the TIN check results.

FieldTypeDescription
answerStringTIN check answer:
  • GREEN — approved.
  • RED — rejected.
  • YELLOW — data not found.
tinValidityStringIndicates the TIN validity check result:
  • GREEN — valid.
  • RED — invalid.
  • YELLOW — data not found.
personDataMatchFoundStringIndicates whether the provided information matches the data found in the external source:
  • GREEN — valid.
  • RED — invalid.
  • null — if data not found.
Language
Authorization
Header
Click Try It! to start a request and see the response here!