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

# requestSignup(for:fields:message:emailConsent:smsConsent:termsAndConditions:)

Opens a form so that the customer can share the contact information for the
purpose of sign-up activity.

```
final func requestSignup(for purpose: CustomerEngagementSession.Purpose = .membership, fields: [CustomerEngagementSession.Field], message: String? = nil, emailConsent: CustomerEngagementSession.ConsentOption = .hidden, smsConsent: CustomerEngagementSession.ConsentOption = .hidden, termsAndConditions: String? = nil) async throws -> CustomerEngagement.SignUp
```

## Parameters

`purpose`

An enum of pre-defined purpose of the form for `.membership`,
`.accountCreation`, and `.accountUpdate`. The default is `.membership`.

`fields`

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

`message`

A multi-line message text below the title.

`emailConsent`

A consent option to allow or decline promotions and offers over email channel.

`smsConsent`

A consent option to allow or decline promotions and offers over SMS channel.

`termsAndConditions`

An optional markdown string to display during the sign-up flow.

## Return Value

[`CustomerEngagement.SignUp`](/documentation/ProximityReader/CustomerEngagement/SignUp) contact information shared by the customer.

## Discussion> 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)