Cloud API でのクレーム連絡先の概要
以下のセクションでは、クレーム連絡先が Cloud API に存在するときの動作の概要を説明します。
クレーム連絡先の役割
どのクレーム連絡先にも roles 配列があります。これは、クレーム連絡先が持つすべての役割のリストで、読み取り専用です。
Role 配列のどのメンバーも、以下のプロパティを含んでいます。
relatedTo- クレーム連絡先が関係するオブジェクトのタイプと IDrole- そのオブジェクト上でクレーム連絡先が持つ役割active- クレーム連絡先がクレームに対してその役割をアクティブに保持するかどうかを識別する Boolean
active フィールドは、以前はクレームに対して役割を保持していたものの、現在はクレームにアクティブに関与していないクレーム連絡先を識別するために使用されます。例えば、ある医師によって負傷者の治療が行われたものの、その後その案件が 2 人目の医師に再アサインされたとします。どちらの医師もこのクレームのクレーム連絡先にできますが、active に設定されるのは 2 人目の医師のみです。
クレーム連絡先が持つ役割は変更可能ですが、roles 配列を変更しても変更されません。役割の変更方法は、その役割が予約済みかどうかによって異なります。
予約済みの役割
予約済みの役割は、クレーム連絡先に明示的に設定できない役割です。代わりに、別のオブジェクトのフィールド、配列、またはアクションを通して、その役割を暗黙的に設定する必要があります。
例えば、「報告者」は予約済みの役割です。この役割をクレーム連絡先に直接追加することはできません。ただし、クレームの reporter フィールドを特定のクレーム連絡先に設定することはできます。これにより、報告者の役割がそのクレーム連絡先に暗黙的に追加されます。また、これによって、これまで報告者の役割を持っていた他のクレーム連絡先からその役割が削除されます。
予約済みの役割は、integration/contactroles/v1 ディレクトリの ReservedContactRoles.yaml ファイルで定義します。一般的に、予約済みの役割は次のいずれかです。
- その役割のクレーム連絡先が最大 1 つ存在できる役割。(例えば、「報告者」は予約済みです。1 つのクレームは最大 1 つの報告者を持つことができます。)
- クレーム連絡先以外のオブジェクトの配列を通して設定される役割。(例えば、「目撃者」は予約済みです。クレームは複数の目撃者を持つことができます。これらの目撃者は
Claimリソースのwitnesses配列で定義します。)
クレーム連絡先への予約済みの役割のアサインの詳細については、予約済みの役割の設定を参照してください。
未予約の役割
未予約の役割は、クレーム連絡先に明示的に設定できる役割です。ReservedContactRoles.yaml ファイルにリストされていない役割はすべて、未予約の役割です。例えば、「予備の連絡先」は未予約の役割です。1 つのクレームは予備の連絡先を任意の数持つことができ、このタイプのクレーム連絡先はクレーム上の配列によって管理されません。
クレーム連絡先への未予約の役割のアサインの詳細については、未予約の役割の設定を参照してください。
識別子
ペイロードでクレーム連絡先を指定する際には、複数の異なる識別子を使用できます。
id- クレーム連絡先のシステム API の ID。ClaimCenter におけるクレーム連絡先のパブリック ID と等しいものです。policySystemId- 保険契約管理システムにおける識別子で、連絡先を一意に識別します。refid- 特定のペイロードでクレーム連絡先が作成された場合、ペイロードの他の部分からは任意の「参照 ID」を使用してこれを参照できます。
クレーム連絡先を識別するためのさまざまなオプションについては、クレーム連絡先の特定を参照してください。
taxID フィールドのマスク
ClaimContact リソースには、連絡先の納税者番号を保存する taxID フィールドがあります。Cloud API のベースコンフィギュレーションでは、このフィールドは応答内でマスクされており、末尾 4 桁のみが表示されます。例えば、以下は連絡先を取得する GET の応答です。
{
"data": {
"attributes": {
"displayName": "Ray Newton",
"taxId": "***-**-6789"
}
}
}
一部の呼び出し元(内部または外部のユーザーなど)では、個人識別情報を保護するために納税者番号のマスキングが適切な場合があります。しかし、その他の呼び出し元(サービスなど)では、呼び出し元が納税者番号を使用して連絡先を内部参照することがあり、マスキングによって問題が生じる可能性があります。
taxId フィールドのマスキングを解除するには、次の 2 つの方法があります。
- 常にマスキングなしの状態になるよう、フィールドをコンフィギュレーションできます。このコンフィギュレーション方法の詳細については、応答データの難読化を参照してください。
- 呼び出し元に
restunmasktaxidシステム権限を付与できます。この権限を持つ役割の呼び出し元は、マスキングされていない納税者番号を含む応答を取得します。このコンフィギュレーション方法の詳細については、『Cloud API 認証ガイド』の API 役割の特別な権限に関するセクションを参照してください。
クレーム連絡先と「連絡先」の比較
連絡先情報を取得するリソースの名前が ClaimContact です。このドキュメントでは、クレームに関係する連絡先をクレーム連絡先と呼んでいます。
Cloud API では「連絡先」という用語を使用してクレーム連絡先を指している場合があるので注意が必要です。
- ClaimContact をルートリソースとして持つエンドポイントでは、エンドポイントパスが「連絡先」としてリソースを参照します。次に例を示します。
- GET
/claim/v1/claims/{claimId}/contacts - PATCH
/claim/v1/claims/{claimId}/contacts/{contactId}
- GET
includeクエリパラメータを使用して関係するクレーム連絡先を含めるときに、リソースは「連絡先」として参照されます。次に例を示します。- GET
/claim/v1/claims?include=contacts
- GET
クレーム連絡先のエンドポイント
以下のエンドポイントを使用して、クレーム連絡先と直接やり取りできます。
| 操作 | エンドポイント | 説明 |
|---|---|---|
| GET | /claims/{claimId}/contacts |
特定のクレームのクレーム連絡先を取得する |
| POST | /claims/{claimId}/contacts |
特定のクレームの新しいクレーム連絡先を作成する |
| GET | /claims/{claimId}/contacts/{contactId} |
特定のクレーム連絡先に関する情報を取得する |
| PATCH | /claims/{claimId}/contacts/{contactId} |
特定のクレーム連絡先の情報を更新する |
| DELETE | /claims/{claimId}/contacts/{contactId} |
特定のクレーム連絡先を削除する |
| GET | /claims/{claimId}/contact-role-owners |
特定のクレーム上のクレーム連絡先を関連付けできるオブジェクトのリストを取得する |
予約済みの役割では、その役割を制御するオブジェクトを変更することで、クレーム連絡先を間接的に変更することもできます。例えば、PATCH /claims/{claimId} を実行し、クレームの reporter フィールドを特定のクレーム連絡先に設定または変更すると、その reporter 役割がそのクレーム連絡先にアサインされます。
/claims/{claimId}/contact-role-owners エンドポイントは、クレーム連絡先を関連付けできるクレーム上のすべてのオブジェクトを返します。これには、以下が含まれます。
- クレームそのもの
- 保険契約
- 既存のすべてのインシデント
- 既存のすべてのエクスポージャー
- 既存のすべてのサービス要求
- 既存のすべての交渉または訴訟事項
- 「交渉」は、事故の 1 つの紛争要素に関係するオファーとカウンターオファーの履歴です。
- 「訴訟事項」は、訴訟または潜在的な訴訟に関する情報のコレクションです。
/claims/{claimId}/contact-role-owners エンドポイントは、クレーム連絡先を関連付けできるオブジェクトを返すことに注意してください。これらのオブジェクトにはクレーム連絡先がすでに関連付けられている場合とそうでない場合があります。関連付けられているクレーム連絡先がある場合、そのクレーム連絡先は応答に含まれません。クレーム連絡先に対する外部のユーザーの承認
Cloud API はさまざまな種類の呼び出し元の承認をサポートしています。サポートされる呼び出し元の種類の 1 つは外部のユーザーです。外部のユーザーは、保険会社にとって既知であるが、運用データベース内にユーザーとしてリストされていない個人です。ClaimCenter では、外部のユーザーの種類の 1 つに保険契約者があります。保険契約者は、保険契約のクレームに関する情報についてやりとりを必要とするユーザーです。例えば、Ray Newton さんは保険契約者ですが、個人用自動車保険について提出されたクレームのステータスを確認したいと思っています。外部のユーザーの承認の詳細については、『Cloud API Authentication Guide(Cloud API 認証ガイド)』を参照してください。
ベースコンフィギュレーションでは、外部のユーザーは自分の保険契約に関係するクレームのクレーム連絡先情報を表示および編集することができます。しかし、このユーザーが表示と編集ができるのは、被保険者の役割で保険契約に関係しているクレーム連絡先のみです。保険契約に関係しないクレーム連絡先(第三者のクレーム連絡先や業者など)や、保険契約に関係しているものの、被保険者の役割を持たないクレーム連絡先(エージェントなど)に関する情報は表示できません。
例えば、Ray Newton さんが事故のクレームを提出するとします。事故は、Ray Newton さん自身と別の運転者(David Preston さん)が関係しています。Ray Newton さんの車両は Sam's Towing and Auto Service によって修理されます。
- Ray Newton さんは以下の操作を実行できます。
- 自分自身に関する情報を表示すること。このクレーム連絡先は被保険者の役割で保険契約に関係しています。
- クレーム連絡先を新規作成すること(被保険者の役割で保険契約に関係している場合と関係していない場合があります)。
- Ray Newton さんは以下の操作を実行できません。
- David Preston さんに関する情報を表示または編集すること。
- Sam's Towing に関する情報を表示または編集すること。
- 自分が作成したクレーム連絡先に関する情報(被保険者の役割で保険契約に関係していない情報)を表示または編集すること。