TrueAccord Python API Docs | dltHub
Build a TrueAccord-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
TrueAccord is a debt recovery platform providing a REST Recover API to upload customers/debts, query statuses, and report payments. The REST API base URL is https://api.trueaccord.com/api/v1/ and all requests require HTTP Basic auth using an API key as username (password ignored)..
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading TrueAccord data in under 10 minutes.
What data can I load from TrueAccord?
Here are some of the endpoints you can load from TrueAccord:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| customers | customers/ | GET | customers | List customers (paginated; supports count, offset, startTime, endTime, reference) |
| customer | customers/{customerId} | GET | Get one customer object (single Customer JSON object) | |
| customers_batch | customersBatch/ | POST | responses | Add customers (V2 returns responses array) |
| debts | customers/{customerId}/debts/ | GET | debts | List debts of a customer |
| debt_total_to_collect | customers/{customerId}/debts/{debtId}/totalToCollectBalance | GET | Get debt totalToCollectBalance (Balance Snapshot object) | |
| payments | customers/{customerId}/debts/{debtId}/payments/ | GET | payments | List payments for a debt |
| payments_all | customers/payments/ | GET | payments | List all payments for a creditor (requires time window query params) |
| payment_plans | debts/{debtId}/paymentPlans | GET | List payment plans for a debt (requires from/to query params) | |
| creditor_brands | creditors/{creditorId}/brands/ | GET | List brands for creditorId | |
| creditor_info | creditors/{creditorId}/info | GET | Get creditor information |
How do I authenticate with the TrueAccord API?
Authenticate with HTTP Basic Authentication where the API key is used as the username and the password is left blank. Include X-TA-CREDITOR header when the API key is associated with multiple creditors for customer endpoints.
1. Get your credentials
- Log in to the TrueAccord business/Recover dashboard (contact your TrueAccord representative if you lack access). 2) In account settings or API credentials section, create or view your Recover API key. 3) Copy the API key and use it as the HTTP Basic auth username; leave the password blank. 4) If your account is associated with multiple creditors, obtain the relevant creditor ID and supply it in the X-TA-CREDITOR header for customer endpoints.
2. Add them to .dlt/secrets.toml
[sources.trueaccord_recover_source] api_key = "your_api_key_here"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the TrueAccord API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python trueaccord_recover_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline trueaccord_recover_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset trueaccord_recover_data The duckdb destination used duckdb:/trueaccord_recover.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline trueaccord_recover_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads customers and payments from the TrueAccord API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def trueaccord_recover_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.trueaccord.com/api/v1/", "auth": { "type": "http_basic", "api_key": api_key, }, }, "resources": [ {"name": "customers", "endpoint": {"path": "customers/", "data_selector": "customers"}}, {"name": "payments", "endpoint": {"path": "customers/payments/", "data_selector": "payments"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="trueaccord_recover_pipeline", destination="duckdb", dataset_name="trueaccord_recover_data", ) load_info = pipeline.run(trueaccord_recover_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("trueaccord_recover_pipeline").dataset() sessions_df = data.customers.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM trueaccord_recover_data.customers LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("trueaccord_recover_pipeline").dataset() data.customers.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load TrueAccord data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Troubleshooting
Authentication failures
If requests return 401/403, ensure you are using HTTP Basic auth with the API key as username and an empty password. If your API key is associated with multiple creditors, include header X-TA-CREDITOR: <creditorId> for customer endpoints; omission can produce 403 Forbidden.
Pagination and rate limits
Customer and other list endpoints use count (max 100) and offset pagination. Use totalResults returned in list responses to paginate; when more than 100 results, increment offset. There is no public rate limit documented in Recover API docs—handle 429/5XX with retries and exponential backoff.
Common API error responses
The API returns structured Error objects on 4XX/5XX with fields: status (integer error code), msg (string), errorInfo (JSON or null). Known error codes include 102 (INVALID_REQUEST), 104 (INPUT_ERROR), 403 (FORBIDDEN), 404 (OBJECT_DOES_NOT_EXIST), 422 (UNPROCESSABLE_ENTITY), 500 (INTERNAL_ERROR), and compliance error 451. See Recover API Errors.
Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for TrueAccord?
Request dlt skills, commands, AGENT.md files, and AI-native context.