Responses – TazWorks

TazAPI Basic

Error Responses

Following is an example of the response XML that would be immediately returned in the event of an error condition on the Initial Request. Note that the status is x:error and that the ErrorCode element contains a numeric error code, and the ErrorDescription element contains a textual description of the error condition.

<?xml version="1.0"?>
<BackgroundReports>
  <BackgroundReportPackage>
    <ReferenceId>some_id_value</ReferenceId>
    <ScreeningStatus>
      <OrderStatus>x:error</OrderStatus>
    </ScreeningStatus>
    <ErrorReport>
      <ErrorCode>4</ErrorCode>
      <ErrorDescription>Invalid username and/or password.</ErrorDescription>
    </ErrorReport>
  </BackgroundReportPackage>
</BackgroundReports>

Error Codes

Some of the error codes below are followed by a description of the problem. 101 = Unexpected error.
109 = Requested product type not available to end-user client.
110 = Invalid XML document, elements and/or attributes.
111 = Requested screening type/qualifier not supported.
112 = Invalid and/or missing data values.
119 = Credit card transaction failed.
120 = Invalid login transaction.
121 = Missing Screening element(s).
122 = Requested product not configured to allow spouse.
123 = Requested client/product not configured to allow QuickApp orders.
124 = Missing CreditCard element(s) required by client configuration.
125 = Missing and/or invalid ‘action’ attribute.
126 = Missing, invalid and/or unauthorized ‘OrderId’ element.
127 = Requested product not configured with any DEFault or REQuired searches.
128 = Requested client not configured to allow Substitute End User orders.
129 = File attachment count exceeds CRA attachment limit.
130 = File attachment size exceeds maximum.
131 = Invalid value submitted for California Credit Disclosure Code.
132 = Invalid user.
133 = Requesting user not found.
134 = Requesting user is not uniquely identified by client and name.
135 = Invalid requesting user.
136 = Invalid requesting client.
137 = Invalid linked applicant.
138 = Requested client is not configured as taxable.
139 = Requested order is expired.
140 = Order status of requested order is invalid.
141 = Requested client is not configured to ‘Allow Add to Order’.
142 = Requested client is not configured to ‘Allow Additional Searches’.
143 = Requested search does not allow Additional Searches.
144 = Requested screening not found for this order.
145 = Requested screening requires ‘True’ value for ConsentReceived.
146 = Cannot create QuickApp with incomplete e-mail address information. QuickApp is missing e-mail from address information!

Pending Response

Following is an example of the response XML that would be immediately returned in the event of successful submission of the Initial Request. Note that OrderId is the unique identifier for that order, and should be used when submitting status requests or in other ways referencing the submitted order.

Add Your Heading Text Here

<?xml version="1.0"?>
<BackgroundReports>
  <BackgroundReportPackage>
    <ReferenceId>some_id_value</ReferenceId>
    <OrderId>12358</OrderId>
    <ScreeningStatus>
      <OrderStatus>x:pending</OrderStatus>
    </ScreeningStatus>
  </BackgroundReportPackage>
</BackgroundReports>

Applicant Interface Response

Following is an example of the response XML that would be immediately returned in the event of successful submission of an Applicant Interface Initial Request (i.e. x:interface is submitted with a value of “Applicant”). Note that the URL returned in the ApplicantInterfaceURL element is the same URL that will be emailed to the applicant. The applicant follows this link to a page wherein they enter his or her personal data for the screening. The screening report remains in the x:app_pending status until the applicant has completed the data entry.

<?xml version="1.0"?>
<BackgroundReports>
  <BackgroundReportPackage>
    <ReferenceId>some_id_value</ReferenceId>
    <OrderId>12358</OrderId>
    <ScreeningStatus>
      <OrderStatus>x:app_pending</OrderStatus>
    </ScreeningStatus>
    <ApplicantInterfaceURL>https://demo.instascreen.net/s...</ApplicantInterfaceURL>
  </BackgroundReportPackage>
</BackgroundReports>