home

Tax and Regulatory Reporting

Sovos Docs

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.

The following is an example request:
<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>
Note:

Each xml node in the body content uses the pvs namespace.

Input

The following input parameters are required for this API method:
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 the LName field.

  • GIIN (Optional): The subject's FATCA\FFI GIIN

  • Encryption: Leave empty.

Input parameters: USPSAddress
  • Address1 (Optional): Suite/Apt Number

  • Address2: Street Address

  • City: Address city

  • State: Address state

  • Zip5: ZIP Code

  • Zip4: +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

Read about all validation results for more information on each code that might be provided.
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:

Note:

⚠️ is considered a "bad" result. ✔️ is a "good" result.

Table 1. TIN/Name results
TINNAME_CODETINNAME_DETAILS
-1TIN/Name validation not processed
0TIN and name combinations does not match IRS records⚠️
1TIN and name combination matches IRS records✔️
5TIN entered is not currently issued⚠️
6TIN and name combination matches IRS SSN records✔️
7TIN and name combination matches IRS EIN records✔️
8TIN and name combination matches ITS SSN and EIN records✔️
10Login denied: Invalid user login and/or password
11Invalid data
12Invalid configuration
13Invalid TIN matching request⚠️
14Duplicate TIN matching request
15Connection problem
16IRS connection problem
17IRS TIN/Name validation temporarily unavailable
18Request denied: no more checks available for this account
20Processing error
21IRS processing error
22Invalid IRS login
23Login denied: Invalid user
24Login denied: Invalid password
25Login denied:This account has been locked
26Login denied: Account locked for 24 hours (3+ login attempts)
27Login denied: Terms not accepted
28Login denied: Account expired
29Login denied: No security rights
Table 2. DMF results
DMF_CODEDMF_DETAILS
-1Death Master File match not processed
0No Death Master File match found✔️
1Possible Death Master File match found (contains parsable Details)⚠️
10Login denied: Invalid user login and/or password
11Invalid data
12Invalid configuration
13Invalid Death Master File Matching request
15Connection problem
16DMF connection problem
17Death Master File Match temporarily unavailable
18Request denied: no more checks available for this account
20Processing error
21Death Master File processing error
23Login denied: Invalid user
24Login denied: Invalid password
25Login denied: This account has been locked
26Login denied: Account locked for 24 hours (3+ login attempts)
27Login denied: Terms not accepted
28Login denied: Account expired
29Login denied: No security rights
Table 3. EIN results
EIN_CODEEIN_DETAILS
-1EIN match not processed
0No EIN match found✔️
1EIN possible match found (contains parsable EIN_DATA)
10Login denied: Invalid user login and/or password
11Invalid data
12Invalid configuration
13Invalid EIN Matching request
15Connection problem
16EIN connection problem
17EIN Match temporarily unavailable
18Request denied: no more checks available for this account
20Processing error
21EIN processing error
23Login denied: Invalid user
24Login denied: Invalid password
25Login denied: This account has been locked
26Login denied: Account locked for 24 hours (3+ login attempts)
27Login denied: Terms not accepted
28Login denied: Account expired
29Login denied: No security rights
Table 4. List match results
LISTMATCH_CODELISTMATCH_DETAILS
-1List match not processed
0No list matches found✔️
1Possible list matches found⚠️
10Login denied: Invalid user login and/or password
11Problem processing list match validation request: invalid data {details}
12Invalid configuration: No lists enabled
13Invalid list matching request
15Connection problem
16List connection problem
17List match temporarily unavailable
18Request denied: no more checks available for this account
20Processing error
21List match processing error
23Login denied: Invalid user
24Login denied: Invalid password
25Login denied: This account has been locked
26Login denied: Account locked for 24 hours (3+ login attempts)
27Login denied: Terms not accepted
28Login denied: Account expired
29Login denied: No security rights
Table 5. List match result types
TypeCodeDetailsCount
[ResultType]0No list matches found0✔️
[ResultType]0[ResultType] List: Possible N matches foundN⚠️
Table 6. Status results
STATUSDetails
OKSystem is functioning normally✔️
Table 7. Checks results
CallsRemainingDetails
No limitMonthly plan
NumberChecks remaining