Get My Citizen Contacts

Gets the contacts for the currently logged in citizen user.

Resource Information

Scopeusers

Deprecated scope name:   get_citizenaccess_user_contacts

App TypeCitizen
Authorization TypeAccess token
URI /v4/citizenaccess/contacts?fields={fields}&lang={lang}
HTTP MethodGET
Automation Version(s)7.3.3.4

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.3.4
langStringNo Indicates the language applied.7.3.3.4

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.3.4
result.addressresult.address{}The citizen user's address.7.3.3.4
result.address.addressLine1stringThe first line of the address. 7.3.3.4
result.address.addressLine2stringThe second line of the address.7.3.3.4
result.address.addressLine3stringThe third line of the address.7.3.3.4
result.address.citystringThe name of the city.7.3.3.4
result.address.countryresult.address.country{}The name of the country.7.3.3.4
result.address.country.textstringThe localized display text.7.3.3.4
result.address.country.valuestringThe value for the specified parameter.7.3.3.4
result.address.stateresult.address.state{}The state corresponding to the address on record.7.3.3.4
result.address.state.textstringThe localized display text.7.3.3.4
result.address.state.valuestringThe value for the specified parameter.7.3.3.4
result.address.zipstringThe address zip code.7.3.3.4
result.birthCityresult.birthCity{}The city of birth for an individual.7.3.3.4
result.birthCity.textstringThe localized display text.7.3.3.4
result.birthCity.valuestringThe value for the specified parameter.7.3.3.4
result.birthDatedateTimeThe birth date of an individual.7.3.3.4
result.birthRegionresult.birthRegion{}The country of birth or region of birth for an individual.7.3.3.4
result.birthRegion.textstringThe localized display text.7.3.3.4
result.birthRegion.valuestringThe value for the specified parameter.7.3.3.4
result.birthStateresult.birthState{}The state of birth for an individual.7.3.3.4
result.birthState.textstringThe localized display text.7.3.3.4
result.birthState.valuestringThe value for the specified parameter.7.3.3.4
result.businessNamestringA secondary business name for the applicable individual.7.3.3.4
result.businessName2stringA secondary business name.7.3.3.4
result.commentstringComments or notes about the current context.7.3.3.4
result.contactAddresses[]result.contactAddresses{}Contains the contact address information.7.3.3.4
result.contactAddresses.addressLine1stringThe first line of the address. 7.3.3.4
result.contactAddresses.addressLine2stringThe second line of the address.7.3.3.4
result.contactAddresses.addressLine3stringThe third line of the address.7.3.3.4
result.contactAddresses.citystringThe name of the city.7.3.3.4
result.contactAddresses.countryresult.contactAddresses.country{}The name of the country.7.3.3.4
result.contactAddresses.country.textstringThe localized display text.7.3.3.4
result.contactAddresses.country.valuestringThe value for the specified parameter.7.3.3.4
result.contactAddresses.effectiveDatedateTimeThe date when you want the condition to become effective.7.3.3.4
result.contactAddresses.entityIDlongThe unique ID of the entity or record.7.3.3.4
result.contactAddresses.expirationDatedateTimeThe date when the condition expires.7.3.3.4
result.contactAddresses.faxstringThe fax number for the contact.7.3.3.4
result.contactAddresses.faxCountryCodestringFax Number Country Code7.3.3.4
result.contactAddresses.fullAddressstringThe full address.7.3.3.4
result.contactAddresses.houseNumberAlphaEndstringThe alphabetic ending street number that makes up the address.7.3.3.4
result.contactAddresses.houseNumberAlphaStartstringThe alphabetic beginning street number that makes up the address.7.3.3.4
result.contactAddresses.houseNumberEndlongThe ending street number that makes up the address.7.3.3.4
result.contactAddresses.houseNumberStartlongThe beginning street number that makes up the address.7.3.3.4
result.contactAddresses.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.contactAddresses.levelNumberEndstringThe ending level number (floor number) that makes up the address within a complex.7.3.3.4
result.contactAddresses.levelNumberStartstringThe beginning level number (floor number) that makes up the address within a complex.7.3.3.4
result.contactAddresses.levelPrefixstringThe prefix for the level numbers (floor numbers) that make up the address.7.3.3.4
result.contactAddresses.phonestringThe telephone number of the contact.7.3.3.4
result.contactAddresses.phoneCountryCodestringThe country code for the associated phone number.7.3.3.4
result.contactAddresses.postalCodestringThe postal ZIP code for the address.7.3.3.4
result.contactAddresses.primarystring 7.3.3.4
result.contactAddresses.recipientstringThe entity on the receiving end of an operation, for example a notification of an event.7.3.3.4
result.contactAddresses.stateresult.contactAddresses.state{}The state corresponding to the address on record.7.3.3.4
result.contactAddresses.state.textstringThe localized display text.7.3.3.4
result.contactAddresses.state.valuestringThe value for the specified parameter.7.3.3.4
result.contactAddresses.statusresult.contactAddresses.status{}The contact address status.7.3.3.4
result.contactAddresses.streetDirectionresult.contactAddresses.streetDirection{}The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.7.3.3.4
result.contactAddresses.streetDirection.textstringThe localized display text.7.3.3.4
result.contactAddresses.streetDirection.valuestringThe value for the specified parameter.7.3.3.4
result.contactAddresses.streetNamestringThe street name for the address.7.3.3.4
result.contactAddresses.streetPrefixstringAny part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.7.3.3.4
result.contactAddresses.streetSuffixresult.contactAddresses.streetSuffix{}The type of street such as "Lane" or "Boulevard".7.3.3.4
result.contactAddresses.streetSuffix.textstringThe localized display text.7.3.3.4
result.contactAddresses.streetSuffix.valuestringThe value for the specified parameter.7.3.3.4
result.contactAddresses.streetSuffixDirectionresult.contactAddresses.streetSuffixDirection{}The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.7.3.3.4
result.contactAddresses.streetSuffixDirection.textstringThe localized display text.7.3.3.4
result.contactAddresses.streetSuffixDirection.valuestringThe value for the specified parameter.7.3.3.4
result.contactAddresses.typeresult.contactAddresses.type{}The address type.7.3.3.4
result.contactAddresses.type.textstringThe localized display text.7.3.3.4
result.contactAddresses.type.valuestringThe value for the specified parameter.7.3.3.4
result.contactAddresses.unitEndstringThe end parameter of a range of unit numbers.7.3.3.4
result.contactAddresses.unitStartstringThe starting parameter of a range of unit numbers.7.3.3.4
result.contactAddresses.unitTyperesult.contactAddresses.unitType{}The unit type designation of the address.7.3.3.4
result.contactAddresses.unitType.textstringThe localized display text.7.3.3.4
result.contactAddresses.unitType.valuestringThe value for the specified parameter.7.3.3.4
result.contactAddresses.validateFlagstring 7.3.3.4
result.deceasedDatedateTimeThe date of death. This field is active only when the Contact Type selected is Individual.7.3.3.4
result.driverLicenseNumberstringThe driver's license number of the contact. This field is active only when the Contact Type selected is Individual.7.3.3.4
result.driverLicenseStateresult.driverLicenseState{}The state that issued the driver's license.7.3.3.4
result.driverLicenseState.textstringThe localized display text.7.3.3.4
result.driverLicenseState.valuestringThe value for the specified parameter.7.3.3.4
result.emailstringThe contact's email address.7.3.3.4
result.faxCountryCodestringFax Number Country Code7.3.3.4
result.faxNumberstringThe user's fax number.7.3.3.4
result.federalEmployerIdstringThe Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.3.4
result.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.3.4
result.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.3.4
result.genderresult.gender{}The gender (male or female) of the individual.7.3.3.4
result.gender.textstringThe localized display text.7.3.3.4
result.gender.valuestringThe value for the specified parameter.7.3.3.4
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.isPrimarystringIndicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.7.3.3.4
result.lastNamestringThe last name (surname). 7.3.3.4
result.middleNamestringThe middle name. 7.3.3.4
result.namesuffixstringThe suffix that follows the user's name.7.3.3.4
result.passportNumberstringThe contact's passport number. This field is only active when the Contact Type selected is Individual.7.3.3.4
result.phone1CountryCodestringPhone Number 1 Country Code7.3.3.4
result.phone2CountryCodestringPhone Number 2 Country Code7.3.3.4
result.phone3CountryCodestringPhone Number 3 Country Code7.3.3.4
result.phoneNumber1stringThe user's first phone number.7.3.3.4
result.phoneNumber2stringThe user's second phone number.7.3.3.4
result.phoneNumber3stringThe user's third phone number.7.3.3.4
result.postOfficeBoxstringThe post office box number.7.3.3.4
result.preferredChannelresult.preferredChannel{}The method by which the contact prefers to be notified, by phone for example.7.3.3.4
result.preferredChannel.textstringThe localized display text.7.3.3.4
result.preferredChannel.valuestringThe value for the specified parameter.7.3.3.4
result.raceresult.race{}The contact's race/ethnicity.7.3.3.4
result.race.textstringThe localized display text.7.3.3.4
result.race.valuestringThe value for the specified parameter.7.3.3.4
result.relationresult.relation{}The contact's relationship to the application or service request.7.3.3.4
result.relation.textstringThe localized display text.7.3.3.4
result.relation.valuestringThe value for the specified parameter.7.3.3.4
result.salutationresult.salutation{}The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual.7.3.3.4
result.salutation.textstringThe localized display text.7.3.3.4
result.salutation.valuestringThe value for the specified parameter.7.3.3.4
result.socialSecurityNumberstringThe individual's social security number. This field is only active when the Contact Type selected is Individual.7.3.3.4
result.stateIdNumberstringThe contact's state ID number. This field is only active when the Contact Type selected is Individual.7.3.3.4
result.statusresult.status{}The contact status.7.3.3.4
result.titlestringThe individual's business title. 7.3.3.4
result.tradeNamestringThe contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.7.3.3.4
result.typeresult.type{}The type of people to contact. 7.3.3.4
result.type.textstringThe localized display text.7.3.3.4
result.type.valuestringThe value for the specified parameter.7.3.3.4
result.typeFlagstring 7.3.3.4
statusintegerThe record status.7.3.3.4