Authorized operation result.
application/json
{
"$ref": "#/components/schemas/CanonicalGetAgentOnlyConsentPacketResponse",
"type": "object",
"required": [
"data",
"requestId"
],
"properties": {
"data": {
"type": "object",
"properties": {
"side": {
"type": "string",
"enum": [
"claimant",
"respondent"
]
},
"termsDigest": {
"type": "string"
},
"acceptanceStatement": {
"type": "string"
},
"reviewPacket": {
"type": "object",
"additionalProperties": false,
"required": [
"schemaVersion",
"draftId",
"caseId",
"draftDigest",
"parties",
"agentOfRecord",
"preparingPartnerId",
"claimSummary",
"claimStatement",
"requestedItems",
"amount",
"rules",
"procedure",
"aiDisclosure",
"fees",
"requiredConfirmations",
"scope",
"expiresAt",
"termsDigest",
"acceptanceStatement",
"walletMessage"
],
"properties": {
"schemaVersion": {
"type": "string",
"const": "filing-review-packet-v1"
},
"draftId": {
"type": "string"
},
"caseId": {
"type": "string"
},
"draftDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"parties": {
"type": "object",
"additionalProperties": false,
"required": [
"claimant",
"respondent"
],
"properties": {
"claimant": {
"type": "object",
"additionalProperties": false,
"required": [
"principalId",
"name"
],
"properties": {
"principalId": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"respondent": {
"type": "object",
"additionalProperties": false,
"required": [
"principalId",
"name"
],
"properties": {
"principalId": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"agentOfRecord": {
"type": "string"
},
"preparingPartnerId": {
"type": "string"
},
"claimSummary": {
"type": "string"
},
"claimStatement": {
"type": "string"
},
"requestedItems": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"kind",
"text"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"refund",
"release",
"split",
"other",
"monetary",
"declaratory",
"order"
]
},
"text": {
"type": "string"
},
"amount": {
"$ref": "#/components/schemas/FiatMoney",
"type": "object",
"additionalProperties": false,
"required": [
"currency",
"minorUnits"
],
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"minorUnits": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,77})$"
}
}
}
}
}
},
"amount": {
"$ref": "#/components/schemas/FiatMoney",
"type": "object",
"additionalProperties": false,
"required": [
"currency",
"minorUnits"
],
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"minorUnits": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,77})$"
}
}
},
"rules": {
"type": "object",
"additionalProperties": false,
"required": [
"version",
"hash"
],
"properties": {
"version": {
"type": "string"
},
"hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
},
"procedure": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"finalityPath",
"configuration"
],
"properties": {
"name": {
"type": "string",
"enum": [
"standard",
"agent_only"
]
},
"finalityPath": {
"type": "string",
"enum": [
"human_appeal",
"agent_finality"
]
},
"configuration": {
"type": "object",
"additionalProperties": true
},
"agentFinalityTerms": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Exact registered Rules, behavior and disclosure tuple, including its termsHash."
}
}
},
"aiDisclosure": {
"type": "object",
"additionalProperties": false,
"required": [
"version",
"hash"
],
"properties": {
"version": {
"type": "string"
},
"hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
},
"fees": {
"type": "object",
"additionalProperties": true
},
"requiredConfirmations": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"side",
"principalId",
"required",
"statement"
],
"properties": {
"side": {
"type": "string",
"enum": [
"claimant",
"respondent"
]
},
"principalId": {
"type": "string"
},
"required": {
"type": "boolean"
},
"statement": {
"type": "string"
}
}
}
},
"scope": {
"type": "string"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"termsDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"acceptanceStatement": {
"type": "string"
},
"walletMessage": {
"type": "string"
}
}
}
},
"required": [
"side",
"termsDigest",
"acceptanceStatement",
"reviewPacket"
]
},
"requestId": {
"type": "string"
}
},
"x-code-source": "lib/api/agent-only-consent.ts"
}