<!--
{
  "availability" : [
    "iOS: 27.0.0 -",
    "iPadOS: 27.0.0 -",
    "macCatalyst: 27.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "ProximityReader",
  "identifier" : "/documentation/ProximityReader/CustomerEngagementSession/requestAddress(for:fields:message:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "ProximityReader"
    ],
    "preciseIdentifier" : "s:15ProximityReader25CustomerEngagementSessionC14requestAddress3for6fields7messageAA0cD0O0G0VAC7PurposeOSg_SayAC5FieldOGSSSgtYaKF"
  },
  "title" : "requestAddress(for:fields:message:)"
}
-->

# requestAddress(for:fields:message:)

Opens a form so that the customer can share the postal address and additionally
collect email address and phone number.

```
final func requestAddress(for purpose: CustomerEngagementSession.Purpose? = nil, fields: [CustomerEngagementSession.Field], message: String? = nil) async throws -> CustomerEngagement.Address
```

## Parameters

`purpose`

An optional enum of pre-defined purpose of the form, for example `.shipping`.

`fields`

An array of optional contact field types on the form. Only `.emailAddress` and `.phoneNumber` types are supported.

`message`

A multi-line message text below the title.

## Return Value

[`CustomerEngagement.Address`](/documentation/ProximityReader/CustomerEngagement/Address) with postal address and contact information shared by the customer.

## Discussion

For example, email and phone number can be used for delivery notification.

> Throws: ``doc://com.apple.ProximityReader/documentation/ProximityReader/CustomerEngagementSession/Error`` if the request fails.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)