Authoring

Validate agreement structure

Checks only the authored agreement JSON and returns participant variable keys, input IDs, state IDs, and warnings. This does not validate deployment values, participant wallet addresses, signer, or permit data.

post/v0/agreements/validate-template

Request

  • Base URL: https://test-api.shodai.network
  • URL: https://test-api.shodai.network/v0/agreements/validate-template
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

object required

Authored agreement JSON to validate before deployment preflight.

Response

Agreement structure validation summary.

Example response

{
  "data": {
    "templateId": "did:template:service-retainer-v0-1",
    "participantVariableKeys": [
      "serviceProviderRepresentative",
      "clientRepresentative"
    ],
    "inputIds": [
      "submitInitialPaymentProof"
    ],
    "stateIds": [
      "AWAITING_PAYMENT",
      "WORK_IN_PROGRESS"
    ],
    "warnings": []
  },
  "meta": {
    "apiVersion": "v0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.