AgreementBundle

  • agreement_kind
    Type: string
    required

    The type of agreement to be presented to the account holder.

  • agreement_version
    Type: integerFormat: int32
    required

    The version of the agreement bundle.

  • documents
    Type: array ยท AgreementDocument[]
    required

    The documents included in the agreement bundle.

    • doc_type
      Type: string
      required

      The document type.

    • key
      Type: string
      required

      Stable key identifying the document within the agreement bundle.

    • locale
      Type: string
      required

      Locale of the document content.

    • mandatory
      Type: boolean
      required

      Whether accepting or reviewing this document is mandatory.

    • title
      Type: string
      required

      Human-readable title of the document.

    • url
      Type: string
      required

      URL where the document can be viewed.

    • description
      Type: string

      Optional short description of the document.

  • locale
    Type: string
    required

    Locale of the agreement content.