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 Name, EmailAddress, Phone, Address, and SecondaryPhone
- CustomerId is required when creating a new claim and can be used to retrieve accounts
Drawio |
---|
border | true |
---|
| |
---|
diagramName | ChoosingACustomer |
---|
simpleViewer | false |
---|
width | |
---|
links | auto |
---|
tbstyle | top |
---|
lbox | true |
---|
diagramWidth | 611 |
---|
revision | 1 |
---|
|
...
- 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 |
---|
border | true |
---|
| |
---|
diagramName | ChoosingAnAccount |
---|
simpleViewer | false |
---|
width | |
---|
links | auto |
---|
tbstyle | top |
---|
lbox | true |
---|
diagramWidth | 611 |
---|
revision | 2 |
---|
|
...
- 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 |
---|
border | true |
---|
| |
---|
diagramName | CreatingAClaim |
---|
simpleViewer | false |
---|
width | |
---|
links | auto |
---|
tbstyle | top |
---|
lbox | true |
---|
diagramWidth | 431 |
---|
revision | 3 |
---|
|
...
- 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 |
---|
border | true |
---|
| |
---|
diagramName | RetrievingAndAddingClaimReasons |
---|
simpleViewer | false |
---|
width | |
---|
links | auto |
---|
tbstyle | top |
---|
lbox | true |
---|
diagramWidth | 641 |
---|
revision | 2 |
---|
|
...
Drawio |
---|
border | true |
---|
| |
---|
diagramName | RetrievingSubmittingQuestionnaire |
---|
simpleViewer | false |
---|
width | |
---|
links | auto |
---|
tbstyle | top |
---|
lbox | true |
---|
diagramWidth | 641 |
---|
revision | 2 |
---|
|
...
Drawio |
---|
border | true |
---|
| |
---|
diagramName | RetrievingTransactionsOtherAccount |
---|
simpleViewer | false |
---|
width | |
---|
links | auto |
---|
tbstyle | top |
---|
lbox | true |
---|
diagramWidth | 1031 |
---|
revision | 4 |
---|
|
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 |
---|
border | true |
---|
| |
---|
diagramName | AddingCheckDeposits |
---|
simpleViewer | false |
---|
width | |
---|
links | auto |
---|
tbstyle | top |
---|
lbox | true |
---|
diagramWidth | 410 |
---|
revision | 2 |
---|
|
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
...