After parsing or validation, individual address fields are available for collection as part of a "suggestion". Suggestion 0 always holds the parsed fields. Suggestions numbered 1 and above hold the validated address fields.

Individual fields are retrieved one by one using

ssan3_addr_get_field_idx

by nominating the suggestion index and field index. As some fields may be missing, only those fields that have a non-zero length (as determined by calling

ssan3_addr_parse

or

ssan3_addr_get_field_info

) should be retrieved.

After validation, a field may be retrieved with

ssan3_addr_get_field

. This API is similar to

ssan3_addr_get_field_idx

but returns two extra codes that describe how the particular field matched the validation data (

val_status

) and whether or not it was changed by the validation process (

val_mods

). Refer below table for

val_status

and

val_mods

for ASM using AddressDoctor v4:

Refer below table for

val_status

and

val_mods

for ASM using AddressDoctor v5:

val_status	Meaning
0	Empty
1	Not found
2	Not checked (no reference data)
3	Wrong - Set by validation only
4	Match with errors in this element
5	Match with changes
6	Match without errors