This guide explains how to use the interaction API to view claims, add and view Attachments, Notes, and Transactions to claims, view and resend Correspondence, and request that a case is withdrawn or reopened.

Swaggerhub: https://app.swaggerhub.com/apis-docs/Quavo/QFD-public/1.1.0

Interaction API

Finding and viewing Cases

...

Adding and viewing Transactions

Viewing, downloading, and resending Correspondence

Request a Case to be withdrawn

...

Adding and viewing Attachments

• Follow the Finding and viewing Cases instructions to get a valid ClaimId
• Use the endpoint, www.example.com/QFDAPI/v1/claim/attachments/list to get a list of attachments linked to a claim and Attachment details
• The LinkReference ID returned in /attachments/list can be used to retrieve a specific attachment
• Use the endpoint, www.example.com/QFDAPI/v1/claim/attachments/retrieve to retrieve a specific attachment by passing in the LinkReference value 
  • The /claim/attachments/retrieve endpoint returns Attachment details as well as the Attachment's DocumentStream

...

Anchor
AddingAndViewingNotes AddingAndViewingNotes

Adding and viewing Notes

• Follow the Finding and viewing Cases instructions to get a valid ClaimId
• Use the endpoint, www.example.com/QFDAPI/v1/notes/list to get a list of notes linked to a claim
• The LinkReference ID returned in /notes/list can be used to retrieve a specific note
• Use the endpoint, www.example.com/QFDAPI/v1/notes/retrieve to retrieve a specific note by passing in the LinkReference value

...

Anchor
AddingAndViewingTransactions AddingAndViewingTransactions

Adding and viewing Transactions

• Follow the Finding and viewing Cases instructions to get a valid ClaimId
• Use the endpoint, www.example.com/QFDAPI/v1/transactions/list to get a list of transactions linked to a claim
• The /transaction/list endpoint returns all details about each transaction

...

• To add Transactions, call www.example.com/QFDAPI/v1/claim/transactions/add with your valid ClaimId and list of Transactions, TransactionList
• Each Transaction in TransactionList needs to have a valid TransactionId
• To view Transaction Details, call www.example.com/QFDAPI/v1/claim/transactions/details/retrieve with your valid ClaimId and either a valid DisputeId or a valid TransactionId

Anchor
ViewingAndResendingCorrespondence ViewingAndResendingCorrespondence

Viewing, downloading, and resending Correspondence

• Follow the Finding and viewing Cases instructions to get a valid ClaimId
• Use the endpoint, www.example.com/QFDAPI/v1/correspondence/list to get a list of Correspondence linked to a claim as well as details about the Correspondence
• The LinkReference ID returned in /correspondence/list can be used to retrieve a specific correspondence
  • The LinkReference value can also be passed into the /attachment/retrieve endpoint to download the correspondence. See Adding and viewing Attachments
• Use the endpoint, www.example.com/QFDAPI/v1/correspondence/retrieve to retrieve a specific correspondence by passing in the LinkReference value
  • This endpoint returns EmailStyleMarkup and Body

...

Request a Case to be withdrawn

• Follow the Finding and viewing Cases instructions to get a valid ClaimId
• Use the endpoint, www.example.com/QFDAPI/v1/claim/withdrawRequest to request a claim to be withdrawn
• /claim/withdrawRequest must be called with a valid ClaimId and must be provided a WithdrawalReason

Anchor
RequestCaseReopened RequestCaseReopened

Request a Case to be reopened

• Follow the Finding and viewing Cases instructions to get a valid ClaimId
• Use the endpoint, www.example.com/QFDAPI/v1/claim/reopenRequest to request a claim to be reopened
• /claim/reopenRequest must be called with a valid ClaimId and must be provided a ReopenReason and TransactionList
• TransactionList contains a list of TransactionIds of the specific Transactions to be reopened
• ReopenNewInformation is an optional field for any new information about the claim 

...

• Use the endpoint, www.example.com/QFDAPI/v1/task/action to perform an available action on a task (as identified in the task details endpoint)

• The /task/action endpoint request requires the following parameters:

  • CorrelationId

    • This is a UUID

  • TaskList

    • The List of Tasks to be actioned
    • TaskId
      • The Task Identifier to be actioned

  • Action

    • The action to be performed on said task
  • Detail
    
    • This object is dependent on the action being performed and contains the action's specific attributes. For example, in a Deny Claim action, this would hold the Denial information (DenyReason, DenyJustificationList, DenialCommentary)

...