Skip to main content

Account

Collection Partner Profile

Base URL
https://collectionpartner-api.debitura.com
Authentication
API key in the XApiKey header

Verifies the provided API key and returns the collection partner profile

GET/me

Returns the authenticated collection partner's profile information when the XApiKey header is valid.

Authentication

  • Requires a valid API key in the XApiKey header
  • The API key uniquely identifies the collection partner

Response Data

  • Partner identification (ID, company name, registration details)
  • Contact information (email, phone)
  • Address and location details
  • Billing and invoicing configuration
  • Revenue sharing settings
  • Partner permissions and access levels

Use Cases

  • Verify API key validity and partner identity
  • Retrieve partner profile for display in integrations
  • Access billing and revenue share configuration
  • Check partner permissions and access levels

Returns

200 Collection partner profile retrieved successfully

  • iduuid

    Unique identifier for the collection partner.

  • companyNamestringnullable

    Company name of the collection partner.

  • logoUrlstringnullable

    URL to the partner's logo image.

  • companyRegistrationNumberstringnullable

    Company registration number.

  • vatNumberstringnullable

    Company VAT number.

  • addressstringnullable

    Street address of the company.

  • zipCodestringnullable

    Zip/postal code.

  • citystringnullable

    City name.

  • statestringnullable

    State or region.

  • countrystringnullable

    Country name (not included in automatic mapping).

  • officeEmailstringnullable

    Office email address.

  • officePhonestringnullable

    Office phone number.

  • invoiceEmailstringnullable

    Invoice email address.

  • billingContactstringnullable

    Billing contact person name.

  • invoiceCurrencyintegernullable

    Invoice currency ID (nullable - defaults to country currency if not set).

  • commissionTypeenum
    One ofStandardSuccessFeeOnlyCommission
  • preLegalRevenueSharenumbernullable

    Revenue share percentage for pre-legal cases (decimal, e.g., 0.40 for 40%).

  • legalRevenueSharenumbernullable

    Revenue share percentage for legal cases (decimal, e.g., 0.20 for 20%).

  • verifiedProfileboolean

    Whether this partner has a verified profile (has verified link or overwrite enabled).

  • fullAddressstringnullable

    Full concatenated address string.

  • surveyCadenceModeenum
    One ofStandardDecisionPointOnly

Errors

401Missing or invalid API key
404Collection partner not found
500Internal server error

Every error uses the same body shape. See Error handling.

GET/me
curl https://collectionpartner-api.debitura.com/me \
-H "XApiKey: $DEBITURA_API_KEY"
Response
{
"id": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
"companyName": "Muster GmbH",
"logoUrl": "https://app.debitura.com/…",
"companyRegistrationNumber": "DE123456789",
"vatNumber": "DE123456789",
"address": "Friedrichstraße 68",
"zipCode": "10115",
"city": "Berlin",
"state": "string",
"country": "Germany",
"officeEmail": "finance@example.com",
"officePhone": "+49 30 1234567",
"invoiceEmail": "finance@example.com",
"billingContact": "string",
"invoiceCurrency": 3,
"commissionType": "Standard",
"preLegalRevenueShare": 1.5,
"legalRevenueShare": 1.5,
"verifiedProfile": true,
"fullAddress": "Friedrichstraße 68",
"surveyCadenceMode": "Standard"
}