Account
Collection Partner Profile
- Base URL
https://collectionpartner-api.debitura.com- Authentication
- API key in the
XApiKeyheader
Verifies the provided API key and returns the collection partner profile
/meReturns 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
iduuidUnique identifier for the collection partner.
companyNamestringnullableCompany name of the collection partner.
logoUrlstringnullableURL to the partner's logo image.
companyRegistrationNumberstringnullableCompany registration number.
vatNumberstringnullableCompany VAT number.
addressstringnullableStreet address of the company.
zipCodestringnullableZip/postal code.
citystringnullableCity name.
statestringnullableState or region.
countrystringnullableCountry name (not included in automatic mapping).
officeEmailstringnullableOffice email address.
officePhonestringnullableOffice phone number.
invoiceEmailstringnullableInvoice email address.
billingContactstringnullableBilling contact person name.
invoiceCurrencyintegernullableInvoice currency ID (nullable - defaults to country currency if not set).
commissionTypeenumOne ofStandardSuccessFeeOnlyCommissionpreLegalRevenueSharenumbernullableRevenue share percentage for pre-legal cases (decimal, e.g., 0.40 for 40%).
legalRevenueSharenumbernullableRevenue share percentage for legal cases (decimal, e.g., 0.20 for 20%).
verifiedProfilebooleanWhether this partner has a verified profile (has verified link or overwrite enabled).
fullAddressstringnullableFull concatenated address string.
surveyCadenceModeenumOne ofStandardDecisionPointOnly
Errors
401 | Missing or invalid API key |
404 | Collection partner not found |
500 | Internal server error |
Every error uses the same body shape. See Error handling.
curl https://collectionpartner-api.debitura.com/me \-H "XApiKey: $DEBITURA_API_KEY"
{"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"}