InfoHub

Need Help? Need
Help?
 
Close
X

Have questions? We're here to help.

If you need any help with your search, please Contact Us and an information steward will get back to you within 24 hours.

Have Questions?

api.byu.edu/domains/legacy/identity/person/PRO/address/v1

This API is deprecated.
Any existing subscriptions to this API will still work. However, no new subscriptions can be made, and the API may become inoperational in the future without notice. If you need the information in this API, you can contact our Information Governance Director, and we will consider including this data in a University API.
Collapse All Expand All
Field Business Term Classification Glossary
addressAddress
 PublicIdentity
            city
            country_code
            iso_country_code_2
            iso_country_code_3
            line1
            line2r
            line3
            line4
            postal_code
            state_province_region
            unlisted
address_typeAddress Type
 PublicIdentity
address_typeAddressService
            address_type_response
                        addressAddress
 PublicIdentity
                                    cityCity
 PublicIdentity
                                    country_codeCountry Code
 PublicIdentity
                                    iso_country_code_2ISO2 Country Code
 PublicIdentity
                                    iso_country_code_3ISO3 Country Code
 PublicIdentity
                                    line1Address Line 1
 PublicIdentity
                                    line2Address Line 2
 PublicIdentity
                                    line2rAddress Line 2R
 PublicIdentity
                                    line3Address Line 3
 PublicIdentity
                                    line4Address Line 4
 PublicIdentity
                                    postal_codePostal Code
 PublicIdentity
                                    state_province_regionHome State or Province Code
 PublicIdentity
                                    unlistedUnlisted Data Flag
 PublicIdentity
                        address_typeAddress Type
 PublicIdentity
                        address_type_descriptionAddress Type Description
 Public  Identity
                        contracted_housing
                        email
                                    email_addressEmail Address
 PublicIdentity
                                    email_unlistedUnlisted Data Flag
 PublicIdentity
                                    person_summary_line
                                                academic_recordAcademic Record Flag
 Internal  Academic Records
                                                byu_idBYU ID
 PublicIdentity
                                                deceasedDeceased Flag
 PublicIdentity
                                                employee_roleEmployee Role
 Internal  Compensation
                                                is_employee
                                                merge_pendingMerge Pending Flag
 Public  Identity
                                                nameSort Name
 PublicIdentity
                                                net_idNet ID
 PublicIdentity
                                                non_person_organizationOrganization Flag
 Internal  Identity
                                                person_idPerson ID
 PublicIdentity
                                                registrar_warningRegistrar Warning Flag
 Internal  Academic Records
                                                restrictedRestricted Person Flag
 ConfidentialIdentity
                                                student_roleClass Standing
 Public  Academic Records
                                    work_email_addressWork Email Address
 PublicCompensation
                        person_summary_line
                                    academic_record
                                    byu_idBYU ID
 PublicIdentity
                                    deceasedDeceased Flag
 PublicIdentity
                                    employee_roleEmployee Role
 Internal  Compensation
                                    is_employee
                                    merge_pending
                                    name
                                    net_idNet ID
 PublicIdentity
                                    non_person_organization
                                    person_idPerson ID
 PublicIdentity
                                    registrar_warning
                                    restricted
                                    student_role
                        phones
                                    country_codeCountry Code
 PublicIdentity
                                    is_mobileMobile Phone Flag
 Internal  Identity
                                    is_primaryPrimary Phone Flag
 Internal  Identity
                                    is_ttyTeletype Flag
 Unspecified  Identity
                                    is_unlistedUnlisted Data Flag
 PublicIdentity
                                    phone_indexIndex
 Unspecified  Identity
                                    phone_numberPhone Number
 PublicIdentity
                                    type_of_devicePhone Type
 PublicIdentity
address_type_descriptionAddress Type Description
 Public  Identity
address_type_response
            addressAddress
 PublicIdentity
                        cityCity
 PublicIdentity
                        country_codeCountry Code
 PublicIdentity
                        iso_country_code_2ISO2 Country Code
 PublicIdentity
                        iso_country_code_3ISO3 Country Code
 PublicIdentity
                        line1Address Line 1
 PublicIdentity
                        line2Address Line 2
 PublicIdentity
                        line2rAddress Line 2R
 PublicIdentity
                        line3Address Line 3
 PublicIdentity
                        line4Address Line 4
 PublicIdentity
                        postal_codePostal Code
 PublicIdentity
                        state_province_regionHome State or Province Code
 PublicIdentity
                        unlistedUnlisted Data Flag
 PublicIdentity
            address_typeAddress Type
 PublicIdentity
            address_type_descriptionAddress Type Description
 Public  Identity
            email
                        email_addressEmail Address
 PublicIdentity
                        email_unlistedUnlisted Data Flag
 PublicIdentity
                        person_summary_line
                                    academic_recordAcademic Record Flag
 Internal  Academic Records
                                    byu_idBYU ID
 PublicIdentity
                                    deceasedDeceased Flag
 PublicIdentity
                                    employee_roleEmployee Role
 Internal  Compensation
                                    is_employee
                                    merge_pendingMerge Pending Flag
 Public  Identity
                                    nameSort Name
 PublicIdentity
                                    net_idNet ID
 PublicIdentity
                                    non_person_organizationOrganization Flag
 Internal  Identity
                                    person_idPerson ID
 PublicIdentity
                                    registrar_warningRegistrar Warning Flag
 Internal  Academic Records
                                    restrictedRestricted Person Flag
 ConfidentialIdentity
                                    student_roleClass Standing
 Public  Academic Records
                        work_email_addressWork Email Address
 PublicCompensation
            person_summary_line
                        academic_record
                        byu_idBYU ID
 PublicIdentity
                        deceasedDeceased Flag
 PublicIdentity
                        employee_roleEmployee Role
 Internal  Compensation
                        is_employee
                        merge_pending
                        name
                        net_idNet ID
 PublicIdentity
                        non_person_organization
                        person_idPerson ID
 PublicIdentity
                        registrar_warning
                        restricted
                        student_role
            phones
                        country_codeCountry Code
 PublicIdentity
                        is_mobileMobile Phone Flag
 Internal  Identity
                        is_primaryPrimary Phone Flag
 Internal  Identity
                        is_ttyTeletype Flag
 Unspecified  Identity
                        is_unlistedUnlisted Data Flag
 PublicIdentity
                        phone_indexIndex
 Unspecified  Identity
                        phone_numberPhone Number
 PublicIdentity
                        type_of_devicePhone Type
 PublicIdentity
documentationDocumentation
 Internal  Identity
            WebService
                        errors
                                    code
                                    httpStatusCode
                                    message
                                    name
                        httpStatusCodes
                                    code
                                    message
                        name
                        operations
                                    description
                                    method
                                    name
                                    path
                                    path_identifiers
                                                format
                                                name
                                                type
                                    query_attributes
                                                format
                                                name
                                                required
                                                type
email
            email_address
            email_unlisted
            person_summary_line
                        academic_record
                        byu_id
                        deceased
                        employee_role
                        is_employee
                        merge_pending
                        name
                        net_id
                        non_person_organization
                        person_id
                        registrar_warning
                        restricted
                        student_role
            work_email_address
email_addressEmail Address
 PublicIdentity
            email_address
            unlisted
housing_policy_compliance
            compliant
            email_address_invalid
            invalid_address_description
            mailing_address_invalid
            residential_address_invalid
mailing
            mailing_address
                        address_line_1
                        address_line_2
                        unlisted
            mailing_phone
                        label
                        phone_number
permanent
            permanent_address
                        address_line_1
                        address_line_2
                        unlisted
            permanent_phone
                        label
                        phone_number
person_idAddressService
            person_id_response
                        campus_emergency_alertEmergency Contact
 Internal  Identity
                                    phone_array
                                                label
                                                phone_numberPhone Number
 PublicIdentity
                                    text_message_address
                                                device_address
                        email_addressEmail Address
 PublicIdentity
                                    email_addressEmail Address
 PublicIdentity
                                    unlistedUnlisted Data Flag
 PublicIdentity
                        emergency_contactEmergency Contact
 Internal  Identity
                                    contact_name
                                    phone_numberPhone Number
 PublicIdentity
                        housing_policy_compliance
                                    compliantHousing Compliance Flag
 Internal  Identity
                                    email_address_invalid
                                    mailing_address_invalid
                                    residential_address_invalid
                        mailing
                                    address_array
                                                address_line_1
                                                address_line_2
                                                address_line_3
                                                unlisted
                                    phone_array
                                                label
                                                phone_numberPhone Number
 PublicIdentity
                        permanent
                                    address_array
                                                address_line_1
                                                address_line_2
                                                address_line_3
                                                unlisted
                                    phone_array
                                                label
                                                phone_numberPhone Number
 PublicIdentity
                        person_summary_line
                                    academic_recordAcademic Record Flag
 Internal  Academic Records
                                    byu_idBYU ID
 PublicIdentity
                                    deceasedDeceased Flag
 PublicIdentity
                                    employee_roleEmployee Role
 Internal  Compensation
                                    is_employee
                                    merge_pendingMerge Pending Flag
 Public  Identity
                                    nameSort Name
 PublicIdentity
                                    net_idNet ID
 PublicIdentity
                                    non_person_organizationOrganization Flag
 Internal  Identity
                                    person_idPerson ID
 PublicIdentity
                                    registrar_warningRegistrar Warning Flag
 Internal  Academic Records
                                    restrictedRestricted Person Flag
 ConfidentialIdentity
                                    student_roleClass Standing
 Public  Academic Records
                        residential
                                    address_array
                                                address_line_1
                                                address_line_2
                                                address_line_3
                                                unlisted
                                    phone_array
                                                label
                                                phone_numberPhone Number
 PublicIdentity
                        work
                                    address_array
                                                address_line_1
                                                address_line_2
                                                address_line_3
                                                unlisted
                                    phone_array
                                                label
                                                phone_numberPhone Number
 PublicIdentity
person_summary_line
            academic_record
            byu_id
            deceased
            employee_role
            is_employee
            merge_pending
            name
            net_id
            non_person_organization
            person_id
            registrar_warning
            restricted
            student_role
phones
            country_code
            is_mobile
            is_primary
            is_tty
            is_unlisted
            phone_index
            phone_number
            type_of_device
residential
            residential_address
                        address_line_1
                        address_line_2
                        unlisted
            residential_phone
                        label
                        phone_number
work
            work_address
                        address_line_1
                        address_line_2
                        unlisted
            work_phone
                        label
                        phone_number