@comms-id/apra-registered-financial-corporation-lookup

中文文档
0.1.0发布于 2026/10/22SEE LICENSE IN LICENSETypeScriptES Module零依赖

Typed client for the Comms.ID APRA list of registered financial corporations API: look up an ABN, search by name

此软件包已被标记为弃用

Removed. Comms.ID products are served live, nothing to install: https://cdn.comms.id/apra-registered-financial-corporation-lookup/latest.js

原始使用文档
文档目录3 节
  1. Operations
  2. Test it first
  3. What the field does

@comms-id/apra-registered-financial-corporation-lookup

Typed client for the Comms.ID APRA list of registered financial corporations API (https://api.comms.id/apra-registered-financial-corporation-lookup/v1): look up an ABN on APRA's published list, or search it by the start of a name (#715).

src/ is generated from the contract (packages/apra-registered-financial-corporation-lookup-service/openapi/apra-registered-financial-corporation-lookup.v1.json) by @comms-id/forge-transformers. Do not edit it: change the contract and run pnpm --filter @comms-id/forge-transformers generate. src/local/profile.ts is the only hand-written part.

import { createApraRegisteredFinancialCorporationLookupClient } from "@comms-id/apra-registered-financial-corporation-lookup/server";

const client = createApraRegisteredFinancialCorporationLookupClient({
  clientId: process.env.COMMS_ID_CLIENT_ID!,
  privateJwk: JSON.parse(process.env.COMMS_ID_PRIVATE_JWK!),
});
const reply = await client.lookup({ abn: "45114248458" });

COMMS_ID_PRIVATE_JWK is an ML-DSA-87 private JWK (kty AKP, with priv and pub). The server entry needs Node.js 24.7 or later, or a Cloudflare Worker with the compatibility flag webcrypto_modern_algorithms.

Operations

  • lookup: one ABN. outcome is match with the fact, or no-match, which means only that the ABN is not on APRA's published page.
  • search: the start of a name, case, accents and punctuation ignored; ten records by default, at most fifty, with truncated when there are more.

Every fact carries source, observedAt, sourceDate (the page's own "Updated" date) and attribution, and every reply carries the page's note that it is not the list for s11(4) of the Financial Sector (Collection of Data) Act 2001.

Test it first

createApraRegisteredFinancialCorporationLookupFixtureClient() from @comms-id/apra-registered-financial-corporation-lookup/fixtures answers from the contract's own examples with no network. To call the TEST service, pass environment: "test".

What the field does

  • A name: after the user pauses, it suggests corporations (name, ABN, category or exempted) from APRA's published list of registered financial corporations. The search already returns each whole record, so choosing one needs no second call. Rows that APRA publishes without an ABN are found this way only.
  • An ABN: eleven digits (spaces allowed) are checked in the browser and looked up at once. A wrong length or checksum is refused and nothing is sent.
  • An exempted corporation is shown as "Exempted from registration", never as registered (FSCODA s7(2)(j)).
  • "Not on APRA's published list of registered financial corporations." and "Financial corporation lookup is unavailable" are different messages. Not on the page is not proof that a corporation is unregistered: APRA's legal list is the one it publishes in the Gazette (s11(4)).

版本与发布记录

@comms-id/apra-registered-financial-corporation-lookup 共发布 2 个版本,首次发布于 2026/10/22;过去 12 个月发布了 2 个版本。

版本发布日期距今
0.1.0latest2026/10/2212 天前
0.0.0-stage2026/10/2212 天前

关于 @comms-id/apra-registered-financial-corporation-lookup 的常见问题

@comms-id/apra-registered-financial-corporation-lookup 是什么?

为通信键入的客户端。ID APRA注册金融公司API列表:查找ABN,按名称搜索注意:该包已被作者标记为弃用——Removed. Comms.ID products are served live, nothing to install: https://cdn.comms.id/apra-registered-financial-corporation-lookup/latest.js

如何安装 @comms-id/apra-registered-financial-corporation-lookup?

在项目目录运行 npm install @comms-id/apra-registered-financial-corporation-lookup,或使用 pnpm add / yarn add / bun add。

@comms-id/apra-registered-financial-corporation-lookup 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@comms-id/apra-registered-financial-corporation-lookup 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@comms-id/apra-registered-financial-corporation-lookup 可以商用吗?

@comms-id/apra-registered-financial-corporation-lookup 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中,请阅读该文件确认可否商用。以上为概括,不构成法律意见,请以许可原文为准。

@comms-id/apra-registered-financial-corporation-lookup 还在维护吗?

最新版本 0.1.0 发布于 2026/10/22(12 天前);至今共发布 2 个版本,其中过去 12 个月发布了 2 个;首次发布于 2026/10/22。作者已将其标记为弃用,新项目建议寻找替代方案。