https://github.com/stanfordspezi/speziconsent
Spezi Consent module to retrieve consent in iOS applications
https://github.com/stanfordspezi/speziconsent
consent ios spezi stanford
Last synced: 2 months ago
JSON representation
Spezi Consent module to retrieve consent in iOS applications
- Host: GitHub
- URL: https://github.com/stanfordspezi/speziconsent
- Owner: StanfordSpezi
- License: mit
- Created: 2025-08-04T22:20:11.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-01-22T09:13:32.000Z (5 months ago)
- Last Synced: 2026-01-31T19:55:52.311Z (4 months ago)
- Topics: consent, ios, spezi, stanford
- Language: Swift
- Homepage: https://swiftpackageindex.com/StanfordSpezi/SpeziConsent/documentation/speziconsent
- Size: 3.78 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# SpeziConsent
[](https://github.com/StanfordSpezi/SpeziConsent/actions/workflows/build-and-test.yml)
[](https://codecov.io/gh/StanfordSpezi/SpeziConsent)
[](https://zenodo.org/badge/latestdoi/573230182)
[](https://swiftpackageindex.com/StanfordSpezi/SpeziConsent)
[](https://swiftpackageindex.com/StanfordSpezi/SpeziConsent)
Provides UI components for consent handling in your app.
## Overview
The SpeziConsent module provides utilities for retrieving consent for e.g. study participation.
Simple Consent Form
Interactive Consent Form
Interactive Consent Form with Selection Requirements
### Onboarding Consent View
The [`OnboardingConsentView`](https://swiftpackageindex.com/stanfordspezi/speziconsent/documentation/speziconsent/onboardingconsentview) can be used to allow your users to read and agree to a document, e.g., a consent document for a research study or a terms and conditions document for an app. The document can be signed using a family and given name and a hand-drawn signature. The signed consent form can then be exported and shared as a PDF file.
The following example demonstrates how the [`OnboardingConsentView`](https://swiftpackageindex.com/stanfordspezi/speziconsent/documentation/speziconsent/onboardingconsentview) shown above is constructed by reading a consent form from a markdown file, creating a [`ConsentDocument`](https://swiftpackageindex.com/stanfordspezi/speziconsent/documentation/speziconsent/consentdocument) and passing it to the `OnboardingConsentView`, and an action that should be performed once the consent has been given (which receives the exported consent form as a PDF), as well as a configuration defining the properties of the exported consent form.
The following example demonstrates using the [`OnboardingConsentView`](https://swiftpackageindex.com/stanfordspezi/speziconsent/documentation/speziconsent/onboardingconsentview) to present a consent form to the user as part of an onboarding flow.
Once the consent if completed (i.e., the user signed it and filled out all required form elements), the user can continue to the next onboarding step.
The view also uses the [`ConsentShareButton`](https://swiftpackageindex.com/stanfordspezi/speziconsent/documentation/speziconsent/consentsharebutton) to allow the user to obtain a PDF-exported copy of their signed consent document.
```swift
import SpeziConsent
import SpeziViews
import SwiftUI
struct ConsentStep: View {
let url: URL
@State private var consentDocument: ConsentDocument?
@State private var viewState: ViewState = .idle
var body: some View {
OnboardingConsentView(consentDocument: consentDocument, viewState: $viewState) {
// advance your Onboarding flow in response to the user having confirmed a completed consent document
}
.viewStateAlert(state: $viewState)
.toolbar {
ToolbarItem(placement: .primaryAction) {
// give your user the ability to obtain a PDF version of the consent document they just signed
ConsentShareButton(
consentDocument: consentDocument,
viewState: $viewState
)
}
}
.task {
// load the consent document when the view is first displayed.
// this will automatically cause the `OnboardingConsentView` above to update its contents.
do {
consentDocument = try ConsentDocument(contentsOf: url)
} catch {
viewState = .error(AnyLocalizedError(error: error))
}
}
}
}
```
For more information, please refer to the [API documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziConsent/documentation).
## The Spezi Template Application
The [Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication) provides a great starting point and example using the `SpeziConsent` module.
## Contributing
Contributions to this project are welcome. Please make sure to read the [contribution guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md) and the [contributor covenant code of conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) first.
## License
This project is licensed under the MIT License. See [Licenses](https://github.com/StanfordSpezi/SpeziConsent/tree/main/LICENSES) for more information.
