> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# TazWorks

> How to set up the TazWorks connector, plus the actions that are available.

![TazWorks](data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20viewBox%3D%220%200%2024%2024%22%3E%3Crect%20width%3D%2224%22%20height%3D%2224%22%20rx%3D%228%22%20fill%3D%22%23D5D4D2%22%2F%3E%3Crect%20x%3D%228%22%20y%3D%228%22%20width%3D%228%22%20height%3D%228%22%20rx%3D%222.667%22%20fill%3D%22%23A19F9E%22%2F%3E%3C%2Fsvg%3E)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/tazworks/changelog.md)

[83 actions](#actions) · 1 auth method

Background Checks
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Token · Connector Profile](https://docs.stackone.com/connectors/tazworks/guides/connector-profile/api-token.md)
>
> Authenticate with a JWT API token generated from an API Application in the TazAPI Developer Portal.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Token · Link Account](https://docs.stackone.com/connectors/tazworks/guides/link-account/api-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

83 actions

ActionDescription

All Addresses`tazworks_list_addresses`

Retrieve all addresses for an applicant

Single Address`tazworks_get_address`

Retrieve a specific address for an applicant

Create Address`tazworks_create_address`

Create an address for an applicant

Update Address`tazworks_update_address`

Update an existing address for an applicant

Delete Address`tazworks_delete_address`

Delete an address for an applicant

All Aliases`tazworks_list_aliases`

Retrieve all aliases for an applicant

Single Alias`tazworks_get_alias`

Retrieve a specific alias for an applicant

Create Alias`tazworks_create_alias`

Create an alias for an applicant

Update Alias`tazworks_update_alias`

Update an existing alias for an applicant

Delete Alias`tazworks_delete_alias`

Delete an alias for an applicant

All Education`tazworks_list_education`

Retrieve all education entries recorded for an applicant

Single Education`tazworks_get_education`

Retrieve a specific education entry for an applicant

Create Education`tazworks_create_education`

Create an education entry for an applicant

Update Education`tazworks_update_education`

Update an existing education entry for an applicant

Delete Education`tazworks_delete_education`

Delete an education entry for an applicant

All Employment`tazworks_list_employment`

Retrieve all employment entries recorded for an applicant

Single Employment`tazworks_get_employment`

Retrieve a specific employment entry for an applicant

Create Employment`tazworks_create_employment`

Create a new employment entry for an applicant

Update Employment`tazworks_update_employment`

Update an existing employment entry for an applicant

Delete Employment`tazworks_delete_employment`

Delete an employment entry for an applicant

All Licenses`tazworks_list_licenses`

Retrieve a list of all licenses for an applicant

License Formats`tazworks_list_license_formats`

Retrieve the catalog of valid license number formats by state

Single License`tazworks_get_license`

Retrieve a specific applicant license by its identifier

Create License`tazworks_create_license`

Create a new license record for an applicant

Update License`tazworks_update_license`

Update an existing applicant license by its identifier

Delete License`tazworks_delete_license`

Permanently delete an applicant license by its identifier

Applicant Orders`tazworks_list_applicant_orders`

Get all the orders for an applicant

All References`tazworks_list_references`

Retrieve a list of all references for an applicant

Single Reference`tazworks_get_reference`

Retrieve a specific applicant reference by its identifier

Create Reference`tazworks_create_reference`

Create a new reference record for an applicant

Update Reference`tazworks_update_reference`

Update an existing applicant reference by its identifier

Delete Reference`tazworks_delete_reference`

Permanently delete an applicant reference by its identifier

All Applicants`tazworks_list_applicants`

Retrieve a list of all applicants associated with a client

Single Applicant`tazworks_get_applicant`

Retrieve detail information about a single applicant

Create Applicant`tazworks_create_applicant`

Create a new applicant under a client

Update Applicant`tazworks_update_applicant`

Update an existing applicant's top-level fields

Delete Applicant`tazworks_delete_applicant`

Permanently delete an applicant record

All Attachments`tazworks_list_order_attachments`

Retrieve a list of order attachments

Single Attachment`tazworks_get_order_attachment`

Retrieve information about a specific order attachment including the Base64 encoded content of the file

Add MultipartFile Attachment`tazworks_add_order_attachment_file`

Add an attachment to an order as a multipart form-data file upload

Add Encoded Attachment`tazworks_add_order_attachment_encoded`

Add a base64 encoded attachment to an order

Delete Attachment`tazworks_delete_order_attachment`

Remove an attachment from an order

Client Descendants`tazworks_list_client_descendants`

Retrieve the downward hierarchy of sub-clients for a client

Client Ancestors`tazworks_list_client_ancestors`

Retrieve the upward hierarchy of parent clients for a client

Client Product Searches`tazworks_get_client_product_searches`

Retrieve the list of searches included on a client product

Search Fields`tazworks_get_search_fields`

Retrieve which pieces of information are needed for the searches included in a client product

Client & SubClient Products`tazworks_list_subclient_products`

List client products and their searches for a client and all of its subclients

All Base Products`tazworks_list_base_products`

Retrieve a list of available CRA base products that can be used to create client products

All Client Products`tazworks_list_client_products`

Retrieve a list of all products configured for a client

Client Product Detail`tazworks_get_client_product`

Retrieve detailed information about a single client product

Create Client Product`tazworks_create_client_product`

Create a new client product for a client

Update Client Product`tazworks_update_client_product`

Update an existing client product

Delete Client Product`tazworks_delete_client_product`

Delete a client product from a client's list of available products

All Users`tazworks_list_users`

Retrieve all users for a client account

Single User`tazworks_get_user`

Retrieve a single client user by ID

Create User`tazworks_create_user`

Create a new client user

Update User`tazworks_update_user`

Update an existing client user

Delete User`tazworks_delete_user`

Permanently delete a client user by ID

All Clients`tazworks_list_clients`

Retrieve a list of all top-level clients of the Consumer Reporting Agency

Single Client`tazworks_get_client`

Retrieve a single client's full record by its GUID

Create Client`tazworks_create_client`

Create a new client (CRA account holder)

Update Client`tazworks_update_client`

Update an existing client by replacing its full record

Delete Client`tazworks_delete_client`

Permanently delete a client and all information related to it

Notify Applicant`tazworks_notify_applicant`

Send the QuickApp invitation to the applicant of an order

Order Status`tazworks_get_order_status`

Retrieve the current status of an order

Cancel Order`tazworks_cancel_order`

Cancel an order

Add To Order`tazworks_add_to_order`

Add searches to an existing order

Order Results As PDF`tazworks_get_order_results_pdf`

Retrieve a link to the order results as a PDF file

Add Notes To Report`tazworks_add_report_notes`

Add client and/or report notes to a report

Set Report Decision`tazworks_set_report_decision`

Set or update the report decision for an order

Searches`tazworks_list_searches`

Retrieve the searches that are on an order

Search`tazworks_get_search`

Retrieve detail information about a search that is on an order

All Orders`tazworks_list_orders`

Retrieve a list of a client's orders

Single Order`tazworks_get_order`

Retrieve detailed information about a specific order

Submit Order`tazworks_create_order`

Submit a new background-check order for an applicant

Search Results`tazworks_get_search_results`

Retrieve the raw search results for a single search on an order

All Search Results`tazworks_list_search_results`

Retrieve the raw search results for all the searches on an order

Cancel Search`tazworks_cancel_search`

Cancel a search on an order

Set Search Status`tazworks_set_search_status`

Set the status for a search on an order

Add Notes To Search`tazworks_add_search_notes`

Add internal and/or pending notes to a search

User Default Permissions`tazworks_get_user_default_permissions`

Retrieve the default permissions assigned to new client users

Add Permissions`tazworks_add_user_permissions`

Grant additional permissions to a client user

Remove Permissions`tazworks_remove_user_permissions`

Revoke permissions from a client user


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.