API Applications

In order to access and use the API, you must first create an API application in the API Console. An API application is a managed software integration between a 3rd party system and the TazWorks Platform. You may create one or more applications.

• Choose which APIs to use
• Configure Webhook subscriptions
• Configure IP address whitelist
• Manage API authentication tokens
• Register CRAs to use the application

CRA Data Access Control

The TazWorks Platform serves many CRAs and data vendors. Access to CRA or vendor data is strictly controlled and monitored. To protect the end customer, CRAs control which API applications can access data through a registration and approval process. For instance, through the API application, a CRA might restrict API calls to a single client's data, or a single product.

Order

The most common use of the API is for Orders. When given access to the Order API, you will be able to:

• Create, update, and delete Applicants
• Retrieve a list clients that you'd like to place orders for
• Retrieve client products that you'd like to order
• Place orders with applicant data and client products
• Retrieve order statuses and results
• Retrieve search statuses and results

Client

For those who need more control over the client structure and hierarchy via API, the Client API is for you.

• Create clients
• Update clients
• Delete clients
• Manage client hierarchies
• Manage client preferences

CRA

Coming in a future release of the API.

Create an Applicant

Before submitting an order, you will create an applicant. You can add professional licenses, references, education and employment information about the applicant. You can specify addresses and any aliases they have used. The information you decide to provide should be determined by the type of searches you want to perform. For example, an employment verification search will need employment information. If you submit an order and the system is missing information, the API will tell you what information is needed. Add the missing information to the applicant and submit the order again. The information required for a search will also be affected by the CRA preferences for required fields. The API will prompt you for any required information.

Because an applicant is stored separately from an order, you can provide more information than will be required for a specific search. This may help if you intend to submit further searches in the future for that applicant.

Use the Applicant endpoints to create and populate information for an applicant.

Choose Client Product

Client Products are needed before submitting an order. The client product defines which searches will be included in an order and whether or not the order can use QuickApp. You can get a list of a client's existing client products or choose to make new client products.

• Use the All Base Products endpoint to see the available CRA products that can be used in making a client product.
• Use the Search Fields endpoint to see what information will be required for a particular client product.
• See all Client Product endpoints.

Submit an Order

Once you have an applicant and a client product, you can submit an order. The type of information you include when submitting an order will depend on the type of searches which are included in the client product and the preferences for orderering that are associated with the client. For example, your client might require that you provide an authorization form or certify that you have permissible purpose to submit the order. An Occupational Health search may require additional collection site information. The Submit Order documentation gives you detailed information on these additional pieces of information and how to include them.

You can retrieve information about orders, add and retrieve attachments to orders, and send out QuickApp notifications to applicants. For tenant type orders you can choose to group co-applicants together and notify them once the order has been set-up.

Use the Orders endpoints to perform actions related to orders.