riverty logo

Docs

Submit a Claim

Submitting a claim is a crucial step in the debt collection process. It involves providing detailed information about the client’s customer as highlighted in the section Create a Claim. The submission process is designed to ensure all necessary data is captured accurately and efficiently.

Step-by-step Guide to Submitting a Claim

  1. Ensure you have completed the integration steps and obtained your client credentials.
  2. Authenticate using your credentials.
  3. Gather all necessary information for the claim, including customer details, contracts, and any additional costs or interests.
  4. Construct the JSON payload with the required objects.
  5. Send a POST request to the claims endpoint with the constructed payload.

Please Note: Remember to include the your access token in the authorization of your request.

Claim Handover

To submit a claim (Claim Handover), send a POST request to the claims endpoint with the constructed payload.

Sample Authorization Header

POST {{collection_api_base_url}}/v1/claims
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{access_token}}

Sample Request Body

"customer": {
    "customerNumber": "B1140280585",
    "gender": "female",
    "title": "Ms.",
    "firstName": "Bianka",
    "lastName": "Hilll",
    "dateOfBirth": "1946-01-01",
    "type": "PRIVATE",
    "addresses": [
        {
            "street": "640 Carrie Crest",
            "zipCode": "56695-0518",
            "city": "West Mattiemouth",
            "countryCode": "TZ",
            "type": "billing"
        }
    ]
},
"contracts": [
    {
        "contractNumber": "V8157366331",
        "startDate": "2018-06-23",
        "endDate": "2023-06-23",
        "invoices": [
            {
                "invoiceNumber": "I5408705335",
                "invoiceDate": "2023-06-23",
                "remainingAmount": 100,
                "originalAmount": 120,
                "currency": "EUR"
            }
        ]
    }
]

Please Note: A successful request should return a 202 ACCEPTED response, indicating that the claim has been successfully handed over for processing.

Validation and Processing

After submitting your claim, our system will perform a basic check to ensure all mandatory fields are filled with the correct data formats.

If the request is valid, it will be processed asynchronously in our backend.

Claim Processing outcome

You can retrieve the processing outcome (confirmation or rejection) using the /transactions endpoint. This provides essential information about the status of your claim, including details for tracking and resolving any issues.

For more information on how to retrieve these details, please refer to the Claim Processing Outcome.

Do you find this page helpful?