Validating list matches using the SOAP API

  • Updated

To validate a TIN/Name against the USPS, DMF, OFAC and banned casino barred lists using the SOAP API, you’ll 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.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:pvs="http://www.tincheck.com/WebServices/PVSService/">
<soap:Header/>
<soap:Body>
<pvs:ValidateListMatch>
<pvs:TinName>
<pvs:TIN>123456789</pvs:TIN>
<pvs:FName>Jane</pvs:FName>
<pvs:LName>Smith</pvs:LName>
</pvs:TinName>
<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:ValidateListMatch>
</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: CurUser

  • UserLogin: Your TINCheck login (email address)
  • UserPassword: Your TINCheck password
  • UserEncryption: leave empty
  • UserID: leave empty

 

Output

See "Interpreting your results" for more information on each code that may be provided.

Output: ValidateListMatchResult

  • 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,  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
    • Result types include: OFAC, PEP, PLC, IL, ISA, MO, MS, NJ, NV, SSI, UKE, UVL, DFTO, DPL, DTC, EAR, EPLS, EUS, FBIAVC, FBICAC, FBICC, FBICEI, FBIDT, FBIMWT, FBISI, FBISTI, FBITMW, FBIVCM, FBIWCC, FFI, FSE, GIIN, HHS, and IEO.
  • 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

 

Interpreting your results

When results are returned, you'll 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: ⚠️ = considered a "bad" result   ✔️ = a "good" result

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] 1 [ResultType] List: Possible N matches found N ⚠️

 

STATUS Details  
OK System is functioning normally ✔️

 

CallsRemaining Details  
No limit Monthly plan  
Number Checks remaining  

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.