TazAPI Basic

Request Examples

Initial Request

Following is an example request XML to order a background screening report named “demo product”. If an element and its data are in bold, it indicates that the element is required. Required elements within the Screenings elements apply only to the enclosing screening. 
<?xml version="1.0"?>
<BackgroundCheck userId="XML_User_Name" password="*********">
  <BackgroundSearchPackage action="submit" type="demo product">
    <ReferenceId>some_id_value</ReferenceId>
    <PersonalData>
      <PersonName>
        <GivenName>John</GivenName>
        <MiddleName>Q</MiddleName>
        <FamilyName>Test</FamilyName>
      </PersonName>
      <Aliases>
        <PersonName>
          <GivenName>Jack</GivenName>
          <MiddleName>Quigley</MiddleName>
          <FamilyName>Example</FamilyName>
        </PersonName>
      </Aliases>
      <DemographicDetail>
        <GovernmentId issuingAuthority="SSN">123456789</GovernmentId>
        <GovernmentId jurisdiction="UT" issuingAuthority="DMV">123456789</GovernmentId>
        <DateOfBirth>1973-12-25</DateOfBirth>
      </DemographicDetail>
      <PostalAddress>
        <PostalCode>83201</PostalCode>
        <Region>UT</Region>
        <Municipality>Salt Lake City</Municipality>
        <DeliveryAddress>
          <AddressLine>1234 Main Street</AddressLine>
        </DeliveryAddress>
      </PostalAddress>
      <EmailAddress>[email protected]</EmailAddress>
      <Telephone>801-789-4229</Telephone>
    </PersonalData>
    <Screenings>
      <!-- ** Identity Development Searches ** -->
      <!—Credit -->
      <Screening type="credit">
        <Vendor score="yes" fraud="yes">Experian</Vendor>
      </Screening>
      <!—Social Security Search -->
      <Screening type="ssn">
        <Vendor type="idsearchplus" high_risk_fraud_alert="yes">transUnion</Vendor>
      </Screening>
      <!—Person Search -->
      <Screening type="personsearch">
        <Vendor>OMNI_ROUTING</Vendor>
      </Screening>
      <!—Repository Custom Search -->
      <Screening type="custom" qualifier="repository" name="Custom Search Name">
      </Screening>
      <!-- ** Investigative Searches ** -->
      <!—State Criminal Court Search -->
      <Screening type="criminal" qualifier="statewide">
        <Region>PA</Region>
      </Screening>
      <!—County Criminal -->
      <Screening type="criminal" qualifier="county">
        <Region>WA</Region>
        <County>KING</County>
      </Screening>
      <!—County Civil -->
      <Screening type="civil" qualifier="county">
        <Region>WA</Region>
        <County>KING</County>
      </Screening>
      <!—Federal Criminal -->
      <Screening type="criminal" qualifier="federal">
        <Region>PA</Region>
        <District>Middle</District>
      </Screening>
      <!—International Criminal -->
      <Screening type="criminal" qualifier="international">
        <Region>ALBANIA</Region>
      </Screening>
      <!—National Criminal Database Search -->
      <Screening type="criminal" qualifier="national">
      </Screening>
      <!—State Criminal Database Search -->
      <Screening type="criminal" qualifier="singlestate">
        <Region>NM</Region>
      </Screening>
      <!-- Global Security Watch List -->
      <Screening type="criminal" qualifier="security">
      </Screening>
      <!—State Rental Records Database Search -->
      <Screening type="eviction" qualifier="singlestate">
        <Region>NM</Region>
      </Screening>
      <!—Investigative Custom Search -->
      <Screening type="custom" qualifier="investigative" name="Custom Search Name">
      </Screening>
      <!-- ** Verification Searches ** -->
      <!—Professional Reference -->
      <Screening type="reference" qualifier="professional">
        <Contact>
          <PersonName>
            <FormattedName>Yuan Li Xian</FormattedName>
          </PersonName>
          <ContactMethod>
            <Telephone>801-444-5544</Telephone>
          </ContactMethod>
          <Relationship>Supervisor</Relationship>
        </Contact>
      </Screening>
      <!—Personal Reference -->
      <Screening type="reference" qualifier="personal">
        <Contact>
          <PersonName>
            <FormattedName>Yolanda Ortega</FormattedName>
          </PersonName>
          <ContactMethod>
            <Telephone>505-292-3969</Telephone>
          </ContactMethod>
          <Relationship>Best Friend Forever</Relationship>
        </Contact>
      </Screening>
      <!—Resident -->
      <Screening type="resident">
        <StartDate>2005-06-01</StartDate>
        <ContactInfo>
          <PersonName>
            <FormattedName>Ramona Propietario</FormattedName>
          </PersonName>
          <Telephone>505-299-5527</Telephone>
          <PostalAddress>
            <PostalCode>87111</PostalCode>
            <Region>NM</Region>
            <Municipality>Albuquerque</Municipality>
            <DeliveryAddress>
              <AddressLine>3204 Lucerne NE</AddressLine>
            </DeliveryAddress>
          </PostalAddress>
        </ContactInfo>
      </Screening>
      <!—Worker’s Compensation Report -->
      <Screening type="workcomp">
        <Region>TX</Region>
      </Screening>
      <!—Employment -->
      <Screening type="employment">
        <OrganizationName>Burger Shack</OrganizationName>
        <Title>Fry Cook</Title>
        <JobLevelInfo>Full-time</JobLevelInfo>
        <StartDate>2005-06-01</StartDate>
        <EndDate>2006-04-15</EndDate>
        <CompensationDollars>6.50/hr</CompensationDollars>
        <CompensationFrequency>Hourly</CompensationFrequency>
        <ContactInfo>
          <PersonName>
            <FormattedName>John Bossman</FormattedName>
          </PersonName>
          <Telephone>801-123-4567</Telephone>
          <PostalAddress>
            <PostalCode>84020</PostalCode>
            <Region>UT</Region>
            <Municipality>Draper</Municipality>
            <DeliveryAddress>
              <AddressLine>1192 Draper Parkway #401</AddressLine>
            </DeliveryAddress>
          </PostalAddress>
        </ContactInfo>
      </Screening>
      <!-- ** Credentials Searches ** -->
      <!—Instant Driving Records Search -->
      <Screening type="license" qualifier="imvPersonal">
        <Region>CT</Region>
        <SearchLicense>
          <License>
            <LicenseNumber>S32106445</LicenseNumber>
          </License>
        </SearchLicense>
      </Screening>
      <!—Education -->
      <Screening type="education">
        <Region>UT</Region>
        <EducationHistory>
          <SchoolOrInstitution>
            <SchoolName>UNIVERSITY OF UTAH</SchoolName>
            <PostalAddress>
              <Municipality>Draper</Municipality>
              <Region>UT</Region>
              <PostalCode>84020</PostalCode>
              <DeliveryAddress>
                <AddressLine>1192 Draper Parkway #401</AddressLine>
              </DeliveryAddress>
            </PostalAddress>
            <Degree degreeType="bachelors">
              <DegreeName>COMMUNICATIONS</DegreeName>
            </Degree>
            <DatesOfAttendance>
              <StartDate>
                <StringDate>2002-09 TO 2006-01</StringDate>
              </StartDate>
            </DatesOfAttendance>
          </SchoolOrInstitution>
        </EducationHistory>
      </Screening>
      <!-- ** Other Services Searches ** -->
      <!—Substance Abuse Detection -->
      <Screening type="drug">
        <Panel>10 Panel</Panel>
        <PermissiblePurpose>Pre-Employment</PermissiblePurpose>
      </Screening>
      <Screening type="scorecard" />
      <AdditionalItems type="x:interface">
        <Text>Applicant|Instant</Text>
      </AdditionalItems>
      <!—Integration Type -->
      <AdditionalItems type="x:integration_type">
        <Text>CompanyABC</Text>
      </AdditionalItems>
      <!—monthly rent required for scorecard screenings -->
      <AdditionalItems type="x:monthly_rent">
        <Text>750</Text>
      </AdditionalItems>
      <!—monthly income required for scorecard screenings -->
      <AdditionalItems type="x:monthly_income">
        <Text>2850</Text>
      </AdditionalItems>
      <!—Postback URL required for push results delivery -->
      <AdditionalItems type="x:postback_url">
        <Text>http://www.submittee.com/listener/</Text>
      </AdditionalItems>
      <AdditionalItems type="x:postback_username">
        <Text>username</Text>
      </AdditionalItems>
      <AdditionalItems type="x:postback_password">
        <Text>password</Text>
      </AdditionalItems>
      <AdditionalItems type="x:postback_databaseset">
        <Text>databaseset</Text>
      </AdditionalItems>
      <!—Returned screening URL includes embedded credentials. Default is FALSE -->
      <AdditionalItems type="x:embed_credentials">
        <Text>TRUE|FALSE</Text>
      </AdditionalItems>
      <AdditionalItems type="x:ordernotes">
        <Text>
            Applicant is my brother-in-law – please be extra thorough.
        </Text>
      </AdditionalItems>
    </Screenings>
  </BackgroundSearchPackage>
</BackgroundCheck>

Requesting a Report Decision

Initial Request

<Screenings ...>
...
  <AdditionalItems type="x:decision_model">
    <Text>REPORT</Text>
  </AdditionalItems>
</Screenings>

StatusCheck Response

...
<ScreeningStatus>
  <OrderStatus flag="FALSE">x:pending</OrderStatus>
  <OrderDecision>Approved (per client specifications</OrderDecision>
</ScreeningStatus>
...

Values for OrderDescision

OrderDecision Value Description
- Report Decision not set
Approved (per client specifications)
Pending (per client specifications)
Negative (per client specifications)
Review
Dispute
Pre-Adverse (per client specifications)
Declined (per client specifications)
Opt Out (per client specifications)
Conditional Offer (per client specifications)

Requesting a Scorecard

Initial Request

<Screenings ...>
  ...
  <AdditionalItems type="x:decision_model">
    <Text>SCORECARD</Text>
  </AdditionalItems>
</Screenings>

StatusCheck Response

...
<ScreeningStatus>
  <OrderStatus flag="FALSE">x:ready</OrderStatus>
  <OrderDecision>PENDING REVIEW</OrderDecision>
</ScreeningStatus>
...

Values for OrderDecision

OrderDecision Value Description
DECISION LOOKUP FAILED an error occurred retrieving the scorecard decision
PENDING REVIEW scorecard decision had not been set yet
FAIL the scorecard decision was set to FAIL
PASS the scorecard decision was set to PASS
CONDITIONAL XXXXXXXXXXXXXX the scorecard decision was set to CONDITIONAL with a reason like CONDITIONAL Double Deposit

Ordering by Package Name

<?xml version="1.0"?>
<BackgroundCheck userId="XML_User_Name" password="*********">
  <BackgroundSearchPackage action="submit" type="DEMO PKG">
    <ReferenceId>123</ReferenceId>
    <PersonalData>
      <PersonName>
        <GivenName>HANK</GivenName>
        <FamilyName>MESS</FamilyName>
        <MiddleName></MiddleName>
      </PersonName>
      <EmailAddress>[email protected]</EmailAddress>
    </PersonalData>
    <Screenings useConfigurationDefaults="yes">
    </Screenings>
  </BackgroundSearchPackage>
</BackgroundCheck>

Ordering QuickApp

<?xml version="1.0"?>
<BackgroundCheck userId="XML_User_Name" password="*********">
  <BackgroundSearchPackage action="submit" type="DEMO PKG">
    <ReferenceId>123</ReferenceId>
    <PersonalData>
      <PersonName>
        <GivenName>HANK</GivenName>
        <FamilyName>MESS</FamilyName>
        <MiddleName></MiddleName>
      </PersonName>
      <EmailAddress>[email protected]</EmailAddress>
    </PersonalData>
    <Screenings useConfigurationDefaults="yes">
      <AdditionalItems type="x:interface">
        <Text>Applicant</Text>
      </AdditionalItems>
    </Screenings>
  </BackgroundSearchPackage>
</BackgroundCheck>

TazWorks

All Rights Reserved © 2020