Sign in

d0dcc5024bd1

latestOpenAPI 3.0.42026-08-104969330.3 KB
Me

Verifies the provided API key and returns the collection partner profile

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
get/me

Response

Collection partner profile retrieved successfully

idstring uuid

Unique identifier for the collection partner.

companyNamestring nullable

Company name of the collection partner.

logoUrlstring nullable

URL to the partner's logo image.

companyRegistrationNumberstring nullable

Company registration number.

vatNumberstring nullable

Company VAT number.

addressstring nullable

Street address of the company.

zipCodestring nullable

Zip/postal code.

citystring nullable

City name.

statestring nullable

State or region.

countrystring nullable

Country name (not included in automatic mapping).

officeEmailstring nullable

Office email address.

officePhonestring nullable

Office phone number.

invoiceEmailstring nullable

Invoice email address.

billingContactstring nullable

Billing contact person name.

invoiceCurrencyinteger nullable

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

commissionType0 | 1
preLegalRevenueSharenumber double nullable

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

legalRevenueSharenumber double nullable

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).

fullAddressstring nullable

Full concatenated address string.

surveyCadenceMode0 | 1