【保証会社様向け】API機能追加のお知らせ

基幹システムと連携するAPIについて、以下の機能を追加いたしました。

1. 審査結果APIの引数追加

APIでやり取りするJSON形式の文章において、

審査結果を返すためentry_headのjudgement_result領域で審査結果を返して頂いておりました。

以下の様に引数が追加されています。

そのため、審査結果取込APIでも引数が追加されております。

旧仕様

"judgement_result": {
   "ok": null,　　　　　　　'true：承認、false：否認
   "remarks": null,　　　　 'コメント（フリーテキスト）
   "updated_at": null　　　 '審査結果最新更新日時
}

新仕様

"judgement_result": { 
     "ok": null,　　　　　　　　　　　　'true：承認、false：否認 
    "status": null,　　　　　　　　　　'ok：承認、ng：否認、start：審査開始、pending
：保留 
    "result_surety_number": null, '承認番号
    "result_monthly_fee": null, '月額総賃料 
    "result_guarantee_charge": null, '初回保証料 
    "remarks": null, 
    "updated_at": null 
   }

2. 審査結果APIの追加

上記judgement_result内の"status"に"pending""start"が追加されたことにより

APIを追加しております。

start（審査開始）

Example URI

PUT https://moushikomi-uketsukekun.com/guarantees/api/entry_heads/1234/judge_start

使用できる引数は"remarks"のみです。審査開始となり管理会社側には「審査中」と表示されます。

pending（保留）

Example URI

PUT https://moushikomi-uketsukekun.com/guarantees/api/entry_heads/1234/pending

使用できる引数は"remarks"のみです。保留となり、管理会社側には「保留」と表示されます。

両API共に詳しい仕様はタイトルリンク先の仕様書をご確認下さい。

3. 管理会社側で設定している月額金額項目、初期費用金額項目領域の追加

旧仕様では、保証会社様側の申込フォームに設定した金額項目のみが取得可能でした。

しかし、管理会社にしかない月額金額項目が存在した場合に、その金額が保証会社様側で確認できないため、

「APIで渡ってきた月額金額内訳の合計」≠月額総合計

となる事象が発生していました。これを改善するため、

「管理会社で設定した月額項目」＋「保証会社で設定した月額項目」領域：monthly_fee_details

"monthly_fee_details": [ 
    { 
  月額金額項目領域 
    },

と、「管理会社で設定した初期費用項目」＋「保証会社で設定した初期費用項目」領域：initial_fee_details

"initial_fee_details": [
{
初期費用金額項目領域
}

の2領域をAPIのJSON内に用意しました。

月額や初期費用の内訳を全て取得したい場合、entry_head、entry_bodiesとは別に、

上記2領域を参照することで内訳及びすべての金額詳細が取得できます。

上記項目はPDF内にも記載されます。

以下のリンク先よりJSONサンプル内下部に該当項目をご確認いただけます。

JSONサンプル（個人）

JSONサンプル（法人）

リンク先を確認頂く場合、事前に弊社担当からお送りしているステージング環境用保証会社ログインアカウントが必要です。ご不明な場合、担当までお問い合わせください。

4. 変更があった申込一覧を取得できるAPIを追加

申込一覧を取得する際、今までは

指定された時間の範囲内にentry_headが更新されているかつ、entry_status_id=40の申込

（指定された時間の範囲内にステータスが変更された、かつ「保証会社審査」の申込）

のみが取得できるようになっておりました。

⇒大半の場合、初回申込のみが取得できていました。（申込一覧の取得）

この度変更があった申込一覧を取得できるAPIを追加し

指定された時間の範囲内にentry_headもしくはentry_bodiesが更新されているかつ、entry_status_id=40の申込

（指定された時間の範囲内にステータスまたは申込詳細情報が変更された、かつ「保証会社審査」の申込）

が取得できるようになりました。（申込一覧の取得（変更申込））

リアルタイムに管理会社側で行われた申込情報の変更をキャッチしたい場合、

下のAPIを使って頂くことで変更内容の取得を行えます。

APIの追加機能は以上となります。

引き続きよろしくお願いいたします。

【保証会社様向け】API機能追加のお知らせ

1. 審査結果APIの引数追加

2. 審査結果APIの追加

start（審査開始）

Example URI

pending（保留）

Example URI

3. 管理会社側で設定している月額金額項目、初期費用金額項目領域の追加

4. 変更があった申込一覧を取得できるAPIを追加

関連記事