MARS documentation
API reference

Provision bond

Contract and client context

Operation: provision_bond · HTTP: POST /v1/admin/bonds

Use an operator-supplied registry base URL. Request execution is disabled in this documentation explorer. Generated request snippets are templates, not signed or authorized submissions.

Exact operation definition
{
  "operationId": "provision_bond",
  "parameters": [
    {
      "description": "Required route-scoped idempotency key",
      "in": "header",
      "name": "Idempotency-Key",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/BondProvisionRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "201": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Bond"
          }
        }
      },
      "description": "Registry-local bond provisioned"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Session missing or invalid"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Admin capability missing"
    },
    "409": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Idempotency conflict"
    }
  },
  "security": [
    {
      "siwsSession": []
    },
    {
      "siwsCookie": []
    }
  ],
  "tags": [
    "trust"
  ]
}

Resolve schema references against the complete OpenAPI document. Standalone schemas and hashes are generated from the same checked-in source.

POST/v1/admin/bonds

Authorization

AuthorizationBearer <token>

Opaque capability-bearing MARS session issued by an enabled authentication profile.

In: header

Header Parameters

Idempotency-Key*string

Required route-scoped idempotency key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Admin request for provisioning a registry-local bond.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/admin/bonds" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "amount": "string",    "bondId": "string",    "currency": "string",    "entryDid": "string",    "publisherDid": "string",    "status": "active"  }'
{  "amount": "string",  "bondId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "currency": "string",  "entryDid": "string",  "publisherDid": "string",  "registryDid": "string",  "slashHistory": [    {      "amount": "string",      "distribution": {        "harmedPartiesShare": "string",        "reporterShare": "string",        "treasuryShare": "string"      },      "reason": "string",      "reporterDid": "string",      "timestamp": "2019-08-24T14:15:22Z"    }  ],  "status": "active"}