POSTlive

Issue a show-once respondent handoff

Issue a show-once respondent handoff Compatibility alias. Replacement: /api/cases/{id}/invitations. Preserve partner handoff body and show-once token semantics; same keyed rotation. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled.

/api/v2/cases/{caseId}/respondent-handoffissueRespondentHandoffV2

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

platformOrchestratorBearer

Credential bound to the platform_orchestrator role.

Parameters

NameLocationRequirementSchema
caseIdpathRequired{"type":"string"}
Idempotency-KeyheaderRequired{"type":"string","minLength":8,"maxLength":200}

Responses

201

Show-once respondent invite plus the exact EIP-191 consent message the respondent wallet must sign. The message binds this public caseId and contains no internal dispute identifier.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/RespondentHandoff",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "schemaVersion",
        "caseId",
        "answerPath",
        "consentMessage",
        "capabilityDelivery"
      ],
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "respondent-handoff-v2"
        },
        "caseId": {
          "type": "string"
        },
        "action": {
          "type": "string",
          "enum": [
            "file_answer",
            "accept_evaluation"
          ]
        },
        "actionPath": {
          "type": "string"
        },
        "answerPath": {
          "type": "string",
          "description": "Alias of actionPath for clients using Answer terminology."
        },
        "hostedRespondentPath": {
          "type": "string",
          "description": "Untokenized hosted login path for human respondents. Present for Answer handoffs, not evaluation acceptance."
        },
        "consentMessage": {
          "type": "string",
          "description": "Action statement associated with the handoff. For a hosted Answer it is the immutable clickthrough statement bound to the public case and opening draft; for a wallet Answer it is the EIP-191 message whose Case line is the public caseId; for evaluation acceptance it equals confirmationStatement."
        },
        "confirmationStatement": {
          "type": "string",
          "description": "Exact digest-bound statement required when accepting a claimant-proposed evaluation."
        },
        "evaluationDigest": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "capabilityDelivery": {
          "type": "string",
          "const": "show_once_not_replayed"
        },
        "showOnce": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "respondentInviteToken"
          ],
          "properties": {
            "respondentInviteToken": {
              "type": "string"
            },
            "respondentLoginPath": {
              "type": "string",
              "description": "Show-once tokenized hosted login path. Never returned by an idempotency replay."
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "description": "Account-readiness refusals include a value-free checklist and exact account-page link. Other error codes may provide different details.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/AccountReadinessDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ready",
            "accountSetupUrl",
            "missing"
          ],
          "properties": {
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/LegalDocumentsRequiredDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "legalDocumentsUrl"
          ],
          "properties": {
            "legalDocumentsUrl": {
              "type": "string",
              "format": "uri",
              "description": "Absolute account-page URL where the person reviews and accepts the current Terms and Privacy Notice. Uses the configured public application origin. After accepting the documents, retry the original operation."
            },
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}

Example response

Successful response

{
  "data": {
    "schemaVersion": "respondent-handoff-v2",
    "caseId": "pcase_test_123",
    "answerPath": "answerPath_test",
    "consentMessage": "consentMessage_test",
    "capabilityDelivery": "show_once_not_replayed"
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.
  • Send a unique Idempotency-Key. An exact retry returns the stored result; reusing the key with a different request fails.
  • The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.

Likely next action: File the respondent Answer when required →