...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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/postClaimSubmit
Intake API
Choosing a Customer
Choosing an Account
Creating a Claim
Retrieving and Adding Claim Reasons
Retrieving and Adding Transactions
Retrieving and Submitting Questionnaire
Retrieving Recognized Transactions
Retrieving Credit Transactions
Retrieving Similar Transactions
Retrieving Similar Transactions on Another Account
Retrieving and Completing Document Requirements
Verifying Correspondence Channels
Retrieving Claim Summary
Submitting Claim and Retrieving Confirmation
| Anchor | ||||
|---|---|---|---|---|
|
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
| Drawio | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Choosing an Account
- 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
| Anchor | ||||
|---|---|---|---|---|
|
Creating a 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
| Anchor | ||||
|---|---|---|---|---|
|
Retrieving and Adding Claim Reasons
| Anchor | ||||
|---|---|---|---|---|
|
Retrieving and Adding Transactions
| Anchor | ||||
|---|---|---|---|---|
|
Retrieving and Submitting Questionnaire
| Anchor | ||||
|---|---|---|---|---|
|
Retrieving Recognized Transactions
| Anchor | ||||
|---|---|---|---|---|
|
Retrieving Credit Transactions
| Anchor | ||||
|---|---|---|---|---|
|
Retrieving Similar Transactions
| Anchor | ||||
|---|---|---|---|---|
|
Retrieving Similar Transactions on Another Account
| Anchor | ||||
|---|---|---|---|---|
|
Retrieving and Completing Document Requirements
| Anchor | ||||
|---|---|---|---|---|
|
Verifying Correspondence Channels
| Anchor | ||||
|---|---|---|---|---|
|
Retrieving Claim Summary
| Anchor | ||||
|---|---|---|---|---|
|
Submitting Claim and Retrieving Confirmation
| Drawio | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|