UserAgreement Object

Contains information about a platform legal agreement document.

This object is used by the following operations:

• POST /api/legals/agreements

The properties included in the UserAgreement object are listed below. Properties are optional unless otherwise specified.

Property	Type	Description
AgreementID	long	A unique ID for the legal agreement.
UserID	string	The unique ID for a specific user.Required in the request message when a user is accepting a legal agreement.
DocumentID (same as LegalDocumentID)	string	The unique ID for the association of a specific legal document with a resource such as an API version, license, or the platform. Required in the request message when a user is accepting a legal agreement.
AgreementScopeID	string	A unique ID for the scope of the legal agreement. In the case of an API access request, the AgreementScopeID is the AppVersionID. When an app version is connecting to an API version, the app developer must accept any legal agreements configured for the specific API version and the agreements configured for licenses that are part of the scope of the API contract being set up.
AgreementDate	DateTime	The date/time that the agreement was activated with the user.

Related Topics