Actions

83 actions

Action

Description

All Addresses

Retrieve all addresses for an applicant

Single Address

Retrieve a specific address for an applicant

Create Address

Create an address for an applicant

Update Address

Update an existing address for an applicant

Delete Address

Delete an address for an applicant

All Aliases

Retrieve all aliases for an applicant

Single Alias

Retrieve a specific alias for an applicant

Create Alias

Create an alias for an applicant

Update Alias

Update an existing alias for an applicant

Delete Alias

Delete an alias for an applicant

All Education

Retrieve all education entries recorded for an applicant

Single Education

Retrieve a specific education entry for an applicant

Create Education

Create an education entry for an applicant

Update Education

Update an existing education entry for an applicant

Delete Education

Delete an education entry for an applicant

All Employment

Retrieve all employment entries recorded for an applicant

Single Employment

Retrieve a specific employment entry for an applicant

Create Employment

Create a new employment entry for an applicant

Update Employment

Update an existing employment entry for an applicant

Delete Employment

Delete an employment entry for an applicant

All Licenses

Retrieve a list of all licenses for an applicant

License Formats

Retrieve the catalog of valid license number formats by state

Single License

Retrieve a specific applicant license by its identifier

Create License

Create a new license record for an applicant

Update License

Update an existing applicant license by its identifier

Delete License

Permanently delete an applicant license by its identifier

Applicant Orders

Get all the orders for an applicant

All References

Retrieve a list of all references for an applicant

Single Reference

Retrieve a specific applicant reference by its identifier

Create Reference

Create a new reference record for an applicant

Update Reference

Update an existing applicant reference by its identifier

Delete Reference

Permanently delete an applicant reference by its identifier

All Applicants

Retrieve a list of all applicants associated with a client

Single Applicant

Retrieve detail information about a single applicant

Create Applicant

Create a new applicant under a client

Update Applicant

Update an existing applicant's top-level fields

Delete Applicant

Permanently delete an applicant record

All Attachments

Retrieve a list of order attachments

Single Attachment

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

Add MultipartFile Attachment

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

Add Encoded Attachment

Add a base64 encoded attachment to an order

Delete Attachment

Remove an attachment from an order

Client Descendants

Retrieve the downward hierarchy of sub-clients for a client

Client Ancestors

Retrieve the upward hierarchy of parent clients for a client

Client Product Searches

Retrieve the list of searches included on a client product

Search Fields

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

Client & SubClient Products

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

All Base Products

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

All Client Products

Retrieve a list of all products configured for a client

Client Product Detail

Retrieve detailed information about a single client product

Create Client Product

Create a new client product for a client

Update Client Product

Update an existing client product

Delete Client Product

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

All Users

Retrieve all users for a client account

Single User

Retrieve a single client user by ID

Create User

Create a new client user

Update User

Update an existing client user

Delete User

Permanently delete a client user by ID

All Clients

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

Single Client

Retrieve a single client's full record by its GUID

Create Client

Create a new client (CRA account holder)

Update Client

Update an existing client by replacing its full record

Delete Client

Permanently delete a client and all information related to it

Notify Applicant

Send the QuickApp invitation to the applicant of an order

Order Status

Retrieve the current status of an order

Cancel Order

Cancel an order

Add To Order

Add searches to an existing order

Order Results As PDF

Retrieve a link to the order results as a PDF file

Add Notes To Report

Add client and/or report notes to a report

Set Report Decision

Set or update the report decision for an order

Searches

Retrieve the searches that are on an order

Retrieve detail information about a search that is on an order

All Orders

Retrieve a list of a client's orders

Single Order

Retrieve detailed information about a specific order

Submit Order

Submit a new background-check order for an applicant

Search Results

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

All Search Results

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

Cancel Search

Cancel a search on an order

Set Search Status

Set the status for a search on an order

Add Notes To Search

Add internal and/or pending notes to a search

User Default Permissions

Retrieve the default permissions assigned to new client users

Add Permissions

Grant additional permissions to a client user

Remove Permissions

Revoke permissions from a client user