Validation & formatting

Inputs

• type choice · required · iban / bic / card / email / phone / postcode / … — What the value is.
• value string · required — The value to check (spaces and dashes are allowed where usual).
• country string — Postcode: the ISO country (US, GB, CA, AU, NZ, DE, FR, NL, IE, ES, IT, …). Phone: the default country (ISO code or calling code such as 64) for numbers without +.
• id_type choice · us_ssn / uk_nino / ca_sin / au_tfn / nz_ird / nz_nhi / … — For national_id: which scheme.

Outputs

• valid boolean
• normalized string — The value in its standard form (IBAN without spaces, E.164 phone, upper-case postcode with standard spacing, digits-only card number, …).
• reason string — Why the value is invalid (empty when valid).
• details object — Type-specific facts: iban country, bban and formatted; bic bank_code, country, branch; card issuer, last4, masked; email local, domain; phone country_code, national_number, international; national_id formatted.

Inputs

• items list of objects · required — List of { "type": "email", "value": "…", "name"?: "label", "country"?: "NZ", "id_type"?: "nz_ird" }.each: type (string), value (string), name (string), country (string), id_type (string)
• country string — Used for phone and postcode entries without their own country.

Outputs

• results list of objects — One per item, in order.each: name (string), type (string), value (string), valid (boolean), normalized (string), reason (string)
• all_valid boolean
• valid_count integer
• invalid_count integer

Inputs

• value number · required — The number. For percent, 0.25 is 25%.
• locale string — BCP 47 locale, e.g. en-US, en-NZ, de-DE, fr-FR, ja-JP.
• style choice · decimal / percent / currency — Plain number, percent or currency.
• currency string — For the currency style: ISO 4217 code (USD, EUR, NZD, JPY, …).
• minimum_fraction_digits integer — Optional: at least this many decimal places.
• maximum_fraction_digits integer — Optional: at most this many decimal places (rounded).
• use_grouping boolean — Group digits (1,234,567).
• notation choice · standard / compact / scientific / engineering — Standard, compact (1.2M), scientific or engineering.

Outputs

• formatted string

Inputs

• value number · required — The amount.
• currency string · required — ISO 4217 code (USD, EUR, GBP, NZD, AUD, JPY, …).
• locale string — BCP 47 locale, e.g. en-US, en-NZ, de-DE, fr-FR, ja-JP.
• display choice · symbol / narrowSymbol / code / name — Symbol ($), narrow symbol, ISO code (NZD) or name (New Zealand dollars).
• accounting boolean — Show negative amounts in brackets, e.g. ($1,234.50).
• minimum_fraction_digits integer — Optional: at least this many decimal places.
• maximum_fraction_digits integer — Optional: at most this many decimal places (rounded).

Outputs

• formatted string
• currency string

Inputs

• text string · required — The number as text.
• locale string — BCP 47 locale, e.g. en-US, en-NZ, de-DE, fr-FR, ja-JP.

Outputs

• value number — The number (empty when the text is not a number).
• valid boolean — Whether the text could be read as a number.
• decimal_separator string — The locale's decimal separator.
• group_separator string — The locale's thousands separator.

Inputs

• value string · required — As typed: with + and country code, or national with Country set.
• country string — ISO country (NZ, US, GB, …) or calling code (64) for numbers without +.
• format choice · e164 / international / national — Output style.

Outputs

• formatted string — Empty when the number is not valid.
• e164 string
• valid boolean
• reason string — Why the number is invalid (empty when valid).