Sign in

v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB
Users

Accept Legal Document

Record user acceptance of a legal document. Supported types are crossmint-privacy-policy and crossmint-terms-of-service. The latest version of the document is always recorded. When accepting crossmint-terms-of-service, the region field is required so the correct regional agreement is resolved.

API scope required: users.create

put/2025-06-09/users/{userLocator}/legal-documents

Path parameters

userLocatorstring required

A user locator can be of the format:

  • email:<email>
  • userId:<userId>
  • phoneNumber:<phoneNumber>
  • twitter:<handle>
  • x:<handle>

Headers

X-API-KEYstring required

API key required for authentication

Request body

type'crossmint-privacy-policy' | 'crossmint-terms-of-service' required

The legal document the user is accepting.

region'eu' | 'worldwide' | 'us'

Region the user is operating in. Required when type is crossmint-terms-of-service and determines which regional Terms of Service document is accepted. Ignored for crossmint-privacy-policy.

acceptedAtstring date-time required

Response

Legal document acceptance recorded

acceptedAtstring date-time required