Skip to main content

ValidationResult

validboolean

Whether the address format is valid

Example: true
addressstring

The address that was validated (uppercased)

Example: AK-484-9321
formatstring

Detected format: 'formatted' (AK-484-9321) or 'compact' (AK4849321)

Possible values: [formatted, compact]

Example: formatted
errorstring

Validation error message (only present if invalid)

ValidationResult
{
  "valid": true,
  "address": "AK-484-9321",
  "format": "formatted",
  "error": "string"
}