Integrations & APIs

Standard API

Getting Started

XChange Advantage Standard API empowers customers to build seamless bi-directional HTTP/SOAP integrations to the First Advantage Screening platform.

Supported Protocols: XML over HTTPS (POST) and SOAP (Simple Object Access Protocol) over HTTPS (web services) transactions.  

Using XChange Advantage Standard API, you can integrate the following services from within your application:

  •  Manage Screening program  – User accounts, passwords, and profiles 
  •  Package Introspection – Get a list of Packages and Screening options available in your account  
  •  Screening Order – Initiate/update a Screening order or send e-mail invitation to Candidate to complete the application  
  •  View Status/Screening Results – On-demand pull of status and URL link to live report 
  •  Webhooks – Receive real-time post to your URL for case Status notifications and Screening results

All that is required is an API account on our system (available upon request). Our documentation will guide you with what you need to know to begin consuming the XChange Advantage Standard API on your development platform.

Screening Account / User Management

Account Management Methods

Account List – Retrieve all accounts/sub accounts configured for a screening program

Package Introspection – Retrieve all Screening packages configured for a given account

User Provisioning - Ability to create new users, update users (Access, Options and Groups)

User Profile Association - Ability to associate users to Profiles (Access control)

              



   
      ALL
   

Screening Order Models

XChange Advantage Standard API offers three screening ordering models:

One-Step Screening Order Model

The one-step process allows for a fully automated system-to-system interface.  When a request is received, the First Advantage system will create a screening order.

Two-Step Screening Order Model

The two-step process interfaces the XML services with Enterprise Advantage website.  The XML request is used to pre-populate a First Advantage order.

Candidate Invite Screening Order Model

Invite Candidate to complete their application in our Direct Advantage Candidate platform

              
<-- Sample XML SOAP request using the One-step Screening Order Model -->     
  
     
     
     
    
1967
     

Tutor
     
0
     
     

Math Department
     
     
     
9289102
     
<     
     
simple     
900000JAC
     
     
     
     
     
Mike
     
Schwartz
     
     
     
30328
     
GA    
 Atlanta
     
     

1 Concourse Parkway NE
     
Suite 200
     
     
     
     
777889999</Governm entId>     
1998-07-12
     
     
     
</BackgroundSearch Package>    
     
    

Screening Status And Report Viewing Methods

Get Link – Synchronous order results (On-Demand Pull) returns the case status and Link URL to the full Screening report. Link request can only be used once.

Get Status – Synchronous order status (On-Demand Pull): returns status and elements of a Screening report. also includes URL link to the Screening report.

              
  
  
Report< /Type>  
WPS-99999999
  
   
  
  
  
  

WPS-99999999
  
  
  
Math 
Department
 
  
  

9289102  
  
  
Simple< /UserId>  

900000JAC
  
  
  
  
  
MIKE
  
STEVE
  

SCHWARTZ
  
  
  
777889999
  
  
  
  

InProgress
  
  
  

https://enterprisetest.fadv.
com/pub/l/login/userLog
in.do?referer=https://enterp
risetest.fadvwpprod.staging.wpengine.com/pub/l/jsp/
menu/orderViewingMenu
FrameSet.jsp?key=xxxxxxxxx
  
  
  
  
  

InProgress
  
  
  
  
  

InProgress
  
  
  
  
</BackgroundReport Package>  

            

Webhooks

Notification Status 

Provides asynchronous Webhook real-time status notifications with configurable transformations of content, enable full detailed report results in notification content (HTML/XML),  Email status notifications also available

              
  
  
  
  
WPS-99999999
  
  
  
1967</Id Value>  
  
  
Submitted
  

01/05/2017 07:58:20 A.M.
  
  
  
  
  
MIKE
  
STEVE
  

SCHWARTZ
  
  
  

777-88-XXXX
  

XXXX-07-12
  
  
  
    

Math Department
  
  
    
9289102  
  
  
  
  
  
InProgress
  
  
  
  

https://enterprisetest.fadvwpprod.staging.wpengine.com
/pub/l/login/userLogin.do?Link
  
  
  
  
  

            

Errors

CodeDescription
100Invalid XML
200Invalid login
210User is locked
220Password is expired
240Account or user is disabled
250Invalid Order Account
300Invalid package
320Missing required value
500Error with request (This is a “catch-all” for unexpected errors )
              
      
250
    

Invalid 'OrderAccount'