nationid - v2.2.1
    Preparing search index...

    Function listDocumentsByPurpose

    • List every registered document of purpose, across all countries, in locale.

      Useful for global filters such as "show me every tax ID we support".

      Parameters

      • purpose: DocumentPurpose

        Filter, e.g. "tax", "personal".

      • locale: Locale = DEFAULT_LOCALE

        Display locale (default "en").

      Returns readonly DocumentInfo[]

      Read-only array of DocumentInfo matching purpose.

      import { listDocumentsByPurpose } from "nationid/catalog";

      const taxIds = listDocumentsByPurpose("tax", "en");
      // [{ code: "BR_CNPJ", … }, { code: "MX_RFC_PM", … }, …]