Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...

  • 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 NameEmailAddressPhoneAddress, and SecondaryPhone
  • CustomerId is required when creating a new claim and can be used to retrieve accounts

Drawio
bordertrue
diagramNameChoosingACustomer
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth611
revision1

...

  • 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

Drawio
bordertrue
diagramNameChoosingAnAccount
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth611
revision2

...

  • 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

Drawio
bordertrue
diagramNameCreatingAClaim
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth431
revision3

...

  • 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

Drawio
bordertrue
diagramNameRetrievingAndAddingClaimReasons
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth641
revision2

...

Drawio
bordertrue
diagramNameRetrievingSubmittingQuestionnaire
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth641
revision2

...

Drawio
bordertrue
diagramNameRetrievingTransactionsOtherAccount
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth1031
revision4


Anchor
AddingCheckDeposits
AddingCheckDeposits

Adding Check Deposits

  • If /claim/intake/addCheckDeposits is defined as  an endpoint in the APIDocumentationList when retrieving the questionnaire, then it must be called before /claim/intake/addQuestionnaire
  • The /claim/intake/addCheckDeposits are required when the given claim is ATM Deposit and the user is disputing checks deposited
  • Use the endpoint www.example.com/QFDAPI/v1/claim/intake/addCheckDeposits to add check deposit details to the claim
  • The /claim/intake/addCheckDeposits endpoint takes in a CheckDepositList of check deposits. Each check having an Amound, CheckNumber, Date, and From

Drawio
bordertrue
diagramNameAddingCheckDeposits
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth410
revision2

Anchor
RetrievingCompletingDocRequirements
RetrievingCompletingDocRequirements

Retrieving and Completing Document Requirements

  • After Retrieving and Submitting Questionnaire, use the endpoint www.example.com/QFDAPI/v1/claim/intake/retrieveDocRequirements to retrieve the claims document requirements
  • The /claim/intake/retrieveDocRequirements endpoint returns a 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/addDocuments to add the required documents to the claim
  • The /claim/intake/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

...