MARS documentation
API reference

Accept transfer offer

Contract and client context

Operation: accept_transfer_offer · HTTP: POST /v1/transfers/offers/{offer_id}/accept

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": "accept_transfer_offer",
  "parameters": [
    {
      "description": "Transfer offer identifier",
      "in": "path",
      "name": "offer_id",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Required route-scoped idempotency key",
      "in": "header",
      "name": "Idempotency-Key",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/TransferAcceptRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MarsEntry"
          }
        }
      },
      "description": "Recipient-signed transferred entry"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Session missing or invalid"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Recipient or capability mismatch"
    },
    "409": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Offer expired or entry changed"
    }
  },
  "security": [
    {
      "siwsSession": []
    },
    {
      "siwsCookie": []
    }
  ],
  "tags": [
    "entries"
  ]
}

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

POST/v1/transfers/offers/{offer_id}/accept

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

offer_id*string

Transfer offer identifier

Header Parameters

Idempotency-Key*string

Required route-scoped idempotency key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for accepting a transfer offer.

entry must preserve every publisher-authored field from the offered snapshot, bind publisherDid and its signature key controller to the authenticated recipient, advance the registry sequence, and omit registry-managed verifiableAttestations. The recipient must re-sign the complete canonical publisher payload; the owner's offer signature never substitutes for the recipient entry signature.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/transfers/offers/string/accept" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "entry": {      "entryDid": "string",      "entryType": "AgentDefinition",      "itemData": null,      "itemDataHash": "string",      "itemSchemaUri": "string",      "marsVersion": "string",      "name": "string",      "publishedAt": "2019-08-24T14:15:22Z",      "publisherDid": "string",      "signature": {        "algorithm": "string",        "keyId": "string",        "value": "string"      },      "version": "string"    }  }'
{  "accessPolicy": null,  "anchorState": "unanchored",  "bondReference": null,  "customMetadata": {    "property1": null,    "property2": null  },  "description": "string",  "entryDid": "string",  "entryType": "AgentDefinition",  "itemData": null,  "itemDataHash": "string",  "itemSchemaUri": "string",  "lifecycleStatus": "draft",  "lineageReference": null,  "marsVersion": "string",  "name": "string",  "publishedAt": "2019-08-24T14:15:22Z",  "publisherDid": "string",  "relationships": [    {      "label": "string",      "relationshipType": "dependsOn",      "targetDid": "string"    }  ],  "semanticAnnotations": [    {      "objectLiteral": "string",      "objectUri": "string",      "predicateUri": "string"    }  ],  "sequence": 0,  "serviceEndpoints": [    {      "id": "string",      "priority": 0,      "properties": {        "property1": null,        "property2": null      },      "type": "string",      "url": "string"    }  ],  "shardAssignment": "string",  "signature": {    "algorithm": "string",    "created": "string",    "keyId": "string",    "value": "string"  },  "tags": [    "string"  ],  "updatedAt": "2019-08-24T14:15:22Z",  "verifiableAttestations": [    null  ],  "version": "string"}