PersonalInformationOtherInterestedParty
objectExample:John
Example:M
Example:Doe
Suffix for given party if Applicable
Allowed values:JRSRIIIIIIIVVVIVII
Example:SR
Prefix for given party if Applicable
Allowed values:MRMSMISSDR.MRS.
Example:MR
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:1990-01-01
Allowed values:MALEFEMALEUNISEXOTHER
Example:MALE
Allowed values:MALEFEMALEUNISEX
Example:MALE
Only applicable for US born party
Allowed values:ALAKAZARCACOCTDCDEFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWYANXK
Example:CA
ISO Country Code https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX
Example:US
ISO Country Code https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX
Example:US
PersonalInformationOtherInterestedPartyPatch
objectExample:John
Example:M
Example:Doe
Suffix for given party if Applicable
Allowed values:JRSRIIIIIIIVVVIVII
Example:SR
Prefix for given party if Applicable
Allowed values:MRMSMISSDR.MRS.
Example:MR
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:1990-01-01
Allowed values:MALEFEMALEUNISEXOTHER
Example:MALE
Allowed values:MALEFEMALEUNISEX
Example:MALE
Only applicable for US born party
Allowed values:ALAKAZARCACOCTDCDEFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWYANXK
Example:CA
ISO Country Code https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX
Example:US
ISO Country Code https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX
Example:US
PersonalInformationOtherInterestedPartyResponse
objectExample:John
Example:M
Example:Doe
Suffix for given party if Applicable
Allowed values:JRSRIIIIIIIVVVIVII
Example:SR
Prefix for given party if Applicable
Allowed values:MRMSMISSDR.MRS.
Example:MR
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:1990-01-01
Allowed values:MALEFEMALEUNISEX
Example:MALE
Only applicable for US born party
Allowed values:ALAKAZARCACOCTDCDEFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWYANXK
Example:CA
ISO Country Code https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX
Example:US
ISO Country Code https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX
Example:US
Address
objectUnique identifier for the address
Example:123e4567-e89b-12d3-a456-426614174000
Type of address
Allowed values:RESIDENCEBUSINESSPOBOXSEASONALSECONDARYMAILING
Example:RESIDENCE
Primary address line
Example:123 Main St
Secondary address line (optional)
Example:Apt 4B
Secondary address line (optional)
Example:suite 123
City name
Example:San Francisco
Abbreviated names for states
Allowed values:ALAKAZARASAAAEAPCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTMPNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUTUMVTVAVIWAWVWIWY
Example:CA
ZIP code (5 digits)
Match pattern:^\d{5}?$
Example:94105
ZIP code extension
Example:4465
Country Code
Allowed values:US
AddressPatch
objectUnique identifier for the address
Example:123e4567-e89b-12d3-a456-426614174000
Type of address
Allowed values:RESIDENCEBUSINESSPOBOXSEASONALSECONDARYMAILING
Example:RESIDENCE
Primary address line
Example:123 Main St
Secondary address line (optional)
Example:Apt 4B
Secondary address line (optional)
Example:suite 123
City name
Example:San Francisco
Abbreviated names for states
Allowed values:ALAKAZARASAAAEAPCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTMPNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUTUMVTVAVIWAWVWIWY
Example:CA
ZIP code (5 digits)
Match pattern:^\d{5}?$
Example:94105
ZIP code extension
Example:4465
Country Code
Allowed values:US