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.

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

Field	Type	Description
`answer`	String	С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.
`checkType`	String	Indicates that it is a `TIN` check type.
`createdAt`	Date	Date and time (UTC) of the latest TIN check result.
`id`	String	Unique identifier of the check.
`inputDoc`	Object	Represents the data used for the TIN check.
`extractedDoc`	Object	External check source data. It may not be present if the data is not received.
`tinCheckInfo`	Object	Includes TIN check results.
`violations`	Array of strings	Indicates 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.

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

Field	Type	Description
`idDocType`	String	Type of the document provided for verification. For example, `TAX_PAYER_NUMBER_DOC`, `ID_CARD`, `PASSPORT`, `DRIVERS`.
`country`	String	Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on).
`firstName`	String	First name provided by the applicant.
`middleName`	String	Middle name provided by the applicant.
`lastName`	String	Last name provided by the applicant.
`number`	String	Tax Identification number provided by the applicant.
`dob`	Date	Date of birth provided by the applicant.
`phone`	String	Phone number provided by the applicant

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

Field	Type	Description
`country`	String	Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on).
`firstName`	String	Applicant first name.
`middleName`	String	Applicant middle name.
`lastName`	String	Applicant last name.
`addresses`	List of Objects	The list of addresses extracted from the external check sources.

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

Field	Type	Description
`street`	String	Street where the applicant lives and/or is registered.
`streetEn`	String	Automatic transliteration of the applicant street into Latin.
`subStreet`	String	Additional information related to the applicant street. This could be a house number or any other details.
`state`	String	State, region, district, county or another territorial entity inside a country, if applicable.
`stateEn`	String	Automatic transliteration of the applicant state, region, district, county, or another territorial entity inside a country into Latin.
`buildingNumber`	String	Building number.
`town`	String	City, town, or another settlement where the applicant lives and/or is registered.
`townEn`	String	Automatic transliteration of the city, town, or another settlement where the applicant lives and/or is registered into Latin.
`postCode`	String	Address postal code.
`startDate`	Date	Date of starting using the address as residential.
`endDate`	Date	Date of changing the residential address.
`country`	String	Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on).
`formattedAddress`	String	Address in an human-readable format.
`providedLocationPosition`	Object	Contains the `locationCoords` object that includes geographical coordinates — the position's latitude and longitude in decimal degrees.

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

Field	Type	Description
`answer`	String	TIN check answer: `GREEN` — approved. `RED` — rejected. `YELLOW` — data not found.
`tinValidity`	String	Indicates the TIN validity check result: `GREEN` — valid. `RED` — invalid. `YELLOW` — data not found.
`personDataMatchFound`	String	Indicates whether the provided information matches the data found in the external source: `GREEN` — valid. `RED` — invalid. `null` — if data not found.