QANT 外部連携API

API仕様

トップ

00共通仕様

このページの `curl` はモック検証用です。APIキーはそのまま埋め込んであります。

ベースURL
https://crm-mock.qant.jp
メソッド
POST
認証ヘッダー
x-secret-key: mock-secret-key
形式
Content-Type: application/json

01本人確認

契約者のカナ氏名・生年月日を照合し、契約属性を返します。

POST /external-api/verify-identity

入力

policyNumber
必須。証券番号
name
必須。契約者氏名カナ。スペース有無は無視
birthday
必須。生年月日。YYYY-MM-DD

返却

verified
本人確認結果
customer
照合成功時のみ契約属性を返却
historyId
更新履歴ID
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/verify-identity' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "policyNumber": "12345678",
    "name": "ナガサキ シュウヘイ",
    "birthday": "1990-08-30"
  }'

02請求スケジュール照会

次回振替日、締日、請求停止対象月、返金予定時期を返します。

POST /external-api/get-billing-schedule

入力

policyNumber
必須。証券番号

返却

billingSchedule.nextTransferDate
次回振替日
billingSchedule.billingClosingDate
締日
billingSchedule.refundablePeriod
返金予定時期
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/get-billing-schedule' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "policyNumber": "12345678"
  }'

03住所・電話番号変更

新しい住所と引越し状況を登録します。電話番号変更がない場合は空文字で送れます。

POST /external-api/register-address-change

入力

policyNumber
必須。証券番号
new_postal_code
必須。変更後郵便番号
new_address
必須。正規化済み新住所
new_phone_number
任意。変更後電話番号
scheduled_move_date
任意。引越し前の場合のみ引越し予定日（YYYY-MM-DD）。空または未指定なら引越し済みとして扱い、引越し済みフラグ（hasMoved）を導出する

返却

changed
変更登録した場合は true。同じ値で処理しなかった場合は false
message
変更対象なしの場合のみ理由を返却
postalCode
登録後郵便番号
address
登録後住所
phoneNumber
登録後電話番号
hasMoved
登録後の引越し済みフラグ
scheduledMoveDate
登録後の引越し予定日
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/register-address-change' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "policyNumber": "12345678",
    "new_postal_code": "141-0031",
    "new_address": "東京都品川区西五反田4丁目31-18 目黒テクノビル201",
    "new_phone_number": "",
    "scheduled_move_date": ""
  }'

04カード有効期限更新

カード番号の上4桁・下4桁で対象契約を特定し、有効期限を更新します。

POST /external-api/register-card-expiry-update

入力

cardFirstFourDigits
必須。カード番号の上4桁
cardLastFourDigits
必須。カード番号の下4桁
newExpiry
必須。新有効期限。MM/YY

返却

policyNumber
対象契約の証券番号
cardExpiry
登録後有効期限
historyId
更新履歴ID
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/register-card-expiry-update' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "cardFirstFourDigits": "4123",
    "cardLastFourDigits": "5678",
    "newExpiry": "12/28"
  }'

05保険料請求停止

解約に伴う請求停止を登録し、契約状態を請求停止受付済みにします。

POST /external-api/register-premium-billing-stop

入力

policyNumber
必須。証券番号
stopTargetMonth
必須。請求停止対象月。YYYY-MM

返却

stopTargetMonth
登録した請求停止対象月
contractStatus
登録後契約状態
historyId
更新履歴ID
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/register-premium-billing-stop' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "policyNumber": "12345678",
    "stopTargetMonth": "2026-08"
  }'

06手続書類発送

指定した書類の発送依頼を登録します。登録住所宛てなら住所指定は不要です。

POST /external-api/request-document-dispatch

入力

policyNumber
必須。証券番号
destinationType
必須。registered / new
destinationAddress
destinationType が new の場合必須
documentType
必須。解約 / 死亡解約 / 収納経路変更 / 法人住所変更 / 海外渡航

返却

dispatchRequest
発送先、書類種別、発送予定日
customerId
対象顧客ID
historyId
更新履歴ID
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/request-document-dispatch' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "policyNumber": "12345678",
    "destinationType": "registered",
    "documentType": "解約"
  }'

07応対ログ登録

問い合わせ応対の要約を更新履歴に登録します。生の通話内容や個人情報を含む本文は受け取りません。

POST /external-api/register-contact-log

入力

policyNumber
必須。証券番号
summary
必須。応対内容の要約。個人情報を含めない
handlingType
任意。ai / human / aiToHuman
channel
任意。phone / chat / email / web
category
任意。addressChange / billing / cancellation / documentRequest / payment / other
outcome
任意。resolved / pending / escalated / followUpRequired
nextAction
任意。次アクション
handledAt
任意。応対日時。未指定ならAPI受付時刻

返却

contactLog
登録した応対ログ
customerId
対象顧客ID
historyId
更新履歴ID
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/register-contact-log' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "policyNumber": "12345678",
    "summary": "住所変更の本人確認、転居済みであること、電話番号変更がないことを確認した。新住所の登録を完了し、追加の申し出がないことを確認して応対を終了した。",
    "handlingType": "ai",
    "channel": "phone",
    "category": "addressChange",
    "outcome": "resolved",
    "nextAction": "追加対応なし"
  }'

08本人確認（連絡先照合）

カナ氏名・電話番号・住所に加え、生年月日または契約番号のいずれかを照合し、契約属性を返します。証券番号と生年月日が揃わないシナリオ向けの代替認証です。

POST /external-api/verify-identity-by-contact

入力

name
必須。契約者氏名カナ。スペース有無は無視
phoneNumber
必須。連絡先電話番号。ハイフン有無は無視
address
必須。住所。全角/半角・空白・ハイフン(丁目/番地/号/号室/棟/階含む)の表記差を正規化して照合。番地はハイフン区切り前提
birthday
birthday と policyNumber のいずれか必須。生年月日。YYYY-MM-DD
policyNumber
birthday と policyNumber のいずれか必須。契約番号。両方送った場合はどちらか一致でよい

返却

verified
本人確認結果。氏名・電話番号・住所・（生年月日 or 契約番号）がすべて一致したか
customer
照合成功時のみ契約属性を返却
historyId
更新履歴ID。照合失敗時は null
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/verify-identity-by-contact' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "name": "アイモノヤ タツオ",
    "phoneNumber": "090-2011-1234",
    "address": "京都府長岡京市神足1-2-3",
    "birthday": "1988-07-09"
  }'

D1docomo本人確認

Docomo RFPデモ用の顧客照合を行い、dアカウント連携有無や請求関連属性を返します。

POST /external-api/docomo/verify-customer

入力

policyNumber
必須。デモ用契約番号
name
必須。契約者氏名カナ。スペース有無は無視
birthday
必須。生年月日。YYYY-MM-DD

返却

verified
本人確認結果
customer
照合成功時のみDocomoデモ属性を返却
historyId
更新履歴ID
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/docomo/verify-customer' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "policyNumber": "12345678",
    "name": "ナガサキ シュウヘイ",
    "birthday": "1990-08-30"
  }'

D2docomo住所変更本人認証・現住所照会

姓・名カナ、電話番号、生年月日を照合し、成功時だけ現在の登録住所と顧客IDを返します。

POST /external-api/docomo/verify-address-change-identity

入力

lastNameKana
必須。契約者の姓の読み。ひらがな・半角カナ・空白は正規化
firstNameKana
必須。契約者の名の読み。ひらがな・半角カナ・空白は正規化
phoneNumber
必須。対象電話番号。全角数字・ハイフン・空白は正規化
birthday
必須。生年月日。YYYY-MM-DD / YYYYMMDDの表記差は正規化

返却

verified
本人認証結果
customer
照合成功時のみ顧客ID・顧客番号・現在住所を返却
historyId
本人認証の履歴ID。不一致時は null
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/docomo/verify-address-change-identity' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "lastNameKana": "カトウ",
    "firstNameKana": "ユキコ",
    "phoneNumber": "030-4312-6789",
    "birthday": "1953-04-12"
  }'

D3docomo住所変更

本人認証成功時に返した顧客IDを使い、契約者の郵便番号と住所を更新して、更新後の値を返します。

POST /external-api/docomo/register-address-change

入力

customerId
必須。本人認証成功時に返された顧客ID
newPostalCode
必須。変更後の7桁郵便番号。ハイフン有無は正規化
newAddress
必須。住所正規化・建物確認・顧客同意後の変更先住所

返却

success / registered
登録処理が成功し、指定住所が登録済みなら true。同値再送も true
changed
住所を変更した場合は true。同値再送は false
postalCode / address
更新後に読み戻した登録住所
historyId
更新履歴ID。同値再送時は null
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/docomo/register-address-change' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "customerId": "cus-docomo-rfp-001",
    "newPostalCode": "060-0001",
    "newAddress": "北海道札幌市中央区北一条西2丁目3番地 札幌ノースレジデンス 1201号室"
  }'

D4docomo請求状態照会

未納有無、支払方法、請求書送付状態、利用停止予定などのDocomo RFPデモ属性を返します。

POST /external-api/docomo/get-billing-status

入力

policyNumber
必須。デモ用契約番号

返却

billingStatus.unpaid
未納有無
billingStatus.paymentStatus
支払い状態
billingStatus.serviceSuspensionStatus
利用停止状態
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/docomo/get-billing-status' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "policyNumber": "22345678"
  }'

D5docomo請求日程照会

振替日、締日、請求確定日、支払期限、復旧目安などを返します。

POST /external-api/docomo/get-billing-schedule

入力

policyNumber
必須。デモ用契約番号

返却

billingSchedule.nextTransferDate
次回振替日
billingSchedule.billingConfirmedDate
請求確定日
billingSchedule.serviceRestoreEstimate
復旧目安
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/docomo/get-billing-schedule' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "policyNumber": "22345678"
  }'

D6docomo証明書発行依頼

支払証明書またはご利用料金証明書の発行依頼をDocomo RFPデモ履歴に登録します。

POST /external-api/docomo/request-payment-certificate

入力

policyNumber
必須。デモ用契約番号
certificateType
必須。支払証明書 / ご利用料金証明書
targetYear
任意。対象年

返却

certificateRequest
登録した証明書発行依頼
historyId
更新履歴ID
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/docomo/request-payment-certificate' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "policyNumber": "12345678",
    "certificateType": "支払証明書",
    "targetYear": "2025"
  }'

D7docomo応対ログ登録

FAQ根拠IDや転送理由を含む、Docomo RFPデモ用の応対要約を更新履歴に登録します。

POST /external-api/docomo/register-contact-log

入力

policyNumber
必須。デモ用契約番号
summary
必須。個人情報を含まない応対要約
faqIds
任意。参照FAQ ID
transferReason
任意。有人転送理由

返却

contactLog
登録した応対ログ
historyId
更新履歴ID
サンプルコマンド
curl -sS -X POST 'https://crm-mock.qant.jp/external-api/docomo/register-contact-log' \
  -H 'content-type: application/json' \
  -H 'x-secret-key: mock-secret-key' \
  -d '{
    "policyNumber": "12345678",
    "summary": "My docomo表示額と引落額の差異について、未確定額の可能性とWebビリングでの確認を案内した。",
    "handlingType": "ai",
    "channel": "voice_ai",
    "category": "billing_amount",
    "outcome": "self_service_guided",
    "faqIds": "1350",
    "nextAction": "Webビリング確認"
  }'

E主なエラー

レスポンス本文は `{"success":false,"message":"..."}` 形式です。

400
必須項目不足、JSON不正、toolType不正
401
APIキー不正
404
証券番号、カード、APIパスが見つからない
409
請求停止不可の契約