Integrations & APIs

REST API​

Getting Started

The XChange Advantage REST API provides a robust, expedient, and simple API for interacting with First Advantage Screening Services using RESTful transactions.

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

  •  Users API – Ability to create, update, and deactivate users
  •  Subscriptions API – Ability to create and maintain Subscriptions to First Advantage’s Services.
  •  Candidates API – Ability to create and maintain Candidates. 
  •  Orders API – Ability to create, update and view First Advantage Screening Orders. Order Creation requires Subscription ID and Candidate ID. 
  •  Webhooks – Receive real-time post to your URL for case Status notifications and screening results

Our documentation will guide you with what you need to know to begin consuming the XChange Advantage REST API on your development platform.

Users

Ability to create, update, and deactivate users.

Actions Supported:

  •  Register new users
  •  Update user information
  •  View user information
  •  Deactivate a user
Request:{
  "organization": "TaskPro",
  "first_name": "Steve",
  "last_name": "Rest",
  "email": "integrationsupport@fadv.com",
  "password": "Password@fadv",
  "phone": "800-888-5773"
}

Subscriptions

Ability to create and maintain Subscriptions to First Advantage’s Services.

Actions Supported:

  •  Create subscriptions
  •  Update subscriptions
  •  View subscriptions
              
{   "service": 
[     "Background 
Screening"   ],  
 "system": 
[     "Enterprise 
Advantage"   ],  
 "packages": [“1967”],  
 "account_id": 
[“900000JAC”],  
 "model": [     "1 Step" , 
“2 Step” , “Direct  
Advantage”   ],   
"user_id": 
"integrationsupport@fadv.com }
            

Candidates

Ability to create and maintain Candidates.

The Screening Services are performed on the Candidate.

Actions Supported:  

  •  Register new Candidate
  •  Update new Candidate
  •  View Candidate Information
{
  "first_name": "Steve",
  "middle_name": "Matt",
  "has_middle_name": "Y",
  "last_name": "Rest",
  "address": "123MainStreet",
  "city": "Alpharetta",
  "state": "GA",
  "zip_code": "29380",
  "county": "GA",
  "emailid": "integrationsupport@fadv.com"
}

Orders

Ability to create, update and view First Advantage Screening Orders.

Order Creation requires Subscription ID and Candidate ID.

Actions Supported:

  •  Create Orders
  •  Update Orders
  •  View Order Status
              
{ "candidate_id":
"10459",  
"subscription_id": 
"586f443da2b14
94a6bcf5b37",
 "package_id": "1967" }
            

Order Status

Ability to view Order Status for a First Advantage Screening Order.

Actions Supported:

  •  View Order Status
              
{  "order_id":
"WPS-6621358", 
"order_status": 
"InProgress", 
 "result_status": 
"Pass", 
"score": 
"Eligible", 
"url": 
"https://fadv.ly/WP ",
S-6006000  }
            

Errors

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