Page Comparison

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

...

Retrieving Similar Transactions on Another Account

Adding Check Deposits

Retrieving and Completing Document Requirements

Verifying Correspondence Channels

Retrieving Summary and Submitting Claim

...

Another Account

Adding Check Deposits

Retrieving and Completing Document Requirements

Verifying Correspondence Channels

Retrieving Summary and Submitting Claim

Retrieving Confirmation

Overview

Anchor
ChoosingACustomer ChoosingACustomer

...

• 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

...