{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f2cd52d2-1c85-4381-a3d6-508a97d6ba43","name":"TazAPI Advanced","description":"**TazAPI Advanced** (Version 2) is a collection of RESTful APIs providing background screening services. The API can also manage Consumer Reporting Agency (CRA) resources. TazAPI Basic (version 1) can be found [here](https://tazworks.com/api/api-v1/).\n\n##### Register:\n\n1. [Register](https://developer.tazworks.com/pages/signup) for an account in the Developer Portal\n    \n2. Create an application\n    \n3. Obtain an API token\n    \n\n##### Create a Background Check:\n\n1. Use the API sandbox - [https://api-sandbox.instascreen.net](https://api-sandbox.instascreen.net)\n    \n2. [Choose a client](#c47ce9ef-cd06-4d6d-92c1-fe90a9c4c469)\n    \n3. [Choose a Product](#29146a6f-07cd-4440-91be-2c8a0c79e6de) (Client Products for Order)\n    \n4. [Create an applicant](#61f355d3-bf8a-4909-88d5-e486228394e5)\n    \n5. [Place background check](#8a0ecd1d-496d-46b7-b45c-a26553bf5a49) (Submit Order)\n    \n\n##### Make Your Life Easier:\n\n1. [Get Postman](https://www.postman.com/downloads/)\n    \n2. Click\n    \n    <img src=\"https://run.pstmn.io/button.svg\" alt=\"Run in Postman\">\n    \n3. Set environment variables\n    \n    - {host} = [https://api-sandbox.instascreen.net](https://api-sandbox.instascreen.net) (API sandbox)\n        \n    - {jwt-token} = your.application.token\n        \n4. Issue API requests\n    \n\n# Authentication\n\nA valid [JSON Web Token](https://en.wikipedia.org/wiki/JSON_Web_Token) (JWT) must be included in the Authorization header of each API request. Get an API token from a registered [API Application](https://docs.developer.tazworks.com/?version=latest#applications). All requests must use the HTTPS scheme with Bearer Authentication.\n\n# Developer Portal\n\n[Register](https://developer.tazworks.com/pages/signup) for an account in the Developer Portal to obtain API tokens and manage [API applications](https://docs.developer.tazworks.com/?version=latest#applications) (test and production). In the Developer Portal, a sample API application exists to execute API requests within a sandbox environment.\n\n# Test Applicants\n\nInstascreen provides two test applicants that can be used for testing purposes. When used in a production environment, no charges will be incurred.\n\nThe test applicants are identified by their social security numbers. Canned results will be returned. These test applicants work with most search types.\n\n| Field | Description |\n| --- | --- |\n| **SSN** | 111-22-3333 |\n| **First Name** | Joe |\n| **Last Name** | Clean |\n| **Results** | Clear / Good Results |\n| \\--- | \\--- |\n| **SSN** | 333-22-1111 |\n| **First Name** | Hank |\n| **Last Name** | Mess |\n| **Results** | Records / Bad Results |\n\n# Applications\n\nAll API interactions begin with an API application. An API application specifies which API endpoints can be used and provides access to CRA resources. In addition, API tokens are generated from an application. Applications are created in the [TazAPI Developer Portal](https://developer.tazworks.com/pages/login).\n\n# Clients\n\nThe TazAPI serves many Consumer Reporting Agencies (CRA). CRAs offer background screening services to various clients. A client identifier (GUID) is required for most API endpoints. To get a list of clients and their identifier use the **All Clients** endpoint.\n\n# Responses\n\nAll responses will be in JSON format. Each response will contain a valid HTTP status code.\n\n### Error Responses\n\nAll error responses will contain a `code` and a `message`. The `code` is for programmatic handling of the error. The `message` field will contain a readable explanation of the issue to help you resolve the issue. The error response may also contain an optional `fields` list of specific fields and the error messages related to those fields. In the case of the `fields` being used, the `message` may be left blank, as the field contains the specific error messages.\n\nExample of an error message without field-specific errors.\n\n```\n{\n\"code\": \"RESOURCE_NOT_FOUND\",\n\"message\": \"Client with the given identifier could not be found.\"}\n\n ```\n\nExample of an error response containing field-specific errors.\n\n```\n{\n\"code\": \"VALIDATION_EXCEPTION\",\n\"message\": null,\n\"fields\": {\n    \"copySections\": [\n        \"Please define the copySections that you want copied from another client.  The options are FEES, BILLING, PREFERENCES, PRODUCTS, and DISCLOSURES.\"\n    ],\n    \"copyClientGuid\": [\n        \"A client could not be found with this identifier.\"\n    ]\n}}\n\n ```\n\n# Data Format\n\n### Dates\n\nWhenever time is included in a date, we will use [Epoch](https://en.wikipedia.org/wiki/Unix_time) time, or the number of miliseconds since January 1, 1970, 00:00:00 GMT.\n\nWhen time is not included in dates (e.g., when providing the start date of employment), the date should be a string in yyyy-MM-dd format.\n\n### Phone Numbers\n\nUnless otherwise specified, all phone and fax numbers should be formatted as (###) ###-####. Phone number extensions are a string and can be preceeded by an 'x' (e.g., 1234, x1234).\n\n# Rate Limiting\n\nEach application has throttling and usage limits. If these limits are exceeded, an HTTP 429 response code will be returned with a JSON-formatted response.\n\n### Limits\n\n- 5 requests per second, with a burst throttle limit of 10 requests per second\n    \n- 20,000 requests per day\n    \n\nA request may be submitted for an increase should these limits prove insufficient for high-load API application instances. Contact API Support with your request.\n\n# Custom Interface\n\nIf you'd like to create your own interface for communicating with our API, these are some things you should consider:\n\n- how to define the credentials to use\n    \n- how to add the required authorization token\n    \n- how to select the action to perform\n    \n- how to provide the JSON data required for that action\n    \n- how to capture the success and error responses","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"32697839","team":6010576,"collectionId":"f2cd52d2-1c85-4381-a3d6-508a97d6ba43","publishedId":"2sB3BGH9bv","public":true,"publicUrl":"https://docs.developer.tazworks.com","privateUrl":"https://go.postman.co/documentation/32697839-f2cd52d2-1c85-4381-a3d6-508a97d6ba43","customColor":{"top-bar":"f9f9f9","right-sidebar":"0066a3","highlight":"90ce4d"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/c4b5760d-f391-48cd-ac3d-0dfbb53e4c18/TWljcm9zb2Z0VGVhbXMtaW1hZ2UgKDc2KSAxLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/ace740b8-103d-4b2f-a7bb-6d8713b28c9a/VGF6V29ya3MgTWFpbiBMb2dvIENvbG9yLTEwMDBwaXhlbHMucG5n","colors":{"top-bar":"f9f9f9","right-sidebar":"0066a3","highlight":"90ce4d"}}]}},"version":"8.10.1","publishDate":"2026-02-05T18:45:59.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/ace740b8-103d-4b2f-a7bb-6d8713b28c9a/VGF6V29ya3MgTWFpbiBMb2dvIENvbG9yLTEwMDBwaXhlbHMucG5n","logoDark":"https://content.pstmn.io/c4b5760d-f391-48cd-ac3d-0dfbb53e4c18/TWljcm9zb2Z0VGVhbXMtaW1hZ2UgKDc2KSAxLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/da8c9d8c3e48e05bfde4ca53cb461f85a9830664246d9296bcb40f696525280a","favicon":"https://tazworks.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.developer.tazworks.com/view/metadata/2sB3BGH9bv"}