ExternalIdentifierPatch
objectType of identifier document
Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEINEXTERNALOTHER
name of the identifier document
Example:ecn
Value of the identifier
Example:123456789
Additional description or notes about this identifier
Example:ecn number
Source system or organization that issued this identifier
Example:State of California
IdentifierPatch
objectType of identifier document
Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEINEXTERNALOTHER
Value of the identifier
Example:123456789
Additional description or notes about this identifier
Example:identifier description
Source system or organization that issued this identifier
Example:State of California
GovernmentIssuedIdentifier
Type of identifier document
Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEINEXTERNALOTHER
Value of the identifier
Example:123456789
Additional description or notes about this identifier
Example:Passport number
Source system or organization that issued this identifier
Example:State of California
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:2015-08-15
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:2025-08-15
Status of the identifier document
Allowed values:ACTIVEEXPIREDSUSPENDEDREVOKEDPENDING
Example:ACTIVE
GovernmentIssuedIdentifierPatch
Type of identifier document
Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEINEXTERNALOTHER
Value of the identifier
Example:123456789
Additional description or notes about this identifier
Example:identifier description
Source system or organization that issued this identifier
Example:State of California
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:2015-08-15
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:2025-08-15
Status of the identifier document
Allowed values:ACTIVEEXPIREDSUSPENDEDREVOKEDPENDING
Example:ACTIVE
PassportIdentifier
Type of identifier document
Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEINEXTERNALOTHER
Value of the identifier
Example:123456789
Additional description or notes about this identifier
Example:Passport number
Source system or organization that issued this identifier
Example:State of California
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:2015-08-15
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:2025-08-15
Status of the identifier document
Allowed values:ACTIVEEXPIREDSUSPENDEDREVOKEDPENDING
Example:ACTIVE
ISO Country Code https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX
Example:US