0 added
0 removed
Original
2026-01-01
Modified
2026-03-01
1
<h3>Getting Started</h3>
1
<h3>Getting Started</h3>
2
<p>XChange Advantage Standard API empowers customers to build seamless bi-directional HTTP/SOAP integrations to the First Advantage Screening platform.</p>
2
<p>XChange Advantage Standard API empowers customers to build seamless bi-directional HTTP/SOAP integrations to the First Advantage Screening platform.</p>
3
<p>Supported Protocols: XML over HTTPS (POST) and SOAP (Simple Object Access Protocol) over HTTPS (web services) transactions. </p>
3
<p>Supported Protocols: XML over HTTPS (POST) and SOAP (Simple Object Access Protocol) over HTTPS (web services) transactions. </p>
4
<p>Using XChange Advantage Standard API, you can integrate the following services from within your application:</p>
4
<p>Using XChange Advantage Standard API, you can integrate the following services from within your application:</p>
5
<ul><li> Manage Screening program - User accounts, passwords, and profiles </li>
5
<ul><li> Manage Screening program - User accounts, passwords, and profiles </li>
6
<li> Package Introspection - Get a list of Packages and Screening options available in your account </li>
6
<li> Package Introspection - Get a list of Packages and Screening options available in your account </li>
7
<li> Screening Order - Initiate/update a Screening order or send e-mail invitation to Candidate to complete the application </li>
7
<li> Screening Order - Initiate/update a Screening order or send e-mail invitation to Candidate to complete the application </li>
8
<li> View Status/Screening Results - On-demand pull of status and URL link to live report </li>
8
<li> View Status/Screening Results - On-demand pull of status and URL link to live report </li>
9
<li> Webhooks - Receive real-time post to your URL for case Status notifications and Screening results</li>
9
<li> Webhooks - Receive real-time post to your URL for case Status notifications and Screening results</li>
10
</ul><p>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.</p>
10
</ul><p>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.</p>
11
<h3>Screening Account / User Management</h3>
11
<h3>Screening Account / User Management</h3>
12
<h4>Account Management Methods</h4>
12
<h4>Account Management Methods</h4>
13
<p><strong>Account List</strong> - Retrieve all accounts/sub accounts configured for a screening program</p>
13
<p><strong>Account List</strong> - Retrieve all accounts/sub accounts configured for a screening program</p>
14
<p><strong>Package Introspection</strong> - Retrieve all Screening packages configured for a given account</p>
14
<p><strong>Package Introspection</strong> - Retrieve all Screening packages configured for a given account</p>
15
<p><strong>User Provisioning</strong> - Ability to create new users, update users (Access, Options and Groups)</p>
15
<p><strong>User Provisioning</strong> - Ability to create new users, update users (Access, Options and Groups)</p>
16
<p><strong>User Profile Association</strong> - Ability to associate users to Profiles (Access control)</p>
16
<p><strong>User Profile Association</strong> - Ability to associate users to Profiles (Access control)</p>
17
<p><a>Click here for sample API code</a></p>
17
<p><a>Click here for sample API code</a></p>
18
<h3>Screening Order Models</h3>
18
<h3>Screening Order Models</h3>
19
<p>XChange Advantage Standard API offers three screening ordering models:</p>
19
<p>XChange Advantage Standard API offers three screening ordering models:</p>
20
<p><strong>One-Step Screening Order Model</strong></p>
20
<p><strong>One-Step Screening Order Model</strong></p>
21
<p>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.</p>
21
<p>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.</p>
22
<p><strong>Two-Step Screening Order Model</strong></p>
22
<p><strong>Two-Step Screening Order Model</strong></p>
23
<p>The two-step process interfaces the XML services with Enterprise Advantage website. The XML request is used to pre-populate a First Advantage order.</p>
23
<p>The two-step process interfaces the XML services with Enterprise Advantage website. The XML request is used to pre-populate a First Advantage order.</p>
24
<p><strong>Candidate Invite Screening Order Model</strong></p>
24
<p><strong>Candidate Invite Screening Order Model</strong></p>
25
<p>Invite Candidate to complete their application in our Profile Advantage Candidate platform</p>
25
<p>Invite Candidate to complete their application in our Profile Advantage Candidate platform</p>
26
<p><a>Click here for sample API code</a></p>
26
<p><a>Click here for sample API code</a></p>
27
<h3>Screening Status And Report Viewing Methods</h3>
27
<h3>Screening Status And Report Viewing Methods</h3>
28
<p><strong>Get Link</strong> - 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.</p>
28
<p><strong>Get Link</strong> - 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.</p>
29
<p><strong>Get Status</strong> - Synchronous order status (On-Demand Pull): returns status and elements of a Screening report. also includes URL link to the Screening report.</p>
29
<p><strong>Get Status</strong> - Synchronous order status (On-Demand Pull): returns status and elements of a Screening report. also includes URL link to the Screening report.</p>
30
<p><a>Click here for sample API code</a></p>
30
<p><a>Click here for sample API code</a></p>
31
<h3>Webhooks</h3>
31
<h3>Webhooks</h3>
32
<p><strong>Notification Status </strong></p>
32
<p><strong>Notification Status </strong></p>
33
<p>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</p>
33
<p>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</p>
34
<p><a>Click here for sample API code</a></p>
34
<p><a>Click here for sample API code</a></p>
35
<h3>Errors</h3>
35
<h3>Errors</h3>
36
<strong>Code</strong><strong>Description</strong>100Invalid XML200Invalid login210User is locked220Password is expired240Account or user is disabled250Invalid Order Account300Invalid package320Missing required value500Error with request (This is a “catch-all” for unexpected errors )<p><a>Click here for sample API code</a></p>
36
<strong>Code</strong><strong>Description</strong>100Invalid XML200Invalid login210User is locked220Password is expired240Account or user is disabled250Invalid Order Account300Invalid package320Missing required value500Error with request (This is a “catch-all” for unexpected errors )<p><a>Click here for sample API code</a></p>
37
37