Completeness

Completeness evaluates whether available transaction data is sufficiently complete and reliable to support a lending decision. It provides a scored assessment of coverage, data quality, and recommended actions for borderline cases.

Prefer using the web app?

When you submit transaction data in the Walker Street Data sandbox application, and your API key has the customer:completeness scope, a completeness score is automatically calculated. This guide details the equivalent workflow using the API.

Prerequisites

• Valid customerId — see Create a Customer
• Enriched transactions available for that customer — see Extract Bank Statement Transactions or Classify Transactions
• API scope: customer:completeness

Endpoint

GET https://api.walkerstdata.com.au/v1/customer/{customerId}/completeness

Request Parameters

Parameter	Location	Required	Description
customerId	path	Yes	Unique customer identifier
jobId	query	No	Filter completeness calculation to a specific enrichment job

Example Request

cURL

curl -X GET "https://api.walkerstdata.com.au/v1/customer/{customerId}/completeness" \
  -H "x-api-key: YOUR_API_KEY"

JavaScript

const customerId = 'your-customer-id';

const response = await fetch(
  `https://api.walkerstdata.com.au/v1/customer/${customerId}/completeness`,
  {
    method: 'GET',
    headers: { 'x-api-key': 'YOUR_API_KEY' },
  }
);

const result = await response.json();
console.log(result.data.summary);

Filtering by Job

cURL

curl -X GET "https://api.walkerstdata.com.au/v1/customer/{customerId}/completeness?jobId={jobId}" \
  -H "x-api-key: YOUR_API_KEY"

JavaScript

const customerId = 'your-customer-id';
const jobId = 'your-job-id';

const response = await fetch(
  `https://api.walkerstdata.com.au/v1/customer/${customerId}/completeness?jobId=${jobId}`,
  {
    method: 'GET',
    headers: { 'x-api-key': 'YOUR_API_KEY' },
  }
);

const result = await response.json();
console.log(result.data.summary);

Response Fields

Summary

The summary object gives the top-level completeness picture:

Field	Description
completenessScore	Numeric score representing overall data completeness
completenessTier	Named band indicating the level of overall data completeness
totalMissingness	Overall proportion of missing data across the customer's transaction history

Bank Account Coverage

The bankAccounts array reports coverage metrics per account:

Field	Description
bsb	Bank State Branch number
bank	Institution name
accountNumber	Account number
accountPurpose	Identified purpose of the account
dataStatus	Current status of the data for this account
coverage.startDate	Earliest transaction date in the available data
coverage.endDate	Latest transaction date in the available data
coverage.largestGapDays	Largest continuous gap in transaction history, in days
coverage.percentDaysMissing	Proportion of days between the start and end date with no transaction data

Additional Assessment Fields

Field	Description
rankedFeatures	Features ranked by their contribution to the completeness score, with comparison to benchmark and missingness impact
dataQualityAssessments	List of specific quality checks and their pass/fail outcomes
recommendedActions	Prioritised actions to improve data coverage or address gaps

Interpreting Results for Credit

• A higher completenessScore supports greater confidence in decisioning
• Review largestGapDays and percentDaysMissing on each account — large or recent gaps may indicate suppressed or unavailable data
• Use recommendedActions to determine whether to request additional statements or escalate to manual review
• Apply a minimum completeness threshold as part of your credit policy before proceeding to Aggregations or Risk Score

Common Errors

Status	Cause
400	jobId is invalid or the completeness calculation failed
403	Missing API scope customer:completeness

Next Steps

• Aggregations — Review cashflow and behavioural summaries once data coverage is confirmed
• Risk Score — Proceed to predictive risk assessment after validating completeness
• API Reference — Full endpoint schema and parameter details