GETpartial

Project the existing Award finality authorized remedy and execution confirmation

Project the existing Award finality authorized remedy and execution confirmation. Canonical endpoint for the same role-bound partner credential operation. Account OAuth tokens do not substitute for partner credentials.

/api/ucp/resolution-results/{caseId}getUcpResolution

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.

claimantAgentBearer

Credential bound to the claimant_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header.

respondentAgentBearer

Credential bound to the respondent_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header.

readOnlyObserverBearer

Credential bound to the read_only_observer role and limited to operational projections.

Parameters

NameLocationRequirementSchema
caseIdpathRequired{"type":"string"}

Responses

200

Existing Award finality remedy and separate execution projection.

application/json

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ResolutionResultV1",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "schemaVersion",
        "authorizationId",
        "transactionId",
        "caseId",
        "externalCaseId",
        "awardReference",
        "review",
        "authorizedRemedy",
        "execution",
        "projectedAt"
      ],
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "resolution-result-v1"
        },
        "authorizationId": {
          "type": "string"
        },
        "transactionId": {
          "type": "string",
          "pattern": "^[A-Za-z0-9_-]{43}$"
        },
        "caseId": {
          "type": "string"
        },
        "externalCaseId": {
          "type": "string"
        },
        "awardReference": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "dispositionId",
                "awardRevision",
                "awardHash",
                "awardArtifactPath",
                "awardAttestationPath",
                "recordBundlePath"
              ],
              "properties": {
                "dispositionId": {
                  "type": "string"
                },
                "awardRevision": {
                  "type": "integer",
                  "minimum": 1
                },
                "awardHash": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                },
                "awardArtifactPath": {
                  "type": "string"
                },
                "awardAttestationPath": {
                  "type": "string"
                },
                "recordBundlePath": {
                  "type": "string"
                }
              }
            }
          ]
        },
        "review": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "decisionStatus",
            "finality",
            "appealEligible",
            "executionHeldByAppeal",
            "appealDeadlineAt"
          ],
          "properties": {
            "decisionStatus": {
              "type": "string",
              "enum": [
                "not_created",
                "under_review",
                "served"
              ]
            },
            "finality": {
              "type": "string",
              "enum": [
                "not_served",
                "served",
                "appealable",
                "appeal_reserved",
                "appeal_pending",
                "final"
              ]
            },
            "appealEligible": {
              "type": "boolean"
            },
            "executionHeldByAppeal": {
              "type": "boolean"
            },
            "appealDeadlineAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            }
          }
        },
        "authorizedRemedy": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "outcomeCode",
                "action",
                "currency",
                "amountMinorUnits",
                "allocations",
                "bindingDigest"
              ],
              "properties": {
                "outcomeCode": {
                  "type": "string"
                },
                "action": {
                  "type": "string",
                  "enum": [
                    "release_to_claimant",
                    "release_to_respondent",
                    "allocate_by_award",
                    "none"
                  ]
                },
                "currency": {
                  "type": "string",
                  "const": "USD"
                },
                "amountMinorUnits": {
                  "type": "string",
                  "pattern": "^[1-9][0-9]{0,77}$"
                },
                "allocations": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "recipient",
                      "principalId",
                      "amountMinorUnits"
                    ],
                    "properties": {
                      "recipient": {
                        "type": "string",
                        "enum": [
                          "claimant",
                          "respondent"
                        ]
                      },
                      "principalId": {
                        "type": "string"
                      },
                      "amountMinorUnits": {
                        "type": "string",
                        "pattern": "^(0|[1-9][0-9]{0,77})$"
                      }
                    }
                  }
                },
                "bindingDigest": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                }
              }
            }
          ]
        },
        "execution": {
          "description": "Separate from Award finality; failure never creates a confirmation or changes the Award.",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "status",
            "attemptReference",
            "operationReference",
            "confirmation",
            "failureCode"
          ],
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "not_ready",
                "not_requested",
                "prepared",
                "submitting",
                "validated",
                "manual_action_required",
                "callback_required",
                "completed",
                "failed",
                "blocked",
                "unknown_outcome"
              ]
            },
            "attemptReference": {
              "type": [
                "string",
                "null"
              ]
            },
            "operationReference": {
              "type": [
                "string",
                "null"
              ]
            },
            "confirmation": {
              "oneOf": [
                {
                  "type": "null"
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "providerId",
                    "adapter",
                    "receipt",
                    "receiptHash",
                    "confirmedAt"
                  ],
                  "properties": {
                    "providerId": {
                      "type": "string"
                    },
                    "adapter": {
                      "type": "string"
                    },
                    "receipt": {
                      "type": "object",
                      "additionalProperties": {
                        "type": "string"
                      }
                    },
                    "receiptHash": {
                      "type": "string",
                      "pattern": "^[a-f0-9]{64}$"
                    },
                    "confirmedAt": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              ]
            },
            "failureCode": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        },
        "projectedAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "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": "resolution-result-v1",
    "authorizationId": "authorizationId_test",
    "transactionId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "caseId": "pcase_test_123",
    "externalCaseId": "marketplace_case_123",
    "awardReference": null,
    "review": {
      "decisionStatus": "not_created",
      "finality": "not_served",
      "appealEligible": false,
      "executionHeldByAppeal": false,
      "appealDeadlineAt": null
    },
    "authorizedRemedy": null,
    "execution": {
      "status": "not_ready",
      "attemptReference": null,
      "operationReference": null,
      "confirmation": null,
      "failureCode": null
    },
    "projectedAt": "2026-08-09T12:00:00.000Z"
  },
  "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.