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#/Intake0
Intake API
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 | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
- 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 | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
- 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 | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
- After Creating A Claim, use the endpoint, www.example.com/QFDAPI/v1/claim/intake/retrieveReasons to get
Anchor | ||||
---|---|---|---|---|
|
Retrieving and Adding Transactions
...