Class KENALL

constructor

• new KENALL(apikey: string, config?: Config): KENALL

  The constructor.

  Parameters

  • apikey: string

    The key string that you want to call the API with. The key is shown in the dashboard you will be navigated to right after signing in to the service.

  • config: Config = {}

    Specifies the configuration given by Config.

  Returns KENALL

Readonlyapibase

Readonlyapikey

Readonlytimeout

checkBusinessDay

• checkBusinessDay(date: string): Promise<v20250101.BusinessDayCheckResponse>

  Invokes "checkBusinessDay" API (endpoint: /businessdays/check).

  This API is not versioned.

  Parameters

  • date: string

    The date to check, in the form of "YYYY-MM-DD".

  Returns Promise<v20250101.BusinessDayCheckResponse>

  A BusinessDayCheckResponse.

getAddress

• getAddress<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | "2026-08-01"
          | undefined = undefined,
  >(
      postalCode: string,
      version?: string,
      apiVersion?: T,
  ): Promise<AddressResolverResponseForVersion<T>>

  Invokes "getAddress" API (endpoint: /postalcode/{postalcode}).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined

  Parameters

  • postalCode: string

    The postal code to query with.

  • Optionalversion: string

    The version of the database that the query has to be performed against. Will default to the latest available version if not specified.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<AddressResolverResponseForVersion<T>>

  An AddressResolverResponse.

getBank

• getBank<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | "2026-08-01"
          | undefined = undefined,
  >(
      bankCode: string,
      apiVersion?: T,
  ): Promise<BankResolverResponseForVersion<T>>

  Invokes "getBank" API (endpoint: /bank/{bankCode}).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined

  Parameters

  • bankCode: string

    The bank code to query with.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<BankResolverResponseForVersion<T>>

  A BankResolverResponse.

getBankBranch

• getBankBranch<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | "2026-08-01"
          | undefined = undefined,
  >(
      bankCode: string,
      branchCode: string,
      apiVersion?: T,
  ): Promise<BankBranchResolverResponseForVersion<T>>

  Invokes "getBankBranch" API (endpoint: /bank/{bankCode}/branches/{branchCode}).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined

  Parameters

  • bankCode: string

    The bank code to query with.

  • branchCode: string

    The branch code to query with.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<BankBranchResolverResponseForVersion<T>>

  A BankBranchResolverResponse.

getBankBranches

• getBankBranches<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | "2026-08-01"
          | undefined = undefined,
  >(
      bankCode: string,
      apiVersion?: T,
  ): Promise<BankBranchesResponseForVersion<T>>

  Invokes "getBankBranch" API (endpoint: /bank/{bankCode}/branches).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined

  Parameters

  • bankCode: string

    The bank code to query with.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<BankBranchesResponseForVersion<T>>

  A BankBranchesResponse.

getBanks

• getBanks<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | "2026-08-01"
          | undefined = undefined,
  >(
      apiVersion?: T,
  ): Promise<BanksResponseForVersion<T>>

  Invokes "getBanks" API (endpoint: /bank).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined

  Parameters

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<BanksResponseForVersion<T>>

  A BanksResponse.

getCities

• getCities<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | "2026-08-01"
          | undefined = undefined,
  >(
      prefectureCode: string,
      version?: string,
      apiVersion?: T,
  ): Promise<CityResolverResponseForVersion<T>>

  Invokes "getCities" API (endpoint: /cities/{prefectureCode}).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined

  Parameters

  • prefectureCode: string

    The prefecture code to query with.

  • Optionalversion: string

    The version of the database that the query has to be performed against. Will default to the latest available version if not specified.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<CityResolverResponseForVersion<T>>

  A CityResolverResponse.

getHolidays

• getHolidays(
      options?: v20250101.HolidaysOptions,
  ): Promise<v20250101.HolidaysResponse>

  Invokes "getHolidays" API (endpoint: /holidays).

  This API is not versioned.

  Parameters

  • options: v20250101.HolidaysOptions = {}

    The query. When year is given, from and to are ignored and the whole year is returned.

  Returns Promise<v20250101.HolidaysResponse>

  A HolidaysResponse.

getNTACorporateInfo

• getNTACorporateInfo<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | "2026-08-01"
          | undefined = undefined,
  >(
      corporateNumber: string,
      apiVersion?: T,
  ): Promise<NTACorporateInfoResolverResponseForVersion<T>>

  Invokes "getNTACorporateInfo" API (endpoint: /houjinbangou/{corporateNumber}).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined

  Parameters

  • corporateNumber: string

    The corporate number to query with.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<NTACorporateInfoResolverResponseForVersion<T>>

  An NTACorporateInfoResolverResponse.

getNTAQualifiedInvoiceIssuerInfo

• getNTAQualifiedInvoiceIssuerInfo<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | "2026-08-01"
          | undefined = undefined,
  >(
      issuerNumber: string,
      apiVersion?: T,
  ): Promise<NTAQualifiedInvoiceIssuerInfoResolverResponseForVersion<T>>

  Invokes "getNTAQualifiedInvoiceIssuerInfo" API (endpoint: /invoice/{issuerNumber}).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined

  Parameters

  • issuerNumber: string

    The qualified invoice issuer number to query with.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<NTAQualifiedInvoiceIssuerInfoResolverResponseForVersion<T>>

  An NTAQualifiedInvoiceIssuerInfoResolverResponse.

getSchool

• getSchool(schoolCode: string): Promise<v20250101.SchoolResolverResponse>

  Invokes "getSchool" API (endpoint: /school/{schoolCode}).

  This API is not versioned.

  Parameters

  • schoolCode: string

    The 13 digit school code to query with.

  Returns Promise<v20250101.SchoolResolverResponse>

  A SchoolResolverResponse.

searchAddresses

• searchAddresses<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | "2026-08-01"
          | undefined = undefined,
  >(
      options: v20221101.AddressSearcherOptions,
      apiVersion?: T,
  ): Promise<AddressSearcherResponseForVersion<T>>

  Invokes "searchAddresses" API (endpoint: /postalcode/?...).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined

  Parameters

  • options: v20221101.AddressSearcherOptions

    The query.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<AddressSearcherResponseForVersion<T>>

  An AddressSearcherResponse.

searchBankBranches

• searchBankBranches<T extends "2026-08-01" | undefined = undefined>(
      bankCode: string,
      options?: v20260801.BankBranchSearcherOptions,
      apiVersion?: T,
  ): Promise<BankBranchesResponseForVersion<T>>

  Invokes "getBankBranches" API with a set of search parameters (endpoint: /bank/{bankCode}/branches?...).

  Unlike getBankBranches, an empty result is not an error here: as long as q is given and the bank itself exists, the API responds with a 200 and an empty branches instead of a 404.

  The search parameters were introduced in the 2026-08-01 API version; earlier versions ignore them and return every branch, which is why apiVersion cannot be an older one.

  Type Parameters

  • T extends "2026-08-01" | undefined = undefined

  Parameters

  • bankCode: string

    The bank code to query with.

  • options: v20260801.BankBranchSearcherOptions = {}

    The query.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<BankBranchesResponseForVersion<T>>

  A BankBranchesResponse.

searchBanks

• searchBanks<T extends "2026-08-01" | undefined = undefined>(
      options?: v20260801.BankSearcherOptions,
      apiVersion?: T,
  ): Promise<BanksResponseForVersion<T>>

  Invokes "getBanks" API with a set of search parameters (endpoint: /bank?...).

  Unlike getBanks, an empty result is not an error here: as long as q or type is given, the API responds with a 200 and an empty data instead of a 404.

  The search parameters were introduced in the 2026-08-01 API version; earlier versions ignore them and return the whole set, which is why apiVersion cannot be an older one.

  Type Parameters

  • T extends "2026-08-01" | undefined = undefined

  Parameters

  • options: v20260801.BankSearcherOptions = {}

    The query.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<BanksResponseForVersion<T>>

  A BanksResponse.

searchNTACorporateInfo

• searchNTACorporateInfo<
      T extends
          | "2022-09-01"
          | "2022-11-01"
          | "2023-09-01"
          | "2024-01-01"
          | "2025-01-01"
          | "2026-08-01"
          | undefined = undefined,
  >(
      options: v20221101.NTACorporateInfoSearcherOptions,
      apiVersion?: T,
  ): Promise<NTACorporateInfoSearcherResponseForVersion<T>>

  Invokes "searchNTACorporateInfo" API (endpoint: /houjinbangou?...).

  Type Parameters

  • T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined

  Parameters

  • options: v20221101.NTACorporateInfoSearcherOptions

    The query.

  • OptionalapiVersion: T

    The API version. The return type is determined based on this argument, and thus it cannot be a variable.

  Returns Promise<NTACorporateInfoSearcherResponseForVersion<T>>

  An NTACorporateInfoSearcherResponse.

searchSchool

• searchSchool(
      options: v20250101.SchoolSearcherOptions,
  ): Promise<v20250101.SchoolSearcherResponse>

  Invokes "searchSchool" API (endpoint: /school/?...).

  This API is not versioned.

  Parameters

  • options: v20250101.SchoolSearcherOptions

    The query.

  Returns Promise<v20250101.SchoolSearcherResponse>

  A SchoolSearcherResponse.

whoami

• whoami(): Promise<v20250101.WhoamiResponse>

  Invokes "whoami" API (endpoint: /whoami).

  This API is not versioned.

  Returns Promise<v20250101.WhoamiResponse>

  A WhoamiResponse that contains the IP address the request was made from.