feat: Legal consent (#1671)

Co-authored-by: Alexis Aguilar <[email protected]> Co-authored-by: victoria <[email protected]>
clerk · Nov 11, 2024 · 95da7d2 · 95da7d2
1 parent 99ccf10
commit 95da7d2
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 0 deletions.
diff --git a/docs/authentication/configuration/legal-compliance.mdx b/docs/authentication/configuration/legal-compliance.mdx
@@ -0,0 +1,11 @@
+---
+title: Legal compliance
+description: Learn how to configure your legal compliance settings in the Clerk Dashboard.
+---
+
+Clerk provides a legal compliance setting that allows you to require users to agree to your terms of service or privacy policy before they can sign up to your application. After enabling the setting, there will be a checkbox to accept the terms in your [`<SignUp />` component](/docs/components/authentication/sign-up) or [Account Portal sign-up page](/docs/customization/account-portal/overview#sign-up).
+
+To configure the setting:
+
+1. In the Clerk Dashboard, navigate to the [**Legal**](https://dashboard.clerk.com/last-active?path=compliance/legal) page.
+1. Enable or disable **Require express consent to legal documents**.
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -350,6 +350,10 @@
                         {
                           "title": "Restrictions",
                           "href": "/docs/authentication/configuration/restrictions"
+                        },
+                        {
+                          "title": "Legal compliance",
+                          "href": "/docs/authentication/configuration/legal-compliance"
                         }
                       ]
                     ]

diff --git a/docs/references/javascript/sign-up/authenticate-with.mdx b/docs/references/javascript/sign-up/authenticate-with.mdx
@@ -58,6 +58,13 @@ function authenticateWithRedirect(params: AuthenticateWithRedirectParams): Promi
   - `string | undefined`
 
   Email address to use for targeting a SAML connection at sign-up.
+
+  ---
+
+  - `legalAccepted?`
+  - `boolean`
+
+  The user has agreed to the [legal compliance](/docs/authentication/configuration/legal-compliance) documents.
 </Properties>
 
 ## `authenticateWithWeb3()`
@@ -89,6 +96,13 @@ function authenticateWithWeb3(params: AuthenticateWithWeb3Params): Promise<SignU
   - `Web3Strategy`
 
   The Web3 verification strategy.
+
+  ---
+
+  - `legalAccepted?`
+  - `boolean`
+
+  The user has agreed to the [legal compliance](/docs/authentication/configuration/legal-compliance) documents.
 </Properties>
 
 ### `GenerateSignatureParams`
@@ -112,6 +126,13 @@ function authenticateWithWeb3(params: AuthenticateWithWeb3Params): Promise<SignU
   - `Web3Provider`
 
   The Web3 provider to generate the signature with.
+
+  ---
+
+  - `legalAccepted?`
+  - `boolean`
+
+  The user has agreed to the [legal compliance](/docs/authentication/configuration/legal-compliance) documents.
 </Properties>
 
 ## `authenticateWithMetamask()`
@@ -131,6 +152,13 @@ function authenticateWithMetamask(
   - `{[string]: any}`
 
   Custom fields that will be attached to the [`User`](/docs/references/javascript/user/user) object post-signup.
+
+  ---
+
+  - `legalAccepted?`
+  - `boolean`
+
+  The user has agreed to the [legal compliance](/docs/authentication/configuration/legal-compliance) documents.
 </Properties>
 
 ## `authenticateWithCoinbaseWallet()`
@@ -150,6 +178,13 @@ function authenticateWithCoinbaseWallet(
   - `{[string]: any}`
 
   Custom fields that will be attached to the [`User`](/docs/references/javascript/user/user) object post-signup.
+
+  ---
+
+  - `legalAccepted?`
+  - `boolean`
+
+  The user has agreed to the [legal compliance](/docs/authentication/configuration/legal-compliance) documents.
 </Properties>
 
 [signup-ref]: /docs/references/javascript/sign-up/sign-up
diff --git a/docs/references/javascript/sign-up/sign-up.mdx b/docs/references/javascript/sign-up/sign-up.mdx
@@ -264,6 +264,13 @@ function create(params: SignUpCreateParams): Promise<SignUpResource>
   - `boolean`
 
   Transfer the user to a dedicated sign-up for an OAuth flow.
+
+  ---
+
+  - `legalAccepted`
+  - `boolean`
+
+  The user has agreed to the [legal compliance](/docs/authentication/configuration/legal-compliance) documents.
 </Properties>
 
 ### `update()`

diff --git a/docs/references/javascript/user/user.mdx b/docs/references/javascript/user/user.mdx
@@ -252,6 +252,13 @@ The ClerkJS SDK provides some helper [methods](#methods) on the `User` object to
 
   ---
 
+  - `legalAcceptedAt`
+  - `Date`
+
+  Date when the user accepted the legal documents. May be empty if [**Require express consent to legal documents**](/docs/authentication/configuration/legal-compliance) is not enabled.
+
+  ---
+
   - `lastSignInAt`
   - `Date`
-Original file line number
+Diff line change
@@ Expand Up @@
       ---
+      - `legalAcceptedAt`
+      - `Date`
+      Date when the user accepted the legal documents. May be empty if [**Require express consent to legal documents**](/docs/authentication/configuration/legal-compliance) is not enabled.
+      ---
       - `lastSignInAt`
       - `Date`
@@ Expand Down @@