Guide

Assess from a bank statement

Enough history, a reading, and what it can service.

1. 1

   Check there is enough history

   How many days of statement the product needs, and whether the accounts held cover them.

   curl -s -X POST https://app.creditcresttechnologies.com.au/v1/evidence/coverage \
     -H "authorization: Bearer $CREDITCREST_KEY" \
     -H 'content-type: application/json' \
     -d '{"product":"sacc","accounts":[{"id":"everyday","role":"income","from":"2026-03-01","to":"2026-08-28"}],"applicationDay":"2026-08-31"}'

   {
     "complete": true,
     "requirement": {
       "incomeAccountDays": 90,
       "why": "90 days (statute: NCCP Act ss 117(1A), 130(1A))"
     },
     "accounts": [
       {
         "role": "income",
         "needs": 90,
         "covered": true
       }
     ]
   }

2. 2

   Read the statement

   The same call as the quickstart. Reference

   curl -s -X POST https://app.creditcresttechnologies.com.au/v1/statement \
     -H "authorization: Bearer $CREDITCREST_KEY" \
     -H 'content-type: text/csv' \
     --data-binary @statement.csv

   {
     "period": {
       "from": "2026-03-01",
       "to": "2026-08-28",
       "days": 181,
       "months": 5.95
     },
     "income": {
       "verifiedMonthly": 5026.67,
       "regular": [
         {
           "description": "DIRECT CREDIT 049211 ACME LOGISTICS PAYROLL",
           "period": "fortnightly",
           "monthly": 5026.67,
           "transactions": ["r1", "r2", "r3", …]
         }
       ]
     },
     "commitments": {
       "monthly": 2150
     },
     "expenses": {
       "monthly": {
         "essential": 3497.94,
         "discretionary": 162.68
       }
     },
     "signals": []
   }

3. 3

   Test the loan

   Serviceability at the buffered rate, and the most it could borrow. Reference

   curl -s -X POST 'https://app.creditcresttechnologies.com.au/v1/capacity?loan=15000&rate=12&years=5' \
     -H "authorization: Bearer $CREDITCREST_KEY" \
     -H 'content-type: text/csv' \
     --data-binary @statement.csv

   {
     "service": {
       "assessmentRate": 0.15,
       "monthlySurplus": 1009.2,
       "netSurplusRatio": 0.2008,
       "debtServiceRatio": 0.4987
     },
     "capacity": {
       "principal": 57300,
       "binds": "serviceability"
     }
   }

4. 4

   Check one line

   Any transaction, categorised with its reason. Reference

   curl -s 'https://app.creditcresttechnologies.com.au/v1/enrich?description=WOOLWORTHS%201234%20SYDNEY&amount=-84.20'

   {
     "category": {
       "code": "groceries",
       "label": "Groceries",
       "group": "essential",
       "known": true
     },
     "third_party": {
       "name": "WOOLWORTHS",
       "known": true,
       "basis": "name"
     },
     "confidence": {
       "value": 0.99,
       "band": "named",
       "why": "A rule matched the merchant’s name in the description."
     }
   }