Submitting an XML Request

<LinkedApplicants>
   <OrderId>123</OrderId>
</LinkedApplicants>

<Screening type="custom" qualifier="repository"
name="REPOSITORY CUSTOM & TWO">
</Screening>

<Screening type="education">
  <Region>UT</Region>
  <EducationHistory>
    <SchoolOrInstitution>
      <SchoolName>UNIVERSITY OF UTAH</SchoolName>
      <ContactCode>UofU</ContactCode>
      <PostalAddress>
        <Municipality>Draper</Municipality>
        <Region>UT</Region>
        <PostalCode>84020</PostalCode>
        <DeliveryAddress>
          <AddressLine>1192 Draper Parkway #401</AddressLine>
        </DeliveryAddress>
      </PostalAddress>
      <Degree degreeType="bachelors">
        <DegreeName>COMMUNICATIONS; Graduated: Yes</DegreeName>
      </Degree>
      <DatesOfAttendance>
        <StartDate>
          <StringDate>2002-09 TO 2006-01</StringDate>
        </StartDate>
      </DatesOfAttendance>
    </SchoolOrInstitution>
  </EducationHistory>
</Screening>

<Screening type="license" qualifier="imvPersonal">
  <Region>UT</Region>
  <Duration>7</Duration>
  <SearchLicense>
    <License>
      <LicenseNumber>123456789</LicenseNumber>
    </License>
  </SearchLicense>
</Screening> 

<Screening type="healthcare_compliance" />

<Screening type="license" qualifier="professional" />

<Screening type="drug">
  <Panel>Panel Name</Panel>
  <PermissiblePurpose>Pre- Employment</PermissiblePurpose>
  <SpecimenId></SpecimenId>
</Screening>

<Screening type="drug">
  <Panel>Panel Name</Panel>
  <PermissiblePurpose>Pre- Employment</PermissiblePurpose>
  <SpecimenId></SpecimenId>
  <CollectionInfo>
    <SiteCode>UT076</SiteCode>
    <Observed>Yes</Observed>
    <SplitSpecimen>Yes</SplitSpecimen>
    <ExpirationDate>2017-10-01</ExpirationDate>
    <ExpirationTime>23:59:59</ExpirationTime>
    <ExpirationTimeZone>America/Los_Angeles</ExpirationTimeZone>
    <TestScheduler>Applicant</TestScheduler>
  </CollectionInfo>
</Screening>

<Screening type="personsearch" />

<Screening type="ssn" />

<Screening type="assumedname" />

<Screening type="bankruptcy" />

<Screening type="civil" qualifier="county" />

<Screening type="civil" qualifier="county" >
  <Region>NM</Region>
  <County>Sandoval</County>
</Screening>

<Screening type="criminal" qualifier="county" />

<Screening type="criminal" qualifier="county" >
  <Region>NM</Region>
  <County>Sandoval</County>
</Screening>

<Screening type="civil" qualifier="federal" >
  <Region>NM</Region>
  <District>New Mexico</District>
</Screening>

<Screening type="criminal" qualifier="federal" >
  <Region>New Mexico</Region>
  <District>New Mexico</District>
</Screening>

<Screening type="criminal" qualifier="security" />

<Screening type="criminal" qualifier="international" />

<Screening type="lienjudgment">
  <Region>NM</Region>
  <County>Sandoval</County>
</Screening>

<Screening type="criminal" qualifier="national_alias" />

<Screening type="criminal" qualifier="national" />

<Screening type="eviction" qualifier="national" />

<Screening type="sex_offender">
  <Region>CO</Region>
</Screening>

<Screening type="criminal" qualifier="statewide">
  <Region>CO</Region>
</Screening>

<Screening type="criminal" qualifier="singlestate">
  <Region>UT</Region>
</Screening>

<Screening type="eviction" qualifier="singlestate">
  <Region>UT</Region>
</Screening>

<Screening type="resident" verify="yes">
  <StartDate>2005-06-01</StartDate>
  <EndDate>2008-06-01</EndDate>
  <ContactInfo>
 <PersonName>
   <FormattedName>Ramona Propietario</FormattedName>
 </PersonName>
 <ContactCode>Romona</ContactCode>
 <Telephone>505-299-5527</Telephone>
 <Fax>801-999-8555</Fax>
 <EmailAddress>[email protected]</EmailAddress>
 <PostalAddress>
   <PostalCode>87111</PostalCode>
   <Region>NM</Region>
   <Municipality>Albuquerque</Municipality>
   <DeliveryAddress>
  <AddressLine>3204 Lucerne NE</AddressLine>
   </DeliveryAddress>
 </PostalAddress>
  </ContactInfo>
  <Comments>These are some resident comments.</Comments>
</Screening>

When an applicant has requested that we do not contact the property, the verify attribute should be set to “no”.

<Screening type="resident" verify="no">
...

<Screening type="employment" verify="yes">
  <OrganizationName>Burger Shack</OrganizationName>
  <ContactCode>BurgerShack</ContactCode>
  <Title>Fry Cook</Title>
  <JobLevelInfo>Full-time</JobLevelInfo>
  <StartDate>2005-05-05</StartDate>
  <EndDate>2005-06-16</EndDate>
  <!--Valid Frequencies: Hourly, Weekly, Monthly, 
Yearly, Annually, Contract -->
  <Compensation>21.50 Hourly</Compensation>
  <ReasonForLeaving>Moved to Texas</ReasonForLeaving>
  <ContactInfo>
 <PersonName>
   <FormattedName>Susan Boss</FormattedName>
 </PersonName>
 <Telephone>801-123-4567</Telephone>
 <Fax>801-999-9999</Fax>
 <EmailAddress>[email protected]</EmailAddress>
 <PostalAddress>
   <PostalCode>84020</PostalCode>
   <Region>UT</Region>
   <Municipality>Draper</Municipality>
   <DeliveryAddress>
  <AddressLine>1192 Main St</AddressLine>
   </DeliveryAddress>
 </PostalAddress>
  </ContactInfo>
</Screening>

When an applicant has requested that we do not contact the employer, the verify attribute should be set to “no”.

<Screening type="employment" verify="no">
...

<Screening type="reference" qualifier="personal">
  <Contact>
 <PersonName>
   <FormattedName>1 Yolanda Ortega</FormattedName>
 </PersonName>
 <ContactMethod>
   <Telephone>505-292-3969</Telephone>
   <Fax>801-FAX-PERS</Fax>
   <EmailAddress>[email protected]</EmailAddress>
 </ContactMethod>
 <Relationship>Mother</Relationship>
  </Contact>
  <Comments>This is my list of random comments.</Comments>
</Screening>

<Screening type="reference" qualifier="professional">
  <Contact>
 <PersonName>
   <FormattedName>1 Yuan Li Xian</FormattedName>
 </PersonName>
 <ContactMethod>
   <Telephone>801-444-5544</Telephone>
   <Fax>801-FAX</Fax>
   <EmailAddress>[email protected]</EmailAddress>
 </ContactMethod>
 <Relationship>Supervisor</Relationship>
  </Contact>
  <Comments>This is my list of random comments.</Comments>
</Screening>

<Screening type="reference">
  <Contact>
 <PersonName>
   <FormattedName>Plain Old Reference</FormattedName>
 </PersonName>
 <ContactMethod>
   <Telephone>123-123-1234</Telephone>
   <Fax>801-FAX-PLAIN</Fax>
   <EmailAddress>[email protected]</EmailAddress>
 </ContactMethod>
 <Relationship>Reference</Relationship>
  </Contact>
  <Comments>This is my list of random comments.</Comments>
</Screening>

<Screening type="workcomp" />

for submitting the California Credit Code override value. The validvalues for the override code are one of the following:

EXECUTIVE_EXEMPT | STATE_DEPT_JUST | LAW_ENFORCEMENT|REQUIRED_BY_LAW | ACCESS_TO_PII | ACCESS_TO_CASH | FINANCIAL_TXS | CONFIDENTIAL_INF

Example:

 <Screenings>
   ...
   <AdditionalItems type="x:california_credit_code">
  <Text>EXECUTIVE_EXEMPT</Text>
   </AdditionalItems>
 </Screenings>
 

The valid values for this code are one of the following:

SCORECARD: request that the Scorecard Decision be returned in the completed XML.

SCORECARD_PRO: request that the Scorecard Pro Decision be returned in the completed XML.

REPORT: request that the Report Decision be returned in the completed XML. The default values returned for REPORT are: Approved (per client specifications), Pending (per client specifications), Negative (per client specifications), Review, Dispute, Pre- Adverse (per client specifications), Declined (per client specifications), and Opt Out (per client specifications).

Controls whether the URLs returned for report access are encoded with embedded credentials to allow one-click viewing of the report, or if following the link will first require user authentication. Setting the value to “TRUE” will return URLs with the embedded credentials, setting the value to “FALSE” will return the link requiring authentication. If user access to the link will be provided outside of an authenticated system, suchas email, the latter is recommended.

***Starting Q2 of 2020 links with embedded credentials will only be active for 20 minutes. If a new link is needed, you will need to request this via the API Gateway. See “Example XML – Requesting Expiring URL Inquiry” on the “Determining Order Status” page for more details.***

This is required. It is used for identifying each integration type. Choose a string to identify your company/integration.

Example:

 <Screenings>
   ...
   <AdditionalItems type="x:integration_type">
  <Text>CompanyABC</Text>
   </AdditionalItems>
 </Screenings>

Controls into which workflow the order is placed. If omitted, the default behavior is “INSTANT“.

Value definitions:

“REVIEWED” = Order submission goes into the XML Ready queue for processing by CRA/client in InstaScreen.

INSTANT” = Order submission processes automatically according to InstaScreen configuration.

APPLICANT” = Order submission goes into Applicant Pending queue for data entry by the applicant. InstaScreenwill send email invitation to the applicant with a link and instructions for completing the data entry. The submission XML needs a minimum of the applicant’s name, email address, the requested Screening(s) and the QuickApp x:interface flag.

APPLICANT_NO_EMAIL” = Order submission goes into Applicant Pending queue for data entry by the applicant. InstaScreen will not send an email invitation to the applicant, so the third-party will need to communicate the link and instructions to the applicant.

Example:

 <BackgroundCheck userId="XML_User_Name" password="*********">
   <BackgroundSearchPackage action="submit" type="DEMO">
  <Screenings>
    ...
    <AdditionalItems type="x:interface">
   <Text>REVIEWED</Text>
    </AdditionalItems>
  </Screenings>
   </BackgroundSearchPackage>
 </BackgroundCheck>

Note that the QuickApp link comes back in the response XML for both the APPLICANT and APPLICANT_NO_EMAIL x:interface types.

In order to flag a requesting the report to return in PDF format, add the AdditionalItems element to the Screenings section of the original request XML. With that flag, the report view link that is returned in the XML completed notification will be for the PDF view of the report.

Example:

 ...
    <Screenings>
    ...
    <AdditionalItems type="x:postback_format">
     <Text>PDF</Text>
    </AdditionalItems>
  </Screenings>
   </BackgroundSearchPackage>
 </BackgroundCheck>

When using x:postback_url, if you want to suppress the x:partial messages, include x:postback_suppress_xpartial

The valid values for this code are one of the following: true or false

 <AdditionalItems type="x:postback_suppress_xpartial">
   <Text>true</Text>
 </AdditionalItems>
 

The gateway will post XML status notification messages to the client’s URL endpoint, if any, provided in x:postback_url. The XML message will be the value of a POST parameter named “Status“. The URL endpoint is simply a web page or web service hosted in the client’s environment that can accept and process the XML message according to the client’s business rules (e.g. updating a status column in the ATS, sending an alert, etc.). XML messages are sent when individual searches are completed on a report and when the overall report is completed. If credentials are provided in x:postback_username, x:postback_password, and/or x:postback_databaseset, those will be included in the XML message. If the client does not wish to receive XML messages, no value should be provided in x:postback_url.

TazWorks will not install any third-party security certificates in our testing, staging, or production environments. Integrators are required to use SSL Certificates signed by one of the Certificate Authorities included in the Sun Java SE 8.0_121 default trusted certificate keystore. This includes any intermediate or chained SSL certificate(s).

The post back url needs to use port 80 or 443.

Either yes or no.

The following searches are supported by x:return_xml_results: County

Criminal Records Search
Credit Report (Equifax, Experian, Transunion, and Acxiom)
Custom Searches Education Verification Employment Verification Instant Driving Records
National Criminal Database Alias Search National Criminal Database Search National Rental Records Database Search Person Search
Personal Reference Verification Professional Reference Verification PSP Crash And Inspection History Reference Verification
State Criminal Court Search State Criminal Database Search
State Rental Records Database Search Tenant Scorecard

 <AdditionalItems type="x:queue_consumer_disclosure">
   <Text>true</Text>
 </AdditionalItems>
 

Either yes or no.

Applicant’s name returned in a post back message.

*Needs to be approved and enabled by CRA before use.

Either yes or no.

Applicant’s address returned in a post back message.

*Needs to be approved and enabled by CRA before use.

Either yes or no.

Applicant’s SSN returned in a post back message.

*Needs to be approved and enabled by CRA before use.

Either yes or no.

Applicant’s Date of Birth returned in a post back message.

*Needs to be approved and enabled by CRA before use.

Either yes or no.

Applicant’s Drivers License number and state returned in a post back message.

*Needs to be approved and enabled by CRA before use.