API ReferenceChangelogFAQDashboard

USA

This page provides examples of the TIN check response for the USA:

SSN match verification

GREEN

GREEN — successful check.

{
  "checks": [ {
    "answer": "GREEN",
    "checkType": "TIN",
    "createdAt": "2024-05-20 15:00:11",
    "id": "67ccf147-7eee-4527-a61c-3cdbd21af028",
    "inputDoc": {
      "idDocType": "TAX_PAYER_NUMBER_DOC",
      "country": "USA",
      "firstName": "JOHN",
      "lastName": "SMITH",
      "number": "123456789",
      "dob": "1971-01-01"
    },
    "extractedDoc": {
      "firstName": "JOHN",
      "middleName": "T",
      "lastName": "SMITH",
      "addresses": [ {
        "flatNumber": "16",
        "street": "12306 CORIDAN DR",
        "streetEn": "12306 CORIDAN DR",
        "state": "TX",
        "stateEn": "TX",
        "buildingNumber": "12306",
        "town": "AUSTIN",
        "townEn": "AUSTIN",
        "postCode": "78727-7034",
        "startDate": "1990-01-01 00:00:00",
        "endDate": "1995-12-31 00:00:00",
        "country": "USA",
        "formattedAddress": "12306 CORIDAN DR APT 16, AUSTIN, TX 78727-7034",
        "providedLocationPosition": {
          "locationCoords": {
            "lat": 30.436224,
            "lon": -97.742058
          }
        }
      }, {
        "street": "6 JENNA PLAZA",
        "streetEn": "6 JENNA PLAZA",
        "state": "NY",
        "stateEn": "NY",
        "buildingNumber": "6",
        "town": "NEW YORK CITY",
        "townEn": "NEW YORK CITY",
        "postCode": "10009",
        "startDate": "1996-01-01 00:00:00",
        "endDate": "2024-04-18 00:00:00",
        "country": "USA",
        "formattedAddress": "6 JENNA PLAZA, NEW YORK CITY, NY 10009",
        "providedLocationPosition": {
          "locationCoords": {
            "lat": 31.233104,
            "lon": -90.455543
          }
        }
      } ]
    },
    "tinCheckInfo": {
      "answer": "GREEN",
      "tinValidity": "GREEN",
      "personDataMatchFound": "GREEN"
    }
  } ]
}

RED

RED — data was found but there are violations.

{
  "checks": [ {
    "answer": "RED",
    "checkType": "TIN",
    "createdAt": "2024-05-21 08:58:25",
    "id": "0eab9617-9914-45db-962e-039c7cf8e62f",
    "inputDoc": {
      "idDocType": "TAX_PAYER_NUMBER_DOC",
      "country": "USA",
      "firstName": "JOHN",
      "lastName": "DOE",
      "number": "123456789",
      "dob": "1990-01-01"
    },
    "extractedDoc": {
      "firstName": "JOHN",
      "lastName": "SMITH",
      "addresses": [ {
        "flatNumber": "16",
        "street": "12306 CORIDAN DR",
        "state": "TX",
        "buildingNumber": "12306",
        "town": "AUSTIN",
        "postCode": "78727-7034",
        "startDate": "1990-01-01 00:00:00",
        "endDate": "1995-12-31 00:00:00",
        "country": "USA",
        "formattedAddress": "12306 CORIDAN DR APT 16, AUSTIN, TX 78727-7034",
        "providedLocationPosition": {
          "locationCoords": {
            "lat": 30.436224,
            "lon": -97.742058
          }
        }
      } ]
    },
    "tinCheckInfo": {
      "answer": "RED",
      "tinValidity": "GREEN",
      "personDataMatchFound": "RED"
    },
    "violations": [ "BDATE_MISMATCH", "NAME_MISMATCH" ]
  } ]
}

RED — data not found

{
  "checks": [ {
    "answer": "RED",
    "checkType": "TIN",
    "createdAt": "2024-05-21 08:59:31",
    "id": "f06b965c-da27-4a23-8604-0c32f3eb0892",
    "inputDoc": {
      "idDocType": "TAX_PAYER_NUMBER_DOC",
      "country": "USA",
      "firstName": "JOHN",
      "lastName": "DOE",
      "number": "000000000",
      "dob": "1990-01-01"
    },
    "tinCheckInfo": {
      "answer": "RED",
      "tinValidity": "RED",
      "personDataMatchFound": "RED"
    }
  } ]
}

USA TIN verification

GREEN

GREEN — successful check

{
  "checks" : [ {
    "answer" : "GREEN",
    "checkType" : "TIN",
    "createdAt" : "2024-05-21 10:29:22",
    "id" : "c7471821-862c-4f12-9c0a-80ee7719d14e",
    "inputDoc" : {
      "idDocType" : "TAX_PAYER_NUMBER_DOC",
      "country" : "USA",
      "firstName": "JOHN",
      "lastName": "SMITH",
      "number": "123456789",
    },
    "tinCheckInfo" : {
      "answer" : "GREEN",
      "tinValidity" : "GREEN",
      "personDataMatchFound" : "GREEN"
    }
  } ]
}

RED

RED — name mismatch

{
  "checks" : [ {
    "answer" : "RED",
    "checkType" : "TIN",
    "createdAt" : "2024-05-21 10:30:52",
    "id" : "06e437b6-5136-48ce-bec3-f2e867e487a2",
    "inputDoc" : {
      "idDocType" : "TAX_PAYER_NUMBER_DOC",
      "country" : "USA",
      "firstName" : "JOHN",
      "lastName" : "DOE",
      "number" : "123456789"
    },
    "tinCheckInfo" : {
      "answer" : "RED",
      "tinValidity" : "GREEN",
      "personDataMatchFound" : "RED"
    },
    "violations" : [ "NAME_MISMATCH" ]
  } ]
}

YELLOW

YELLOW — data not found or invalid input was provided

{
  "checks" : [ {
    "answer" : "YELLOW",
    "checkType" : "TIN",
    "createdAt" : "2024-05-21 10:33:50",
    "id" : "a5bc091f-a82e-462f-bda5-8bed713a4708",
    "inputDoc" : {
      "idDocType" : "TAX_PAYER_NUMBER_DOC",
      "country" : "USA",
      "firstName" : "JOHN",
      "lastName" : "DOE",
      "number" : "9999999991"
    },
    "tinCheckInfo" : {
      "answer" : "YELLOW",
      "tinValidity" : "YELLOW",
      "personDataMatchFound" : null
    },
    "violations" : [ "DATA_NOT_FOUND" ]
  } ]
}