Page Comparison

This guide explains how to use the Intake API to This guide explains how to use the Intake API to create claims, add reasons, transactions, and details about the claim, and submit the claim to be finalized.

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

Intake API

Overview

Choosing a Customer

Choosing an Account

Creating a Claim

Retrieving and Adding Claim Reasons

Retrieving and Adding Transactions

Retrieving and Submitting Questionnaire

Retrieving Credit Transactions

Retrieving Similar Transactions

Retrieving Similar Transactions on Another Account

Adding Check Deposits

Retrieving and Completing Document Requirements

Verifying Correspondence Channels

Retrieving

...

Summary

...

and Submitting Claim

...

Retrieving Confirmation

...

...

Overview

Choosing a Customer

...

Anchor
ChoosingACustomer ChoosingACustomer

Choosing a Customer

• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/retrieveCustomers to get a list of CustomerIds and other customer details
• The /claim/intake/retrieveCustomers endpoint also returns Name, EmailAddress, Phone, Address, and SecondaryPhone
• CustomerId is required when creating a new claim and can be used to retrieve accounts

...

• If needed, follow Choosing a Customer to get a valid CustomerId
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/retrieveAccounts to get a list of AccountNumbers and other account details
• The /claim/intake/retrieveAccounts endpoint takes in CustomerId as a parameter and the response will only return accounts for the passed in CustomerId
• Description, OpenDate, and Balance are also returned 
• AccountNumber is required when creating a new claim

...

• If needed, follow Choosing a Customer and Choosing an Account to get a valid CustomerId and AccountNumber
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/create to create a new claim
• The /claim/intake/create endpoint takes in CustomerId and AccountNumber as parameters and the claim will be created for the passed in IDs
• ClaimId is returned

...

• After Creating A Claim, use the endpoint, www.example.com/QFDAPI/v1/claim/intake/retrieveReasons with a valid ClaimId to get the reason questionnaire for the claim
• The returned questionnaire contains questions to display so the user can classify the type and reason for the claim. The API returns appropriate questions for that given claim
• Using the returned questionnaire, a QuestionList of the users answered questions can be built to sent to /claim/intake/addClaimReasons. See Swaggerhub Documentation
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/addClaimReasons to submit the built QuestionList
• After submitting the users answers, the next step in the intake process is Retrieving and Adding Transactions

...

...

• After Creating A Claim, Retrieving and Adding Claim Reasons, and Retrieving and Adding Transactions
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/retrieveQuestionnaire to get a list of questions for the user to answer
  • The questionnaire structure is the same as the in the endpoint used in Retrieving and Adding Claim Reasons
• Using the returned questionnaire, a QuestionList of the users answered questions can be built to sent to /claim/intake/addQuestionnaire. See Swaggerhub Documentation
  • Some claim types return a question that contains an APIDocumentationList. If present, the defined endpoints must be called before calling /claim/intake/addQuestionnaire. See Swaggerhub Documentation
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/addQuestionnaire to submit the built QuestionList
• After submitting the users answers, the next step in the intake process is Retrieving and Completing Document Requirements

...

...

...

...

...

Adding Check Deposits

...

• If /claim/intake/retrieveDocRequirements to retrieve the claims document requirementsaddCheckDeposits is defined as  an endpoint in the APIDocumentationList when retrieving the questionnaire, then it must be called before /claim/intake/addQuestionnaire
• The /claim/intake/retrieveDocRequirements endpoint returns a DocumentRequirementList, a list of document requirements for addCheckDeposits are required when the given claim If the DocumentRequirementList has one or more items defined, then use is ATM Deposit and the user is disputing checks deposited
• Use the endpoint www.example.com/QFDAPI/v1/claim/intake/addDocuments addCheckDeposits to add the required documents check deposit details to the claim
• The /claim/intake/addDocuments addCheckDeposits endpoint takes in a DocumentRequirementList that contains DocumentStreams for each of the document requirements and other document details. See Swaggerhub Documentation
• The user can also opt to skip adding required documents for now and add them later on

...

• CheckDepositList of check deposits. Each check having an Amound, CheckNumber, Date, and From

Drawio
border true diagramName AddingCheckDeposits simpleViewer false links auto tbstyle top lbox true diagramWidth

...

410 revision 2

Anchor

...

RetrievingCompletingDocRequirements

...

RetrievingCompletingDocRequirements

Retrieving and Completing Document Requirements

• After Retrieving Retrieving and Submitting Questionnaire, use the endpoint www.example.com/QFDAPI/v1/claim/intake/retrieveCorrespondenceChannels retrieveDocRequirements to retrieve correspondence channels for the given claimthe claims document requirements
• The /claim/intake/retrieveCorrespondenceChannels retrieveDocRequirements endpoint returns a CorrespondenceChannelList of correspondence channels. If isEditable is true for the defined channel, then the correspondence channel can be updated by the userUse the DocumentRequirementList, a list of document requirements for the given claim
• If the DocumentRequirementList has one or more items defined, then use the endpoint www.example.com/QFDAPI/v1/claim/intake/verifyCorrespondenceChannels to verify or edit correspondence channelsaddDocuments to add the required documents to the claim
• The /claim/intake/verifyCorrespondenceChannels takes in a CorrespondenceChannelList of correspondence channels. 
• If the correspondence channel is correct, then IsVerifiedCorrect must be set to true for that channel
If the correspondence channel needs to be changed, then IsVerifiedCorrect must be set to false, and new values provided for the channel. addDocuments endpoint takes in a DocumentRequirementList that contains DocumentStreams for each of the document requirements and other document details. See Swaggerhub Documentation
• The user can also opt to skip adding required documents for now and add them later on

Anchor
VerifyingCorrChannels VerifyingCorrChannels

Verifying Correspondence Channels

• After Retrieving and Submitting Questionnaire, use the endpoint www.example.com/QFDAPI/v1/claim/intake/retrieveCorrespondenceChannels to retrieve correspondence channels for the given claim
  • Only required and supported if client has multi-channel verification enabled
• The /claim/intake/retrieveCorrespondenceChannels returns a CorrespondenceChannelList of correspondence channels. If isEditable is true for the defined channel, then the correspondence channel can be updated by the user
• Use the endpoint www.example.com/QFDAPI/v1/claim/intake/verifyCorrespondenceChannels to verify or edit correspondence channels
• The /claim/intake/verifyCorrespondenceChannels takes in a CorrespondenceChannelList of correspondence channels. 
  • If the correspondence channel is correct, then IsVerifiedCorrect must be set to true for that channel
  • If the correspondence channel needs to be changed, then IsVerifiedCorrect must be set to false, and new values provided for the channel. See Swaggerhub Documentation

Anchor
RetrievingClaimSummary RetrievingClaimSummary

Retrieving Summary and Submitting Claim

• After Retrieving and Submitting Questionnaire, use the endpoint www.example.com/QFDAPI/v1/claim/intake/retrieveSummary to retrieve the claim summary before submitting
• The /claim/intake/retrieveSummary returns CorrespondenceDetails, SummaryContactHeader, TransactionDetails, and SummaryQuestionnaire
• The SummaryQuestionnaire and CorrespondenceDetails follows the same structure as Retrieving and Submitting Questionnaire and Retrieving and Adding Claim Reasons
• After the user answers all the questions in the questionnaire and chooses a correspondence channel, use the endpoint www.example.com/QFDAPI/v1/claim/intake/submit to submit the SummaryQuestionnaire and submit the claim
• The /claim/intake/submit takes in SummaryQuestionnaire and CorrespondenceDetails. See Swaggerhub Documentation

Anchor

...

SubmitClaimConfirmation

...

SubmitClaimConfirmation

Retrieving

...

Confirmation

• After Retrieving Summary and Submitting Claim, use the endpoint www.example.com/QFDAPI/v1/claim/intake/retrieveConfirmation to retrieve confirmation documents
• The /claim/intake/retrieveConfirmation returns ConfirmationDocumentStream, ConfirmationMessageMarkup, ConfirmationHeader, and ConfirmationDocumentName