Skip to main content

LegalDocument

A document players (or developers) accept: its id, the version currently required, its title and where to read it. appId is set for an app’s own document and null for the platform’s.

type LegalDocument {
  documentId: String!
  version: String!
  title: String!
  url: String!
  appId: BigInt
}

Fields​

LegalDocument.documentId ● String! non-null scalar​

Stable id, such as 'player-terms' or an app's 'rules'.

LegalDocument.version ● String! non-null scalar​

The version currently required, usually the page’s date. A new version asks every player again at their next mint.

LegalDocument.title ● String! non-null scalar​

Title to show the player.

LegalDocument.url ● String! non-null scalar​

https URL where the document can be read.

LegalDocument.appId ● BigInt scalar​

The app whose own document this is (BigInt as a decimal string); null for a platform document.

Returned By​

appRequiredDocuments query ● developerLegalDocuments query ● playerLegalDocuments query ● setAppRequiredDocuments mutation