Clients

Get client by external tenant ID

Changed on

Retrieves detailed information for a specific client using your unique identifier (External Tenant ID).

Path Parameter

  • externalTenantId - Your unique identifier for this client (the same value used during client creation)

Response Data The response includes complete client information:

  • ExternalTenantId - Your unique identifier for this client
  • OnboardingDone - Whether the client has completed onboarding (signed debt collection agreements)
  • OnboardingLinks - If onboarding incomplete, contains URL to complete the process
  • Client - Complete client information
    • Debitura-assigned client ID (Guid)
    • Company name and registration number
    • Country and address details
    • Contact information (email, phone)
  • Users - List of all users associated with this client
    • User ID, email, first name, last name

Use Cases

  • Look up client details using your internal identifier
  • Check client onboarding status
  • Retrieve Debitura client ID for use with the Customer API (via OAuth token endpoint)
  • Get client information before creating cases
  • Verify client link is still active

Error Cases

  • 404 Not Found - No active client link exists for this External Tenant ID and your partner account
    • Client was never created
    • Client link was archived
    • External Tenant ID belongs to different referral partner
  • 500 Internal Server Error - Unexpected server error

Important Notes

  • Only returns active (non-archived) client links
  • External Tenant ID is case-sensitive
  • The client must be linked to your referral partner account
  • Use the returned client ID with the OAuth token endpoint to generate bearer tokens for Customer API access
get/clients/{externalTenantId}

Request

  • Base URL
    https://referral-api.debitura.com
  • URL
    https://referral-api.debitura.com/clients/{externalTenantId}
  • Auth
    API key in header XApiKey

Path parameters

externalTenantIdstring required

Response

Client retrieved successfully

externalTenantIdstring nullable
onboardingDoneboolean
isAttributedClientboolean
dateLinkedstring date-time
kycStatus'NotRequired' | 'Pending' | 'Verified'

KYC (Know Your Customer) verification status for a client linked to a referral partner. Captures three distinct states that a simple boolean cannot express. Sent as snake_case string values: "not_required", "pending", "verified".

Example response

{
  "caseResults": {
    "successfulCases": [
      {
        "debtor": {
          "type": "Company",
          "name": "Pacific Trading LLC",
          "contactPerson": "John Smith",
          "companyRegistrationNumber": "47-1234567",
          "address": "123 Market Street, Suite 400",
          "zipCode": "94105",
          "city": "San Francisco",
          "state": "California",
          "stateAlpha2": "CA",
          "countryAlpha2": "US",
          "country": "United States",
          "email": "accounts@pacifictrading.com",
          "phone": "+1 415 555 0123"
        }
      }
    ]
  }
}

Changes

    • breaking

      the response property / became nullable for the status (media type: text/plain)

    • breaking

      the response property / became nullable for the status (media type: application/json)

    • breaking

      the response property / became nullable for the status (media type: text/json)

    • warning

      added the new undefined enum value to the / response property for the response status (media type: text/plain)

    • warning

      added the new undefined enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new undefined enum value to the / response property for the response status (media type: text/json)

    • info

      response property caseResults/successfulCases/items/collectionPartner/surveyCadenceMode deprecated (media type: text/plain)

    • info

      response property caseResults/successfulCases/items/collectionPartner/surveyCadenceMode deprecated (media type: application/json)

    • info

      response property caseResults/successfulCases/items/collectionPartner/surveyCadenceMode deprecated (media type: text/json)