当社のスタンダードAPI

はじめに

XChange Advantage Standard API は、First Advantageスクリーニングプラットフォームへのシームレスな双方向HTTP・SOAP統合を可能にします。

対応プロトコル：XML over HTTPS (POST) および SOAP over HTTPS (ウェブサービス) トランザクションに対応しています。

XChange Advantage Standard API を使用すると、アプリケーション内から以下のサービスを統合できます：

• スクリーニングプログラムの管理：ユーザーアカウント、パスワード、プロファイルの管理
• パッケージの検索：アカウントで利用可能なパッケージとスクリーニングオプションのリストの取得 
• バックグラウンドチェックの注文： 注文を開始または更新したり、応募を完了するために候補者に招待メールを送信できます  
• チェックプロセスのステータスまたは結果の表示：ステータスのオンデマンドプルとライブレポートへのURLリンク 
• Webhook：ケースのステータス通知やスクリーニング結果をお客様のURLにリアルタイムで送信

必要なのは、当社システムのAPIアカウントだけです。（アカウントは、お問い合わせいただければ提供いたします。）お客様の開発プラットフォームで XChange Advantage スタンダード API をご利用いただくために必要な情報は、当社の説明書をご覧ください。

スクリーニングアカウント・ユーザー管理

アカウント管理方法

アカウントリスト：スクリーニングプログラムに設定されたすべてのアカウント・サブアカウントを取得

パッケージ検索：指定されたアカウントに設定されたすべてのスクリーニングパッケージを検索

ユーザー設定：新規ユーザーの作成、ユーザー（アクセス、オプション、グループ）の更新機能

ユーザーとプロファイルの接続：ユーザーをプロファイルに接続する機能（アクセス制御）

サンプルAPIコードはこちら

スクリーニング注文モデル

XChange AdvantageStandard APIには、3つのスクリーニング注文モデルがあります:

ワンステップ・スクリーニング注文モデル

このワンステッププロセスでは、システム間の完全自動インターフェイスが利用できます。  リクエストを受信すると、First Advantageシステムがスクリーニング注文を作成します。

2ステップ・スクリーニング注文モデル

この2ステッププロセスでは、XMLサービスとEnterprise Advantageウェブサイトのインターフェースを使用します。  XMLリクエストは、First Advantageの注文の事前入力に使用されます。

候補者招待スクリーニング注文モデル

候補者を、当社のDirect Advantage Candidateプラットフォームに招待し、情報入力を完了させます。

サンプルAPIコードはこちら

スクリーニングステータスとレポートの表示方法

リンクの取得：同期注文の結果（オンデマンド・プル）は、ケースのステータスとスクリーニング・レポートのリンクURLを提供します。リンクリクエストは一度しか使用できません。

ステータスの取得 – 同期注文ステータス (オンデマンド・プル): ステータスとスクリーニング・レポートの要素を提供します。また、スクリーニング・レポートのURLを提供します。

サンプルAPIコードはこちら

Webhooks

ステータス通知 

非同期Webhookによるリアルタイムのステータス通知を提供し、コンテンツの設定可能な変換を行い、通知コンテンツ（HTML/XML）で完全な詳細レポート結果を可能にします。 メールによるステータス通知も可能です。

サンプルAPIコードはこちら

エラーリスト

サンプルAPIコードはこちら