Run All Validations
Learn how to validate a TIN/Name combination and check it against watchlists and databases using the TINCheck SOAP API.
To validate a TIN/Name, or check against the USPS, DMF, OFAC and banned casino barred lists using the SOAP API, you will need to provide your authentication credentials along with any data (input parameters) required by the method to return a result.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pvs="http://www.TinCheck.com/WebServices/PVSService/">
<soap:Header/>
<soap:Body>
<pvs:ValidateTinNameAddressListMatch>
<pvs:TinName>
<pvs:TIN>123456789</pvs:TIN>
<pvs:FName>Jane</pvs:FName>
<pvs:LName>Smith</pvs:LName>
</pvs:TinName>
<pvs:USPSAddress>
<pvs:Address1>Apt 310</pvs:Address1>
<pvs:Address2>123 Main Street</pvs:Address2>
<pvs:City>Checker</pvs:City>
<pvs:State>CT</pvs:State>
<pvs:Zip5>12345</pvs:Zip5>
<pvs:Zip4>7891</pvs:Zip4>
</pvs:USPSAddress>
<pvs:CurUser>
<pvs:UserID></pvs:UserID>
<pvs:UserLogin>youremail@example.com</pvs:UserLogin>
<pvs:UserPassword>YourPassword</pvs:UserPassword>
<pvs:UserEncryption></pvs:UserEncryption>
</pvs:CurUser>
</pvs:ValidateTinNameAddressListMatch>
</soap:Body>
</soap:Envelope>
Each xml node in the body content uses the pvs
namespace.
Input
- Input parameters:
TinName
TIN
: The subject's 9-digit TIN (EIN or SSN).Numbers only, no formatting.
Required for IRS and DMF validations.
LName
: The subject's last name, full name (first and last) or a company name.FName
(Optional): The subject's first name. Use only if the last name is provided separately in theLName
field.GIIN
(Optional): The subject's FATCA\FFI GIINEncryption
: Leave empty.
- Input parameters:
USPSAddress
Address1
(Optional): Suite/Apt NumberAddress2
: Street AddressCity
: Address cityState
: Address stateZip5
: ZIP CodeZip4
: +4 (additional portion of ZIPCode)
- Input parameters:
CurUser
UserLogin
: Your TINCheck login (email address).UserPassword
: Your TINCheck password.UserEncryption
: Leave empty.UserID
: Leave empty.
Output
- Output:
ValidateTinNameAddressListMatchResult
REQUESTID
: The ID number for this request.REQUEST_STATUS
: A numeric code indicating a type of result.REQUEST_DETAILS
: A text description of the code returned.
- Output:
TINNAME_RESULT
TINNAME_CODE
: A numeric code indicating a type of result.TINNAME_DETAILS
: A text description of the code returned.DMF_CODE
: A numeric code indicating a type of result.DMF_DETAILS
: A text description of the code returned.DMF_DATA
: Result details (must be run through an XML decode method).EIN_CODE
: A numeric code indicating a type of result.EIN_DETAILS
: A text description of the code returned.EIN_DATA
: Result details (must be run through an XML decode method).
- Output:
LISTMATCH_RESULT
LISTMATCH_CODE
: A numeric code indicating a type of result.LISTMATCH_DETAILS
: A text description of the code returned.
- Output:
RESULTS
Each list will return results in a separate section called <RESULT>. Within the RESULT section of the response, each list item will contain the following:
OFAC, PEP, PLC, IL, ISA, MO, MS, NJ, NV, SSI, UKE, UVL, DFTO, DPL, DTC, EAR, EPLS, EUS, FBIAVC, FBICA, FBICAC, FBICC, FBICEI, FBIDT, FBIMWT, FBISI, FBISTI, FBITMW, FBIVCM, FBIWCC, FFI, FSE, GIIN, HHS, and IEO.
Type
: The list or result type the result is for.Code
: Result details (must be run through an XML decode method).Details
: A numeric code indicating a type of result.Count
: A text description of the code returned.Data
: Result details (must be run through an XML decode method).
- Output:
STATUS
Status
: TINCheck system status.CallsRemaining
: The number of calls remaining for the authenticated user.
All validations results
Learn about what your TIN/Name combination and watchlist and database validation results mean.
When results are returned, you will see a numeric code alongside a description of the code. Here's a list of each code and description combination you may see when running this type of check:
⚠️ is considered a "bad" result. ✔️ is a "good" result.
TINNAME_CODE | TINNAME_DETAILS | |
---|---|---|
-1 | TIN/Name validation not processed | |
0 | TIN and name combinations does not match IRS records | ⚠️ |
1 | TIN and name combination matches IRS records | ✔️ |
5 | TIN entered is not currently issued | ⚠️ |
6 | TIN and name combination matches IRS SSN records | ✔️ |
7 | TIN and name combination matches IRS EIN records | ✔️ |
8 | TIN and name combination matches ITS SSN and EIN records | ✔️ |
10 | Login denied: Invalid user login and/or password | |
11 | Invalid data | |
12 | Invalid configuration | |
13 | Invalid TIN matching request | ⚠️ |
14 | Duplicate TIN matching request | |
15 | Connection problem | |
16 | IRS connection problem | |
17 | IRS TIN/Name validation temporarily unavailable | |
18 | Request denied: no more checks available for this account | |
20 | Processing error | |
21 | IRS processing error | |
22 | Invalid IRS login | |
23 | Login denied: Invalid user | |
24 | Login denied: Invalid password | |
25 | Login denied:This account has been locked | |
26 | Login denied: Account locked for 24 hours (3+ login attempts) | |
27 | Login denied: Terms not accepted | |
28 | Login denied: Account expired | |
29 | Login denied: No security rights |
DMF_CODE | DMF_DETAILS | |
---|---|---|
-1 | Death Master File match not processed | |
0 | No Death Master File match found | ✔️ |
1 | Possible Death Master File match found (contains parsable Details) | ⚠️ |
10 | Login denied: Invalid user login and/or password | |
11 | Invalid data | |
12 | Invalid configuration | |
13 | Invalid Death Master File Matching request | |
15 | Connection problem | |
16 | DMF connection problem | |
17 | Death Master File Match temporarily unavailable | |
18 | Request denied: no more checks available for this account | |
20 | Processing error | |
21 | Death Master File processing error | |
23 | Login denied: Invalid user | |
24 | Login denied: Invalid password | |
25 | Login denied: This account has been locked | |
26 | Login denied: Account locked for 24 hours (3+ login attempts) | |
27 | Login denied: Terms not accepted | |
28 | Login denied: Account expired | |
29 | Login denied: No security rights |
EIN_CODE | EIN_DETAILS | |
---|---|---|
-1 | EIN match not processed | |
0 | No EIN match found | ✔️ |
1 | EIN possible match found (contains parsable EIN_DATA) | |
10 | Login denied: Invalid user login and/or password | |
11 | Invalid data | |
12 | Invalid configuration | |
13 | Invalid EIN Matching request | |
15 | Connection problem | |
16 | EIN connection problem | |
17 | EIN Match temporarily unavailable | |
18 | Request denied: no more checks available for this account | |
20 | Processing error | |
21 | EIN processing error | |
23 | Login denied: Invalid user | |
24 | Login denied: Invalid password | |
25 | Login denied: This account has been locked | |
26 | Login denied: Account locked for 24 hours (3+ login attempts) | |
27 | Login denied: Terms not accepted | |
28 | Login denied: Account expired | |
29 | Login denied: No security rights |
LISTMATCH_CODE | LISTMATCH_DETAILS | |
---|---|---|
-1 | List match not processed | |
0 | No list matches found | ✔️ |
1 | Possible list matches found | ⚠️ |
10 | Login denied: Invalid user login and/or password | |
11 | Problem processing list match validation request: invalid data {details} | |
12 | Invalid configuration: No lists enabled | |
13 | Invalid list matching request | |
15 | Connection problem | |
16 | List connection problem | |
17 | List match temporarily unavailable | |
18 | Request denied: no more checks available for this account | |
20 | Processing error | |
21 | List match processing error | |
23 | Login denied: Invalid user | |
24 | Login denied: Invalid password | |
25 | Login denied: This account has been locked | |
26 | Login denied: Account locked for 24 hours (3+ login attempts) | |
27 | Login denied: Terms not accepted | |
28 | Login denied: Account expired | |
29 | Login denied: No security rights |
Type | Code | Details | Count | |
---|---|---|---|---|
[ResultType] | 0 | No list matches found | 0 | ✔️ |
[ResultType] | 0 | [ResultType] List: Possible N matches found | N | ⚠️ |
STATUS | Details | |
---|---|---|
OK | System is functioning normally | ✔️ |
CallsRemaining | Details |
---|---|
No limit | Monthly plan |
Number | Checks remaining |