Monax API (v1)

Download OpenAPI specification:Download

Happy Contracting!

Getting Started

We are pleased you have joined the Marmot-y movement.

Authentication

external

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

BearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

OAuth2

This API uses OAuth 2 for more information.

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://login.monax.io/oauth/authorize?audience="monax-api"
Token URL: https://login.monax.io/oauth/token
Scopes:
    implicit OAuth Flow
    Authorization URL: https://login.monax.io/oauth/authorize?audience="monax-api"
    Scopes:
      clientCredentials OAuth Flow
      Token URL: https://login.monax.io/oauth/token?audience="monax-api"
      Scopes:
        password OAuth Flow
        Token URL: https://login.monax.io/oauth/token?audience="monax-api"
        Scopes:

          Agreements

          List agreements.

          Returns list of agreements (on+off chain) the requesting user is allowed access to, and additional relevant data.

          Authorizations:
          query Parameters
          createdAt
          string
          Example: createdAt=["2020-01-01", "2020-02-01"]

          Optionally filter results by the agreement created date with a JSON array of two dates. Agreements will only be returned if the created date falls between the two date. Both dates are optional, if a date is not provided then the range will be open ended.

          name
          string

          Optionally filter results by the name of the agreement

          statuses
          string

          Optionally filter results by the agreement status with JSON array of agreement statuses to include.

          Responses

          Response Schema: application/json
          object

          Data of the users whose action is required on the agreement. (Ie the assignees of any pending tasks.)

          Array of objects (AgreementListItem)

          List of both on-chain and draft agreements the requesting user is authorized to read. Authorized users include:

          • agreement owners
          • agreement parties (for on-chain agreements)
          • include an organization + department(s) to which the authenticated user belongs in its signatories Agreements list will be sorted in descending order of creation of the agreement

          Response samples

          Content type
          application/json
          {
          • "agreements":
            [
            ],
          • "actors":
            {
            }
          }

          Create an agreement.

          Create an agreement with the fields and data that are included in the body of the request.

          Authorizations:
          Request Body schema: application/json
          approver
          string

          The user responsible for approving the agreement

          archetype
          string

          Address of the parent of the agreement

          governingAgreements
          Array of strings

          An array of addresses of the agreements governing the new agreement.

          name
          string <= 32 characters

          Human readable name of the agreement. Note that this field is limited to a maximum of 32 ASCII characters.

          Array of objects (ObligationNoticeData)
          Array of objects (ObligationNotificationData)
          owner
          string

          The blockchain address of the organization that controls the visibility of the agreement

          Array of objects (AgreementParameter)

          An array of objects with each parameter's name, value, and data type. See the AgreementParameter object definition for more information on the data types. Note - If a parameter with type 8 (Signing Party) is given, the corresponding value will be added to the agreement's parties.

          object (ObligationRenewalData)

          The data required to define the obligation

          Responses

          Response Schema: application/json
          address
          string

          Agreement's address on the blockchain

          archetype
          string

          Address of the parent of the agreement

          Array of objects

          New organizations that have been created in line with the creation of this agreement.

          Array of objects

          New users that have been created in line with the creation of this agreement.

          Array of objects (AgreementParameter)

          An array of objects with each parameter's name, value, and data type. See the AgreementParameter object definition for more information on the data types. Note - If a parameter with type 8 (Signing Party) is given, the corresponding value will be added to the agreement's parties.

          parties
          Array of strings

          An array of each party members' address. Can be excluded if parties are defined in parameters.

          processInstance
          string

          Address of the agreement's formation process instance

          warnings
          Array of strings

          List of warning messages showing problems with agreement creation

          Request samples

          Content type
          application/json
          {
          • "archetype": "string",
          • "name": "string",
          • "owner": "string",
          • "approver": "string",
          • "parameters":
            [