共通仕様
このページの `curl` はモック検証用です。APIキーはそのまま埋め込んであります。
- ベースURL
https://crm-mock.qant.jp- メソッド
POST- 認証ヘッダー
x-secret-key: mock-secret-key- 形式
Content-Type: application/json
本人確認
契約者のカナ氏名・生年月日を照合し、契約属性を返します。
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"
}'請求スケジュール照会
次回振替日、締日、請求停止対象月、返金予定時期を返します。
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"
}'住所・電話番号変更
新しい住所を登録します。電話番号変更がない場合は空文字で送れます。
POST /external-api/register-address-change
入力
- policyNumber
- 必須。証券番号
- new_postal_code
- 必須。変更後郵便番号
- new_address
- 必須。正規化済み新住所
- new_phone_number
- 任意。変更後電話番号
- move_date
- 任意。引越し予定日。YYYY-MM-DD
返却
- changed
- 変更登録した場合は true。同じ値で処理しなかった場合は false
- message
- 変更対象なしの場合のみ理由を返却
- postalCode
- 登録後郵便番号
- address
- 登録後住所
- phoneNumber
- 登録後電話番号
サンプルコマンド
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": "",
"move_date": ""
}'カード有効期限更新
カード番号の上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"
}'手続書類発送
指定した書類の発送依頼を登録します。登録住所宛てなら住所指定は不要です。
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": "解約"
}'応対ログ登録
問い合わせ応対の要約を更新履歴に登録します。生の通話内容や個人情報を含む本文は受け取りません。
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": "追加対応なし"
}'主なエラー
レスポンス本文は `{"success":false,"message":"..."}` 形式です。
- 400
- 必須項目不足、JSON不正、toolType不正
- 401
- APIキー不正
- 404
- 証券番号、カード、APIパスが見つからない
- 409
- 請求停止不可の契約