Handover Your Claim

It is now time to send your request to our API. To hand over a claim, you will need to include your access token in the authorization header of your request.

Here's how to structure your Claim Handover request:

Sample Header

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

Sample Request

{
  "customer": {
    "customerNumber": "400000535",
    "type": "PRIVATE",
    "preferredLanguage": "de",
    "gender": "male",
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1980-01-01",
    "addresses": [
      {
        "type": "BILLING",
        "street": "Evergreen Street",
        "houseNumber": "100",
        "zipCode": "52589",
        "city": "Notown",
        "countryCode": "DE"
      }
    ],
    "communicationChannels": [
      {
        "type": "PHONE",
        "value": "+49 176 123456"
      },
      {
        "type": "MOBILE_PHONE",
        "value": "+49 176 123456"
      },
      {
        "type": "EMAIL",
        "value": "test@test.de"
      }
    ],
    "bankAccounts": [
      {
        "iban": "DE75400501500123456789",
        "bic": "WELADED1MST"
      }
    ]
  },
  "referenceContacts": [
    {
      "type": "SPOUSE",
      "liable": true,
      "firstName": "Jane",
      "lastName": "Doe",
      "address": {
        "type": "BILLING",
        "street": "EvergreenStreet",
        "houseNumber": "100",
        "zipCode": "52589",
        "city": "Notown",
        "countryCode": "DE"
      },
      "communicationChannels": [
        {
          "type": "PHONE",
          "value": "+49176123456"
        },
        {
          "type": "EMAIL",
          "value": "+49176123456"
        }
      ]
    }
  ],
  "contracts": [
    {
      "contractNumber": "400000507",
      "startDate": "2021-01-01",
      "endDate": "2022-01-01",
      "invoices": [
        {
          "invoiceNumber": "318040697",
          "invoiceDate": "2022-01-01",
          "remainingAmount": 160.00,
          "taxRate": 19.00,
          "currency": "EUR",
          "dueDate": "2022-01-15",
          "placementDate": "2024-04-04",
          "description": "Turusrechnung"
        }
      ]
    }
  ],
  "costs": [
    {
      "type": "REMINDER_FEE",
      "invoiceNumber": "117976352",
      "currency": "EUR",
      "remainingAmount": 16.00,
      "taxRate": 0.00,
      "date": "2022-01-31",
      "description": "Mahnung mit Gerichtsandrohung"
    }
  ]
}

Please Note: Just before you send your request, verify that the request body contains all necessary data. The minimum data requirements for a claim handover include the customer and contract object.

Sample Response

HTTP 202 Accepted

{ 
"requestId": "c93e8aed-41ab-44ef-9176-98c75430b9fb"
}