Resolve Claims Use Case

Resolve Claims

We consider a claim resolved as soon as there is no need to ask the debtor for any more payments. This can be because the debtor completely paid the claim, the claim was discarded, the claim was written off, or for other reasons.

The easiest way to resolve the claim is to reduce the claim total amount to zero. This will stop all communication with the Debtor.

Example:

Let’s assume that John Doe paid the claim completely. You can send the following request that will resolve the claim and decrease the amount to zero:

POST /v1/3d132b18-6b6f-4f7c-b464-6a8ee7ca5235/update_claims HTTP/1.1
Host: api.receeve-demo.com
Content-Type: application/json
Authorization: {{access_token}}

{
  "claim1": {
    "amount": 0,
    "totalFees": 0,
    "reason": "CLAIM_PAID"
  }
}

Notes:

• The 3d132b18-6b6f-4f7c-b464-6a8ee7ca5235 is the Client Instance ID of your account. This is provided by receeve together with the credentials for the API.
• The claim1 key is the claim reference to resolve.
• The request can include multiple claims. The response will contain the status of each claim.
• You can use the import_claims endpoint to do this, but you need to send all the required fields. You can also use the update_claims endpoint to update only specific fields of an existing claim. The shape of the requests between the import_claims and update_claims endpoints is exactly the same.

The response will be a JSON similar to:

{
  "claim1": {
    "success": true,
    "messageIds": ["89a77253-12e5-4136-918b-acbfad9ecc0a"],
    "messages": ["Successfully updated claim claim1"]
  }
}

Notes:

• The messages are human-readable messages that can be used for debugging.
• The messageIds represent the unique identifier for the intention of importing each claim. They can be used to track the side effects within the system.
• The result of the intention of updating each claim is reported back with the success flag. If it returns false, the claim was not updated and the message will include the details of the error.

FAQ

• How can I get an Access Token? You can get a token using the Authentication Use Case
• What does it mean to resolve a claim? We consider a claim resolved as soon as there is no need to ask the debtor for any more payments. This could be because the debtor completely paid the claim, the claim was discarded, the claim was written off, or for other reasons. Once the claim is resolved, communications with the debtor will stop.
• Can I unresolve a claim? Yes, you can unresolve a claim by sending a request to the update_claims (or import_claims) endpoint with the amount of the claim greater than zero. Notice here that the collection strategy will start from the beginning, so you need to make sure to manage these use cases within the strategy you are using.
• Is there another reason to add when resolving a Claim? Yes, we have the following reasons:
  • CLAIM_PAID: The claim was paid
  • FRAUDULENT: The claim is considered fraudulent
  • CLAIM_DISCARDED: The claim was discarded by the client
  • CLAIM_DISCHARGED: The claim was discharged by the client
  • CLAIM_SOLD: The claim was sold to a third party and the client is not responsible for it anymore
  • CLAIM_INVALIDATED: The claim was disputed by the debtor, and the client decided to invalidate it Notice that to resolve the claim using the update_claims endpoint you need to set the amount to zero, and the total fees to zero.
• Is there a hard limit on the number of claims that I can resolve at once? Yes, the rate limit is 30 Requests per minute. The request can include multiple claims, depending on the type of request:
  • Asynchronous request: 30 Claims per request
  • Synchronous request: 5 Claims per request This means that we have a throughput of:
  • 900 Claims/min (async) - 150 Claims/min (sync)
  • 54,000 Claims/hr (async) - 9,000 Claims/hr (sync)

Related Pages

• Account Claims