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.
...
Intake API
Creating a Claim
Retrieving and Adding Claim Reasons
...
- 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 |
---|
|
Anchor |
---|
| RetrievingAddingClaimReasons |
---|
| RetrievingAddingClaimReasons |
---|
|
Retrieving and Adding Claim Reasons
...