# CDR Register (Australian Open Banking) (`mrjerry/cdr-register`) Actor

Lists data holders and their CDR participation status from the official Australian CDR Register. Two modes: holders (per-brand details with industry, ABN, public base URI) and status (per-legal-entity ACTIVE/REMOVED).

- **URL**: https://apify.com/mrjerry/cdr-register.md
- **Developed by:** [Huxley](https://apify.com/mrjerry) (community)
- **Categories:** Other, Open source
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## CDR Register (Australian Open Banking)

[![Apify Store](https://img.shields.io/badge/Apify-Store-blueviolet?logo=apify)](https://apify.com/mrjerry/cdr-register)
[![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)

Lists the data holders and legal entities registered under Australia's **Consumer Data Right (CDR)** — the open-banking regime run by the ACCC. Two modes:

- **`holders`** (default) — list data-holder brands (banks, energy retailers, non-bank lenders), with the industries they support, their public base URI, ABN/ACN, and logo.
- **`status`** — list every legal entity in the Register with its current CDR status (`ACTIVE` or `REMOVED`).

The Actor talks to the official CDR Register REST API at `https://api.cdr.gov.au/cdr-register/v1/`. No auth, no rate limiting, no scraping.

---

### Output shape (holders mode)

```json
{
  "kind": "data_holder_brand",
  "brand_id": "ceca4dce-3f8f-ef11-95f6-000d3a79c46e",
  "interim_id": "fe051e80-e743-44e1-ae83-a4d6286eb596",
  "brand_name": "Alex.Bank",
  "industries": ["banking"],
  "public_base_uri": "https://public.cdr.alex.com.au",
  "abn": "13627244848",
  "acn": "627244848",
  "logo_uri": "https://www.alex.bank/assets/alex-bank-logo.png",
  "last_updated": "2026-07-01T12:14:23Z",
  "fetched_at": "2026-07-09T14:19:48Z",
  "status": null,
  "legal_entity_status_counts": {"ACTIVE": 99, "REMOVED": 14}
}
````

### Output shape (status mode)

```json
{
  "kind": "legal_entity_status",
  "legal_entity_id": "e339fcd4-b5b8-ed11-a852-000d3a8842e1",
  "status": "ACTIVE",
  "fetched_at": "2026-07-09T14:20:10Z"
}
```

***

### Quick start

```bash
## All 117 banking brands
apify call mrjerry/cdr-register --input '{"mode":"holders","industry":"banking"}'

## All brands with "AMP" in the name (catches AMP Bank GO, My AMP, Ampol Energy)
apify call mrjerry/cdr-register --input '{"mode":"holders","name_contains":"AMP"}'

## First 5 banking brands
apify call mrjerry/cdr-register --input '{"mode":"holders","industry":"banking","limit":5}'

## Every legal entity with its CDR status (113 records: 99 ACTIVE, 14 REMOVED)
apify call mrjerry/cdr-register --input '{"mode":"status"}'
```

From Python:

```python
from apify_client import ApifyClient
client = ApifyClient(token="YOUR_API_TOKEN")

run = client.actor("mrjerry/cdr-register").call(
    run_input={"mode": "holders", "industry": "banking"},
)
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item["brand_name"], "->", item["public_base_uri"])
```

***

### Inputs

| Field           | Mode       | Type    | Default          | Description |
|-----------------|------------|---------|------------------|-------------|
| `mode`          | all        | string  | `holders`        | `holders` (default) or `status`. |
| `industry`      | holders    | string  | `all`            | `banking`, `energy`, `non-bank-lending`, or `all`. |
| `name_contains` | holders    | string  | —                | Case-insensitive substring match on the brand name, e.g. `commbank`, `AMP`, `paypal`. |
| `status`        | holders    | string  | —                | `ACTIVE` or `REMOVED`. The Register API doesn't expose brand-level status, so this is a forward-compatible filter — when the Register adds it, the filter will start working. |
| `limit`         | holders    | integer | —                | Cap the number of brand records pushed. |

***

### What's in the Register

As of mid-2026 the Register has:

- **~200** data-holder brands across three sectors
- **113** legal entities with `ACTIVE` or `REMOVED` status
- Three CDR sectors: **banking** (Big 4 + neobanks + non-bank lenders), **energy** (retailers), and **non-bank-lending** (mortgage managers, etc.)

Notable banking brands discovered by the Actor include: Alex.Bank, AMP Bank GO, ANZ, Bank of Queensland, Bendigo Bank, CBA, Citibank, HSBC, ING, Macquarie, MyState Bank, NAB, PayPal Australia, Suncorp, Tyro, Westpac, and many more.

***

### How it works

The Actor calls two endpoints of the official CDR Register:

| Endpoint                                          | What it returns |
|---------------------------------------------------|-----------------|
| `GET /cdr-register/v1/{industry}/data-holders/brands/summary` | Per-brand info: name, publicBaseUri, ABN/ACN, logoUri, industries, lastUpdated. |
| `GET /cdr-register/v1/all/data-holders/status`                | Per-legal-entity ACTIVE/REMOVED status. |

Both endpoints require the `x-v: 1` header (per the Consumer Data Standards) but no authentication. The Actor does a single GET per run, normalises the response, and pushes one record per brand (or per legal entity, in `status` mode) to the Apify Dataset.

***

### Use as an LLM tool

Three natural agent tasks this Actor enables:

1. **"Is bank X on CDR?"** — `mode: "holders", name_contains: "<bank>", industry: "banking"`. A hit means they're on CDR; the `publicBaseUri` field is where to find their public product API.
2. **"Which banks are on CDR?"** — `mode: "holders", industry: "banking"`. Get every banking brand in the Register.
3. **"Has any bank recently left CDR?"** — `mode: "status"`, then look for `status: "REMOVED"` records.

You can wrap the Actor as an MCP server with the `python-mcp-empty` template to expose it directly to Claude as a tool.

***

### Local development

```bash
## Install
pip install -r requirements.txt

## Run with a test input
echo '{"mode":"holders","industry":"banking","limit":3}' \
    > storage/key_value_stores/default/INPUT.json
apify run

## Inspect
ls storage/datasets/default/
cat storage/datasets/default/000000001.json
```

***

### Limits & gotchas

- **No brand-level status field.** The Register's `status` endpoint is keyed by `legalEntityId`; brand records are keyed by `dataHolderBrandId`. There's no public join. Each brand record carries a `legal_entity_status_counts` field that summarises the Register-wide ACTIVE/REMOVED totals so callers can at least see the trend.
- **No retry on transient errors.** The CDR Register is reliable; add `tenacity` if you need it.
- **Free plan = zero monetization.** On Apify's free tier you pay for compute with monthly free credits. The Actor is tiny (one HTTP GET per mode) so cost is negligible.
- **Data recipients aren't covered yet.** The `data-recipients/brands/summary` endpoint is not currently public (returns 404 on the public API). If it goes live, this Actor will be the natural place to add a `recipients` mode.

***

### License

MIT.

# Actor input Schema

## `mode` (type: `string`):

What the Actor should do. 'holders' (default) lists data-holder brands (banks, energy retailers, non-bank lenders) registered for the Consumer Data Right, with their industry scope, public base URI, ABN/ACN, and logo. 'status' lists every legal entity in the Register with its ACTIVE/REMOVED status — useful for spotting banks that have left CDR.

## `industry` (type: `string`):

Optional. Restrict holders results to one CDR sector: 'banking', 'energy', or 'non-bank-lending'. Use 'all' (default) for every sector.

## `name_contains` (type: `string`):

Optional. Case-insensitive substring match on the brand name, e.g. 'commbank' or 'AMP'. Useful when you want one bank's record.

## `status` (type: `string`):

Optional. Filter brands by CDR participation status: 'ACTIVE' or 'REMOVED'. The current Register API doesn't expose brand-level status, so this filter is a placeholder — set it and we'll surface a status field per record when the Register API starts exposing it.

## `limit` (type: `integer`):

Optional. Cap the number of brand records pushed to the dataset. Use when iterating the Register in pieces.

## Actor input object example

```json
{
  "mode": "holders",
  "industry": "all"
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("mrjerry/cdr-register").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("mrjerry/cdr-register").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call mrjerry/cdr-register --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=mrjerry/cdr-register",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "CDR Register (Australian Open Banking)",
        "description": "Lists data holders and their CDR participation status from the official Australian CDR Register. Two modes: holders (per-brand details with industry, ABN, public base URI) and status (per-legal-entity ACTIVE/REMOVED).",
        "version": "0.1",
        "x-build-id": "j9sSFKQT6N5n5vZhh"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/mrjerry~cdr-register/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-mrjerry-cdr-register",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/mrjerry~cdr-register/runs": {
            "post": {
                "operationId": "runs-sync-mrjerry-cdr-register",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/mrjerry~cdr-register/run-sync": {
            "post": {
                "operationId": "run-sync-mrjerry-cdr-register",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "required": [
                    "mode"
                ],
                "properties": {
                    "mode": {
                        "title": "Mode",
                        "enum": [
                            "holders",
                            "status"
                        ],
                        "type": "string",
                        "description": "What the Actor should do. 'holders' (default) lists data-holder brands (banks, energy retailers, non-bank lenders) registered for the Consumer Data Right, with their industry scope, public base URI, ABN/ACN, and logo. 'status' lists every legal entity in the Register with its ACTIVE/REMOVED status — useful for spotting banks that have left CDR.",
                        "default": "holders"
                    },
                    "industry": {
                        "title": "Industry filter (holders mode)",
                        "enum": [
                            "all",
                            "banking",
                            "energy",
                            "non-bank-lending"
                        ],
                        "type": "string",
                        "description": "Optional. Restrict holders results to one CDR sector: 'banking', 'energy', or 'non-bank-lending'. Use 'all' (default) for every sector.",
                        "default": "all"
                    },
                    "name_contains": {
                        "title": "Brand-name substring filter (holders mode)",
                        "type": "string",
                        "description": "Optional. Case-insensitive substring match on the brand name, e.g. 'commbank' or 'AMP'. Useful when you want one bank's record."
                    },
                    "status": {
                        "title": "Status filter (holders mode)",
                        "enum": [
                            "",
                            "ACTIVE",
                            "REMOVED"
                        ],
                        "type": "string",
                        "description": "Optional. Filter brands by CDR participation status: 'ACTIVE' or 'REMOVED'. The current Register API doesn't expose brand-level status, so this filter is a placeholder — set it and we'll surface a status field per record when the Register API starts exposing it."
                    },
                    "limit": {
                        "title": "Brand record limit (holders mode)",
                        "minimum": 1,
                        "type": "integer",
                        "description": "Optional. Cap the number of brand records pushed to the dataset. Use when iterating the Register in pieces."
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
