To validate a TIN/Name 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:ValidateTinName>
      <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:ValidateTinName>
  </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.
• 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

Output: ValidateTinNameResult

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

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