removedOutput schema / properties / data / properties
Removed value: -{
- "candidates": {
- "description": "Candidate carriers, highest confidence first, ties broken by carrier_id ascending. Confidence comes from a fixed score table - carrier-unique prefix plus length plus valid check digit 0.98, prefix plus length 0.85, UPU S10 with a valid check digit 0.90, length plus valid check digit 0.80, S10 structure with an invalid check digit 0.45, plus 0.02 when a country hint matches. It is a rule-based heuristic, NOT a calibrated probability. Read 0.80 (length plus check digit, no distinguishing prefix) with care - such a format has no carrier-unique marker, and any number of the right length passes a single decimal check digit about 1 time in 10 by chance (about 1 in 36 for the alphanumeric mod 37,36 check), so a wrong carrier can score 0.80. A carrier-unique prefix is what makes 0.85 and 0.98 distinctive.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "carrier_id": {
- "description": "Stable Eckari carrier identifier such as ups or usps.",
- "type": "string"
- },
- "carrier_name": {
- "description": "Human-readable carrier name.",
- "type": "string"
- },
- "confidence": {
- "description": "Deterministic signature MATCH SCORE from the fixed table (0-1, two decimals). It is not a probability and must not be read as one; identical to match_score and kept under this name for compatibility. Use match_strength to know whether the match is distinctive.",
- "maximum": 1,
- "minimum": 0,
- "type": "number"
- },
- "confidence_basis": {
- "description": "Always rule_based_uncalibrated - the score expresses how distinctive the matched format is, not an empirical probability.",
- "type": "string"
- },
- "format_id": {
- "description": "Identifier of the matched format within the signature set.",
- "type": "string"
- },
- "match_score": {
- "description": "Same value as confidence under its truthful name - a fixed-table match score.",
- "maximum": 1,
- "minimum": 0,
- "type": "number"
- },
- "match_strength": {
- "description": "distinctive = carrier-unique marker (prefix or UPU S10 operator) plus length plus a valid check digit; strong = carrier-unique marker plus length, check digit not verifiable; weak = length plus check digit only with no carrier-unique marker (a number of the right length passes a single decimal check digit about 1 in 10 by chance), or S10 structure with an invalid check digit. Treat weak matches as hints.",
- "enum": [
- "distinctive",
- "strong",
- "weak"
- ],
- "type": "string"
- },
- "reasons": {
- "description": "Why this candidate matched, for example prefix:1Z / length:18 / check_digit:ups_mod10 / upu_s10:GB / country_hint:CA.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "required": [
- "carrier_id",
- "carrier_name",
- "confidence",
- "confidence_basis",
- "match_score",
- "match_strength",
- "reasons",
- "format_id"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "formats_evaluated": {
- "description": "Number of distinct formats in the signature set whose pattern matched the normalised number, counted before check digits were applied. Zero with no candidates means no covered format matches this shape at all; a value above zero with no candidates means a covered format matched but its check digit did not validate - a typo or a partial capture rather than an unknown carrier.",
- "minimum": 0,
- "type": "integer"
- },
- "input": {
- "additionalProperties": false,
- "properties": {
- "normalised": {
- "description": "Upper-cased value with spaces and hyphens removed - the string the rules were evaluated against.",
- "type": "string"
- },
- "original": {
- "description": "Input as supplied, trimmed. Never altered otherwise.",
- "type": "string"
- }
- },
- "required": [
- "original",
- "normalised"
- ],
- "type": "object"
- },
- "is_upu_s10": {
- "description": "True when the number matches the UPU S10 postal item structure.",
- "type": "boolean"
- },
- "signature_version": {
- "description": "Version of the signature set that produced this result; results are reproducible for a given version.",
- "type": "string"
- },
- "top_candidate": {
- "description": "carrier_id of the best candidate, or null when the best score is below 0.5. Check top_candidate_distinctive before acting on it - a weak (length plus check digit) match can name a carrier by chance.",
- "type": [
- "string",
- "null"
- ]
- },
- "top_candidate_distinctive": {
- "description": "True only when top_candidate matched a carrier-unique marker (match_strength distinctive or strong). False when there is no top candidate or it is a weak length-plus-check match.",
- "type": "boolean"
- },
- "upu_s10": {
- "additionalProperties": false,
- "description": "Parsed UPU S10 components; null when the number is not S10.",
- "properties": {
- "check_digit_valid": {
- "description": "True when the S10 check digit validates against the serial.",
- "type": "boolean"
- },
- "origin_country": {
- "description": "ISO 3166-1 alpha-2 country code of the origin designated operator.",
- "type": "string"
- },
- "serial": {
- "description": "Eight-digit S10 serial number.",
- "type": "string"
- },
- "service_indicator": {
- "description": "Two-letter S10 service indicator such as RB.",
- "type": "string"
- },
- "service_type": {
- "description": "Service class implied by the first indicator letter, for example letter_post_registered; null when unrecognised.",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "required": [
- "service_indicator",
- "service_type",
- "serial",
- "check_digit_valid",
- "origin_country"
- ],
- "type": [
- "object",
- "null"
- ]
- }
-}