Get Debtor

{
  "error": false,
  "message": "Success",
  "data": {
    "data": {
      "id": "def456ghi789",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "+33612345678",
      "address": "123 Main Street, 75001 Paris, France",
      "dateOfBirth": "1985-03-15",
      "firstSeenAt": "2024-01-15 10:30:00",
      "lastSeenAt": "2024-01-20 14:22:00",
      "lastUpdatedAt": "2024-01-20 14:22:00",
      "totalDebtAmount": 2500.00,
      "totalPaidAmount": 750.00,
      "averageRepaymentScore": 65,
      "debtsCount": 3
    }
  }
}

{
  "error": true,
  "message": "Authentication credentials are missing or invalid",
  "code": 401
}

{
  "error": true,
  "message": "Required scope \"debtors:read\" not found in token",
  "code": 403
}

{
  "error": true,
  "message": "Debtor not found or not authorized",
  "code": 404
}

Overview

This endpoint returns detailed information about a specific debtor, including aggregated statistics about their debts.

Authentication

Requires a valid OAuth 2.0 access token with the debtors:read scope.

Example Request

curl -X GET "/external-api/v1/debtors/def456ghi789" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

const debtorId = 'def456ghi789';

const response = await fetch(`/external-api/v1/debtors/${debtorId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const debtor = await response.json();

import requests

debtor_id = 'def456ghi789'

headers = {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
}

response = requests.get(
    f'/external-api/v1/debtors/{debtor_id}',
    headers=headers
)

debtor = response.json()

Example Response

{
  "error": false,
  "message": "Success",
  "data": {
    "data": {
      "id": "def456ghi789",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "+33612345678",
      "address": "123 Main Street, 75001 Paris, France",
      "dateOfBirth": "1985-03-15",
      "firstSeenAt": "2024-01-15 10:30:00",
      "lastSeenAt": "2024-01-20 14:22:00",
      "lastUpdatedAt": "2024-01-20 14:22:00",
      "totalDebtAmount": 2500.00,
      "totalPaidAmount": 750.00,
      "averageRepaymentScore": 65,
      "debtsCount": 3
    }
  }
}

{
  "error": true,
  "message": "Authentication credentials are missing or invalid",
  "code": 401
}

{
  "error": true,
  "message": "Required scope \"debtors:read\" not found in token",
  "code": 403
}

{
  "error": true,
  "message": "Debtor not found or not authorized",
  "code": 404
}

Rate Limiting

This endpoint is subject to rate limiting. See the Rate Limits documentation for details. Rate Limit: 1,000 requests per hour

List Debtors - Get a list of all debtors
Update Debtor - Update debtor information
List Debts by Debtor - Get all debts for this debtor

Get started

Guides

SFTP integration

Company API

Creditors API

Debtors API

Debts API

Timelines API

Campaigns API

Settings API

Invoice documents API

Followups API

Todos API

Status API

Overview

Authentication

Example Request

Example Response

Rate Limiting

​Overview

​Authentication

​Example Request

​Example Response

​Rate Limiting

​Related Endpoints

Overview

Authentication

Example Request

Example Response

Rate Limiting

Related Endpoints