Learn Center has been sunset. Visit our new Docs site at: docs.canopyservicing.com

DataDirect Getting Started

1. Access Your Credentials

Your DataDirect credentials can be retrieved via the following API call:
GET /organization/data_direct
The response will be formatted as follows:
{ "host": "***********.amazonaws.com", "password": "**********", "port": 5432, "username": "*********" }

2. Connect

From your preferred database querying tool, start a new PostgreSQL connection.
Example free querying tool: DBeaver
You should be prompted with a form to enter in the credential information you received in the call you made above.

Query Your Data

Now that you have connected DataDirect to your query tool of choice and are aware of which entities you can query, you’re ready to begin building your own queries! Below are the entities available along with their related fields.

Entity Relationships

Image without caption

Identifying Data Freshness

DataDirect data is typically refreshed every hour. To identify the time of the last refresh and the exact time at which a particular tables’ is representative of you can check for the most recent related record in the refresh_history_table.
select table_id, table_name, last_updated_at from data_direct.refresh_history_table;

Available Entities and Fields

You will notice that DataDirect has two versions of each entity.
You will notice that DataDirect has two versions of each entity.
A version without the _table suffix: This is a native Postgres table. This version has been created to enable connecting to ETL tooling. A version in the form of <table_name>_table: This is a foreign Postgres table.
Both tables contain the same data; <table_name>_table will eventually be deprecated.
Line Items
Amortization Schedule
Statement Line Items
Card Transactions

Pre-built Reports

Pre-built reports within DataDirect are reports common to lending operations that we have pre-written the SQL and surfaced in table form for ease of use. It’s important to note that because these are strictly pre-written and run SQL queries, they are distinctly different than the other entities within DataDirect.
Delinquency Report