Skip to content

Assess API API

by codat.io

API keyHTTPSFinance
Open documentation ↗

Overview

Codat's Assess API enable you to make smarter credit decisions on your small business customers. Assess enriches your customer's accounting, commerce and banking data to surface actionable insights you didn't have before. [Read more...](https://www.codat.io/assess/) [See our OpenAPI spec](https://github.com/codatio/oas)

Assess API is a finance API from codat.io. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 27 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Category
Finance
Base URL
https://api.codat.io
Version
1.0
Endpoints
27
Spec updated
2023-04-18

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.codat.io/companies/COMPANYID/reports/enhancedBalanceSheet/accounts" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://api.codat.io/companies/COMPANYID/reports/enhancedBalanceSheet/accounts", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.codat.io/companies/COMPANYID/reports/enhancedBalanceSheet/accounts",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/companies/{companyId}/reports/enhancedBalanceSheet/accountsEnhanced Balance Sheet Accounts
GET/companies/{companyId}/reports/enhancedCashFlow/transactionsGet enhanced cash flow report
GET/companies/{companyId}/reports/enhancedInvoicesEnhanced Invoices Report
GET/companies/{companyId}/reports/enhancedProfitAndLoss/accountsEnhanced Profit and Loss Accounts
GET/data/assess/accounts/categoriesdeprecatedList account categories
GET/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/detailsLists data integrity details for date type
GET/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/statusGet data integrity status
GET/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summariesGet data integrity summary
GET/data/companies/{companyId}/assess/excelGet status of Excel report
POST/data/companies/{companyId}/assess/excelGenerate an Excel report
GET/data/companies/{companyId}/assess/excel/downloadDownload generated excel report
POST/data/companies/{companyId}/assess/excel/downloaddeprecatedDownload generated excel report
GET/data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketingGet the marketing metrics from an accounting source for a given company.
GET/data/companies/{companyId}/connections/{connectionId}/assess/accounts/categoriesdeprecatedList suggested and confirmed account categories
PATCH/data/companies/{companyId}/connections/{connectionId}/assess/accounts/categoriesdeprecatedConfirm categories for accounts
GET/data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categoriesdeprecatedGet suggested and/or confirmed category for a specific account
PATCH/data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categoriesdeprecatedPatch account categories
GET/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetentionGet the customer retention metrics for a specific company.
GET/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValueGet the lifetime value metric for a specific company.
GET/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/ordersGet order information for a specific company
GET/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refundsGet the refunds information for a specific company
GET/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenueCommerce Revenue Metrics
GET/data/companies/{companyId}/connections/{connectionId}/assess/enhancedBalanceSheetdeprecatedEnhanced Balance Sheet
GET/data/companies/{companyId}/connections/{connectionId}/assess/enhancedProfitAndLossdeprecatedEnhanced Profit and Loss
GET/data/companies/{companyId}/connections/{connectionId}/assess/financialMetricsdeprecatedList financial metrics
GET/data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/mrrGet key metrics for subscription revenue
GET/data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/processRequest production of key subscription revenue metrics

Questions

Does the Assess API API need an API key?

Yes. The Assess API API uses API key authentication; the documentation explains how to get credentials.

Does the Assess API API support HTTPS?

Yes, the Assess API API is served over HTTPS.

How many endpoints does the Assess API API have?

Its OpenAPI description lists 27 endpoints in version 1.0. All of them are shown on this page.

What are alternatives to the Assess API API?

Other Finance APIs include Stripe, SEC EDGAR Data, Plaid, Fed Treasury, Razorpay IFSC.

Compare alternatives →

Listed from APIs.guru (CC0).