Integrations & APIs
Our 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)
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 Profile Advantage Candidate platform
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.
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
Errors
| Code | Description |
|---|---|
| 100 | Invalid XML |
| 200 | Invalid login |
| 210 | User is locked |
| 220 | Password is expired |
| 240 | Account or user is disabled |
| 250 | Invalid Order Account |
| 300 | Invalid package |
| 320 | Missing required value |
| 500 | Error with request (This is a “catch-all” for unexpected errors ) |
