OptionalFields

OptionalFields class

Optional elements (fields) of the card

new OptionalFields()

Methods

NameDescription
getAliasAKAFamilyName()DBN, Other family name by which cardholder is known, DL/ID, V10ANS
getAliasAKAGivenName()DBG, Other given name by which cardholder is known, DL/ID, V15ANS
getAliasAKASuffixName()DBS, Other suffix by which cardholder is known, DL/ID, V5ANS
getAuditInformation()DCJ, A string of letters and/or numbers that identifies when, where, and by whom a driver license/ID card was made. If a
getCardRevisionDate()DDB, DHS required field that indicates date of the most recent version change or modification to the visible format of t
getComplianceType()DDA, DHS required field that indicates compliance: “F” = compliant; and, “N” = non-compliant, DL/ID, F1A
getEndorsementCodeDescription()DCQ, Text that explains the jurisdiction-specific code(s) that indicates additional driving privileges granted to the ca
getHairColor()DAZ, Bald, black, blonde, brown, gray, red/auburn, sandy, white, unknown. If the issuing jurisdiction wishes to abbrevia
getHAZMATEndorsementExpDate()DDC, Date on which the hazardous material endorsement granted by the document is no longer valid. (MMDDCCYY for U.S., CC
getInventoryControlNumber()DCK, A string of letters and/or numbers that is affixed to the raw materials(card stock, laminate, etc.) used in produci
getLimitedDurationDocIndicator()DDD, DHS required field that indicates that the cardholder has temporary lawful status = “1”, DL/ID, F1N
getNameSuffix()DCU, Name Suffix (If jurisdiction participates in systems requiring name suffix (PDPS, CDLIS, etc.), the suffix must be
getOrganDonorIndicator()DDK, Field that indicates that the cardholder is an organ donor = “1”, DL/ID, F1N
getPlaceOfBirth()DCI, Country and municipality and/or state/province, DL/ID, V33A
getRaceEthnicity()DCL, Codes for race or ethnicity of the cardholder, as defined in AAMVA D20, DL/ID, V3A
getRestrictionCodeDescription()DCR, Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges, DL, V50ANS
getStandardEndorsementCode()DCN, Standard endorsement code(s) for cardholder. See codes in D20.This data element is a placeholder for future efforts
getStandardRestrictionCode()DCO, Standard restriction code(s) for cardholder. See codes in D20.This data element is a placeholder for future efforts
getStandardVehClassification()DCM, Standard vehicle classification code(s) for cardholder. This data element is a placeholder for future efforts to st
getUnder18Until()DDH, Date on which the cardholder turns 18 years old. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N
getUnder21Until()DDJ, Date on which the cardholder turns 21 years old. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N
getVehClassDescription()DCP, Text that explains the jurisdiction-specific code(s) for classifications of vehicles cardholder is authorized to dr
getVeteranIndicator()DDL, Field that indicates that the cardholder is a veteran = “1”, DL/ID, F1N
getWeightKilograms()DAX, Cardholder weight in kilograms, Ex. 84 kg = “084”, DL/ID, F3N
getWeightPounds()DAW, Cardholder weight in pounds, Ex. 185 lb = “185”, DL/ID, F3N
getWeightRange()DCE, Indicates the approximate weight range of the cardholder: 0 = up to 31 kg(up to 70 lbs), 1 = 32 – 45 kg(71 – 100 lb
setAddressStreet2()DAH, Second line of street portion of the cardholder address, DL/ID, V35ANS
setAliasAKAFamilyName()DBN, Other family name by which cardholder is known, DL/ID, V10ANS
setAliasAKAGivenName()DBG, Other given name by which cardholder is known, DL/ID, V15ANS
setAliasAKASuffixName()DBS, Other suffix by which cardholder is known, DL/ID, V5ANS
setAuditInformation()DCJ, A string of letters and/or numbers that identifies when, where, and by whom a driver license/ID card was made. If a
setCardRevisionDate()DDB, DHS required field that indicates date of the most recent version change or modification to the visible format of t
setComplianceType()DDA, DHS required field that indicates compliance: “F” = compliant; and, “N” = non-compliant, DL/ID, F1A
setEndorsementCodeDescription()DCQ, Text that explains the jurisdiction-specific code(s) that indicates additional driving privileges granted to the ca
setHairColor()DAZ, Bald, black, blonde, brown, gray, red/auburn, sandy, white, unknown. If the issuing jurisdiction wishes to abbrevia
setInventoryControlNumber()DCK, A string of letters and/or numbers that is affixed to the raw materials(card stock, laminate, etc.) used in produci
setLimitedDurationDocIndicator()DDD, DHS required field that indicates that the cardholder has temporary lawful status = “1”, DL/ID, F1N
setNameSuffix()DCU, Name Suffix (If jurisdiction participates in systems requiring name suffix (PDPS, CDLIS, etc.), the suffix must be
setOrganDonorIndicator()DDK, Field that indicates that the cardholder is an organ donor = “1”, DL/ID, F1N
setPlaceOfBirth()DCI, Country and municipality and/or state/province, DL/ID, V33A
setRaceEthnicity()DCL, Codes for race or ethnicity of the cardholder, as defined in AAMVA D20, DL/ID, V3A
setRestrictionCodeDescription()DCR, Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges, DL, V50ANS
setStandardEndorsementCode()DCN, Standard endorsement code(s) for cardholder. See codes in D20.This data element is a placeholder for future efforts
setStandardRestrictionCode()DCO, Standard restriction code(s) for cardholder. See codes in D20.This data element is a placeholder for future efforts
setStandardVehClassification()DCM, Standard vehicle classification code(s) for cardholder. This data element is a placeholder for future efforts to st
setUnder18Until()DDI, Date on which the cardholder turns 19 years old. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N
setUnder19Until()DDI, Date on which the cardholder turns 19 years old. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N
setUnder21Until()DDJ, Date on which the cardholder turns 21 years old. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N
setVehClassDescription()DCP, Text that explains the jurisdiction-specific code(s) for classifications of vehicles cardholder is authorized to dr
setVeteranIndicator()DDL, Field that indicates that the cardholder is a veteran = “1”, DL/ID, F1N
setWeightKilograms()DAX, Cardholder weight in kilograms, Ex. 84 kg = “084”, DL/ID, F3N
setWeightPounds()DAW, Cardholder weight in pounds, Ex. 185 lb = “185”, DL/ID, F3N
setWeightRange()DCE, Indicates the approximate weight range of the cardholder: 0 = up to 31 kg(up to 70 lbs), 1 = 32 – 45 kg(71 – 100 lb

getAliasAKAFamilyName()

DBN, Other family name by which cardholder is known, DL/ID, V10ANS

getAliasAKAGivenName()

DBG, Other given name by which cardholder is known, DL/ID, V15ANS

getAliasAKASuffixName()

DBS, Other suffix by which cardholder is known, DL/ID, V5ANS

getAuditInformation()

DCJ, A string of letters and/or numbers that identifies when, where, and by whom a driver license/ID card was made. If audit information is not used on the card or the MRT, it must be included in the driver record, DL/ID, V25ANS

getCardRevisionDate()

DDB, DHS required field that indicates date of the most recent version change or modification to the visible format of the DL/ID. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N

getComplianceType()

DDA, DHS required field that indicates compliance: “F” = compliant; and, “N” = non-compliant, DL/ID, F1A

getEndorsementCodeDescription()

DCQ, Text that explains the jurisdiction-specific code(s) that indicates additional driving privileges granted to the cardholder beyond the vehicle class, DL, V50ANS

getHairColor()

DAZ, Bald, black, blonde, brown, gray, red/auburn, sandy, white, unknown. If the issuing jurisdiction wishes to abbreviate colors, the three-character codes provided in AAMVA D20 must be used, DL/ID, V12A

getHAZMATEndorsementExpDate()

DDC, Date on which the hazardous material endorsement granted by the document is no longer valid. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL, F8N

getInventoryControlNumber()

DCK, A string of letters and/or numbers that is affixed to the raw materials(card stock, laminate, etc.) used in producing driver licenses and ID cards. (DHS recommended field), DL/ID, V25ANS

getLimitedDurationDocIndicator()

DDD, DHS required field that indicates that the cardholder has temporary lawful status = “1”, DL/ID, F1N

getNameSuffix()

DCU, Name Suffix (If jurisdiction participates in systems requiring name suffix (PDPS, CDLIS, etc.), the suffix must be collected and displayed on the DL/ID and in the MRT). JR(Junior), SR(Senior), 1ST or I(First), up to 9TH or IX (Ninth), DL/ID, V5ANS

getOrganDonorIndicator()

DDK, Field that indicates that the cardholder is an organ donor = “1”, DL/ID, F1N

getPlaceOfBirth()

DCI, Country and municipality and/or state/province, DL/ID, V33A

getRaceEthnicity()

DCL, Codes for race or ethnicity of the cardholder, as defined in AAMVA D20, DL/ID, V3A

getRestrictionCodeDescription()

DCR, Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges, DL, V50ANS

getStandardEndorsementCode()

DCN, Standard endorsement code(s) for cardholder. See codes in D20.This data element is a placeholder for future efforts to standardize endorsement codes, DL, F5AN

getStandardRestrictionCode()

DCO, Standard restriction code(s) for cardholder. See codes in D20.This data element is a placeholder for future efforts to standardize restriction codes, DL, F12AN

getStandardVehClassification()

DCM, Standard vehicle classification code(s) for cardholder. This data element is a placeholder for future efforts to standardize vehicle classifications, DL, F4AN

getUnder18Until()

DDH, Date on which the cardholder turns 18 years old. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N

getUnder21Until()

DDJ, Date on which the cardholder turns 21 years old. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N

getVehClassDescription()

DCP, Text that explains the jurisdiction-specific code(s) for classifications of vehicles cardholder is authorized to drive, DL, V50ANS

getVeteranIndicator()

DDL, Field that indicates that the cardholder is a veteran = “1”, DL/ID, F1N

getWeightKilograms()

DAX, Cardholder weight in kilograms, Ex. 84 kg = “084”, DL/ID, F3N

getWeightPounds()

DAW, Cardholder weight in pounds, Ex. 185 lb = “185”, DL/ID, F3N

getWeightRange()

DCE, Indicates the approximate weight range of the cardholder: 0 = up to 31 kg(up to 70 lbs), 1 = 32 – 45 kg(71 – 100 lbs), 2 = 46 - 59 kg(101 – 130 lbs), 3 = 60 - 70 kg(131 – 160 lbs), 4 = 71 - 86 kg(161 – 190 lbs), 5 = 87 - 100 kg(191 – 220 lbs), 6 = 101 - 113 kg(221 – 250 lbs), 7 = 114 - 127 kg(251 – 280 lbs), 8 = 128 – 145 kg(281 – 320 lbs), 9 = 146+ kg(321+ lbs), DL/ID, F1N

setAddressStreet2()

DAH, Second line of street portion of the cardholder address, DL/ID, V35ANS

setAliasAKAFamilyName()

DBN, Other family name by which cardholder is known, DL/ID, V10ANS

setAliasAKAGivenName()

DBG, Other given name by which cardholder is known, DL/ID, V15ANS

setAliasAKASuffixName()

DBS, Other suffix by which cardholder is known, DL/ID, V5ANS

setAuditInformation()

DCJ, A string of letters and/or numbers that identifies when, where, and by whom a driver license/ID card was made. If audit information is not used on the card or the MRT, it must be included in the driver record, DL/ID, V25ANS

setCardRevisionDate()

DDB, DHS required field that indicates date of the most recent version change or modification to the visible format of the DL/ID. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N

setComplianceType()

DDA, DHS required field that indicates compliance: “F” = compliant; and, “N” = non-compliant, DL/ID, F1A

setEndorsementCodeDescription()

DCQ, Text that explains the jurisdiction-specific code(s) that indicates additional driving privileges granted to the cardholder beyond the vehicle class, DL, V50ANS

setHairColor()

DAZ, Bald, black, blonde, brown, gray, red/auburn, sandy, white, unknown. If the issuing jurisdiction wishes to abbreviate colors, the three-character codes provided in AAMVA D20 must be used, DL/ID, V12A

setInventoryControlNumber()

DCK, A string of letters and/or numbers that is affixed to the raw materials(card stock, laminate, etc.) used in producing driver licenses and ID cards. (DHS recommended field), DL/ID, V25ANS

setLimitedDurationDocIndicator()

DDD, DHS required field that indicates that the cardholder has temporary lawful status = “1”, DL/ID, F1N

setNameSuffix()

DCU, Name Suffix (If jurisdiction participates in systems requiring name suffix (PDPS, CDLIS, etc.), the suffix must be collected and displayed on the DL/ID and in the MRT). JR(Junior), SR(Senior), 1ST or I(First), up to 9TH or IX (Ninth), DL/ID, V5ANS

setOrganDonorIndicator()

DDK, Field that indicates that the cardholder is an organ donor = “1”, DL/ID, F1N

setPlaceOfBirth()

DCI, Country and municipality and/or state/province, DL/ID, V33A

setRaceEthnicity()

DCL, Codes for race or ethnicity of the cardholder, as defined in AAMVA D20, DL/ID, V3A

setRestrictionCodeDescription()

DCR, Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges, DL, V50ANS

setStandardEndorsementCode()

DCN, Standard endorsement code(s) for cardholder. See codes in D20.This data element is a placeholder for future efforts to standardize endorsement codes, DL, F5AN

setStandardRestrictionCode()

DCO, Standard restriction code(s) for cardholder. See codes in D20.This data element is a placeholder for future efforts to standardize restriction codes, DL, F12AN

setStandardVehClassification()

DCM, Standard vehicle classification code(s) for cardholder. This data element is a placeholder for future efforts to standardize vehicle classifications, DL, F4AN

setUnder18Until()

DDI, Date on which the cardholder turns 19 years old. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N

setUnder19Until()

DDI, Date on which the cardholder turns 19 years old. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N

setUnder21Until()

DDJ, Date on which the cardholder turns 21 years old. (MMDDCCYY for U.S., CCYYMMDD for Canada), DL/ID, F8N

setVehClassDescription()

DCP, Text that explains the jurisdiction-specific code(s) for classifications of vehicles cardholder is authorized to drive, DL, V50ANS

setVeteranIndicator()

DDL, Field that indicates that the cardholder is a veteran = “1”, DL/ID, F1N

setWeightKilograms()

DAX, Cardholder weight in kilograms, Ex. 84 kg = “084”, DL/ID, F3N

setWeightPounds()

DAW, Cardholder weight in pounds, Ex. 185 lb = “185”, DL/ID, F3N

setWeightRange()

DCE, Indicates the approximate weight range of the cardholder: 0 = up to 31 kg(up to 70 lbs), 1 = 32 – 45 kg(71 – 100 lbs), 2 = 46 - 59 kg(101 – 130 lbs), 3 = 60 - 70 kg(131 – 160 lbs), 4 = 71 - 86 kg(161 – 190 lbs), 5 = 87 - 100 kg(191 – 220 lbs), 6 = 101 - 113 kg(221 – 250 lbs), 7 = 114 - 127 kg(251 – 280 lbs), 8 = 128 – 145 kg(281 – 320 lbs), 9 = 146+ kg(321+ lbs), DL/ID, F1N