For USA SSN Verification (usa_tel_phone), we use the response structure, as provided on this page.
// GREEN — successful check.
{
"checks" : [ {
"answer" : "GREEN",
"checkType" : "TIN",
"createdAt" : "2024-05-24 13:54:37",
"id" : "f627a790-efa0-4a7e-9441-78d7dff298c7",
"inputDoc" : {
"idDocType" : "TAX_PAYER_NUMBER_DOC",
"country" : "USA",
"number" : "0309",
"dob" : "1995-01-20"
},
"extractedDoc" : {
"country" : "USA",
"idDocType" : "TAX_PAYER_NUMBER_DOC",
"firstName" : "Andromache",
"lastName" : "Minshaw",
"phone" : "12109041086",
"email" : "aminshaw15@digg.com",
"dob" : "1995-01-20",
"addresses" : [ {
"street" : "6 Jenna Plaza",
"streetEn" : "6 Jenna Plaza",
"state" : "OH",
"stateEn" : "OH",
"town" : "New York City",
"townEn" : "New York City",
"postCode" : "10009",
"country" : "USA",
"formattedAddress" : "6 Jenna Plaza, New York City, Ohio, United States of America, 10009"
} ],
"tin" : "602410309"
},
"tinCheckInfo" : {
"answer" : "GREEN",
"tinValidity" : "GREEN",
"personDataMatchFound" : "GREEN"
}
} ]
}
// YELLOW - data not found.
{
"checks" : [ {
"answer" : "YELLOW",
"checkType" : "TIN",
"createdAt" : "2024-05-24 13:58:51",
"id" : "dda5972a-335d-4881-9590-cf5cae9fa00a",
"inputDoc" : {
"idDocType" : "TAX_PAYER_NUMBER_DOC",
"country" : "USA",
"number" : "0000"
},
"tinCheckInfo" : {
"answer" : "YELLOW",
"tinValidity" : "YELLOW",
"personDataMatchFound" : "GREEN"
},
"violations" : [ "DATA_NOT_FOUND" ]
} ]
}
// RED - data was found but there are violations (name mismatch, dob mismatch.
{
"checks" : [ {
"answer" : "RED",
"checkType" : "TIN",
"createdAt" : "2024-05-24 14:21:57",
"id" : "551955a1-7afe-40f6-b230-b9e7bbf648a1",
"inputDoc" : {
"idDocType" : "TAX_PAYER_NUMBER_DOC",
"country" : "USA",
"firstName" : "John",
"number" : "0309",
"dob" : "1995-01-11"
},
"extractedDoc" : {
"country" : "USA",
"idDocType" : "TAX_PAYER_NUMBER_DOC",
"firstName" : "Andromache",
"lastName" : "Minshaw",
"phone" : "12109041086",
"email" : "aminshaw15@digg.com",
"dob" : "1995-01-20",
"addresses" : [ {
"street" : "6 Jenna Plaza",
"state" : "OH",
"town" : "New York City",
"postCode" : "10009",
"country" : "USA",
"formattedAddress" : "6 Jenna Plaza, New York City, Ohio, United States of America, 10009"
} ],
"tin" : "602410309"
},
"tinCheckInfo" : {
"answer" : "RED",
"tinValidity" : "GREEN",
"personDataMatchFound" : "RED"
},
"violations" : [ "NAME_MISMATCH", "BDATE_MISMATCH" ]
} ]
}