{
  "info": {
    "name": "TIN Comply API",
    "description": "Requests for every TIN Comply API endpoint. Set the apiKey collection variable to a key from Admin \u003E API Key Management, then send any request. Request Details uses the id saved by the Validate request, and Reveal EIN uses the ids saved by Company EIN Lookup by Name, so send those first. Reference: https://www.tincomply.com/help-center/api",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "X-API-Key",
        "type": "string"
      },
      {
        "key": "value",
        "value": "{{apiKey}}",
        "type": "string"
      },
      {
        "key": "in",
        "value": "header",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://www.tincomply.com/api/v1",
      "type": "string"
    },
    {
      "key": "apiKey",
      "value": "",
      "type": "string"
    },
    {
      "key": "requestId",
      "value": "",
      "type": "string"
    },
    {
      "key": "einRequestId",
      "value": "",
      "type": "string"
    },
    {
      "key": "einCandidateId",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Tax ID \u0026 business",
      "item": [
        {
          "name": "IRS TIN Name Matching",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate/irs-tin-name-matching",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate",
                "irs-tin-name-matching"
              ]
            },
            "description": "Checks a TIN and name combination against IRS records in real time and returns the IRS result code. Works for EINs, SSNs and ITINs. No IRS e-Services enrollment is required.\n\nDocs: https://www.tincomply.com/help-center/api-irs-tin-name-matching",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022tin\u0022: \u0022123-12-1234\u0022,\n  \u0022name\u0022: \u0022JOHN SMITH\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Company Name Lookup by EIN",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate/company-name-lookup-by-ein",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate",
                "company-name-lookup-by-ein"
              ]
            },
            "description": "Submit an EIN and get back the registered business name associated with it. Useful when a vendor supplies an EIN but not the exact legal name.\n\nDocs: https://www.tincomply.com/help-center/api-company-name-lookup-by-ein",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022tin\u0022: \u002213-0871985\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Company EIN Lookup by Name",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate/company-ein-lookup-by-name",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate",
                "company-ein-lookup-by-name"
              ]
            },
            "description": "Submit a company name and receive candidate EINs ranked by name-match confidence. EINs are masked in the response; reveal the one you need with the reveal-ein endpoint below.\n\nDocs: https://www.tincomply.com/help-center/api-company-ein-lookup-by-name",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022name\u0022: \u0022INTERNATIONAL BUSINESS MACHINES CORPORATION\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "event": [
            {
              "listen": "test",
              "script": {
                "type": "text/javascript",
                "exec": [
                  "// Saves the request id and the first candidate for the Reveal EIN request.",
                  "(() =\u003E {",
                  "    const lookup = pm.response.json();",
                  "    pm.collectionVariables.set(\u0027einRequestId\u0027, lookup.id);",
                  "    const candidate = (lookup.companyEinLookupByNameResult.results || [])[0];",
                  "    if (candidate) { pm.collectionVariables.set(\u0027einCandidateId\u0027, candidate.id); }",
                  "})();"
                ]
              }
            }
          ]
        },
        {
          "name": "Reveal EIN",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/request-details/reveal-ein",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "request-details",
                "reveal-ein"
              ]
            },
            "description": "Step two of an EIN lookup: unmasks the EIN of the candidate you choose from the company-ein-lookup-by-name results. Each lookup includes one reveal; it does not use another check.\n\nDocs: https://www.tincomply.com/help-center/api-company-ein-lookup-by-name",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022id\u0022: \u0022{{einRequestId}}\u0022,\n  \u0022resultId\u0022: \u0022{{einCandidateId}}\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Address Validation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate/address-validation",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate",
                "address-validation"
              ]
            },
            "description": "Verifies and standardizes a US mailing address against USPS records, adds the ZIP\u002B4, county and congressional district, and lists every correction made to your input.\n\nDocs: https://www.tincomply.com/help-center/api-address-validation",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022street\u0022: \u0022PO BOX 218\u0022,\n  \u0022city\u0022: \u0022YORKTOWN HEIGHTS\u0022,\n  \u0022state\u0022: \u0022NY\u0022,\n  \u0022zip5\u0022: \u002210598\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Company Details Lookup by Name Address",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate/company-details-lookup-by-name-address",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate",
                "company-details-lookup-by-name-address"
              ]
            },
            "description": "Look up a business by legal name, by address, or both. Returns matching companies with their address, phone, website and other public attributes, each with a match confidence.\n\nDocs: https://www.tincomply.com/help-center/api-company-details-lookup-by-name-address",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022name\u0022: \u0022INTERNATIONAL BUSINESS MACHINES CORPORATION\u0022,\n  \u0022street\u0022: \u00221 NEW ORCHARD RD\u0022,\n  \u0022city\u0022: \u0022ARMONK\u0022,\n  \u0022state\u0022: \u0022NY\u0022,\n  \u0022zip5\u0022: \u002210504\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    },
    {
      "name": "Screening",
      "item": [
        {
          "name": "List Sanctions",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate/list-sanctions",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate",
                "list-sanctions"
              ]
            },
            "description": "Screens a person or business name against more than 330 sanctions and watchlists, including OFAC SDN, the Consolidated Screening List, SAM exclusions, FinCEN, BIS, EU and UN, with fuzzy matching and alias detection. Hits below your account\u0027s match threshold are filtered out.\n\nDocs: https://www.tincomply.com/help-center/api-list-sanctions",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022name\u0022: \u0022INTERNATIONAL BUSINESS MACHINES\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    },
    {
      "name": "International entities",
      "item": [
        {
          "name": "FATCA GIIN",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate/fatca-giin",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate",
                "fatca-giin"
              ]
            },
            "description": "Checks a GIIN against the IRS FATCA Foreign Financial Institution (FFI) list and returns the registered institution name and country.\n\nDocs: https://www.tincomply.com/help-center/api-fatca-giin",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022giin\u0022: \u002229SR4B.99999.SL.372\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Legal Entity Identifier",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate/legal-entity-identifier",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate",
                "legal-entity-identifier"
              ]
            },
            "description": "Validates a Legal Entity Identifier against the Global LEI Foundation (GLEIF) register and returns the registered entity\u0027s name, address, legal form, jurisdiction and status.\n\nDocs: https://www.tincomply.com/help-center/api-legal-entity-identifier",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022lei\u0022: \u0022VGRQXHF3J8VDLUA7XE92\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    },
    {
      "name": "Healthcare \u0026 carriers",
      "item": [
        {
          "name": "NPI Registry",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate/npi-registry",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate",
                "npi-registry"
              ]
            },
            "description": "Looks up a National Provider Identifier in the CMS NPPES registry and returns its status, the registered provider name, specialty, license and practice address. Send a name as well and the response tells you whether it matches the registry.\n\nDocs: https://www.tincomply.com/help-center/api-npi-registry",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022npi\u0022: \u00221245319599\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Medicare Enrollment",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate/medicare-enrollment",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate",
                "medicare-enrollment"
              ]
            },
            "description": "Checks a provider\u0027s Medicare status by NPI: enrolled privileges (Part B, DME, home health, power mobility, hospice), opt-out status with its effective and end dates, and Care Compare profile details.\n\nDocs: https://www.tincomply.com/help-center/api-medicare-enrollment",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022npi\u0022: \u00221245319599\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "FMCSA Carrier",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate/fmcsa-carrier",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate",
                "fmcsa-carrier"
              ]
            },
            "description": "Looks up a motor carrier by USDOT number and returns whether it is allowed to operate, its operating authority by type (common, contract, broker), insurance filings, out-of-service status and fleet size.\n\nDocs: https://www.tincomply.com/help-center/api-fmcsa-carrier",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022dot\u0022: \u00222213141\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    },
    {
      "name": "Multi-service",
      "item": [
        {
          "name": "Validate (multi-service)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/validate",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "validate"
              ]
            },
            "description": "Runs one or more validation services against a single record in one call. Send whatever fields you have; every service those fields support runs, unless you narrow the list with requestedServices.\n\nDocs: https://www.tincomply.com/help-center/api-validate",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022tin\u0022: \u002213-0871985\u0022,\n  \u0022name\u0022: \u0022INTERNATIONAL BUSINESS MACHINES CORPORATION\u0022,\n  \u0022street\u0022: \u0022PO BOX 218\u0022,\n  \u0022city\u0022: \u0022YORKTOWN HEIGHTS\u0022,\n  \u0022state\u0022: \u0022NY\u0022,\n  \u0022zip5\u0022: \u002210598\u0022,\n  \u0022requestedServices\u0022: [ \u0022irs-tin-name-matching\u0022, \u0022address-validation\u0022, \u0022list-sanctions\u0022 ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "event": [
            {
              "listen": "test",
              "script": {
                "type": "text/javascript",
                "exec": [
                  "// Saves this request\u0027s id for the Request Details request.",
                  "pm.collectionVariables.set(\u0027requestId\u0027, pm.response.json().id);"
                ]
              }
            }
          ]
        }
      ]
    },
    {
      "name": "Results",
      "item": [
        {
          "name": "Request Details",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/request-details",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "request-details"
              ]
            },
            "description": "Returns the complete stored result of one earlier validation request: the original request and every result object, in the same shape as the validate response. GET with ?id= also works.\n\nDocs: https://www.tincomply.com/help-center/api-request-details",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022id\u0022: \u0022{{requestId}}\u0022\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "History",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/history",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "history"
              ]
            },
            "description": "Lists your previous validation requests, newest first, with a summary result for each service.\n\nDocs: https://www.tincomply.com/help-center/api-request-details",
            "body": {
              "mode": "raw",
              "raw": "{\n  \u0022page\u0022: 1,\n  \u0022count\u0022: 20,\n  \u0022search\u0022: \u0022acme\u0022,\n  \u0022includeApi\u0022: true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    },
    {
      "name": "Service status",
      "item": [
        {
          "name": "Service status",
          "request": {
            "auth": {
              "type": "noauth"
            },
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/status",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "status"
              ]
            },
            "description": "Operating status of every validation service. No API key required."
          }
        }
      ]
    }
  ]
}