pub.chive.claiming.completeClaim

{
  "description": "Complete a claim after the user creates their canonical record in their PDS. Requires authentication and claimant ownership.",
  "errors": [
    {
      "description": "Authentication is required to complete claims",
      "name": "AuthenticationRequired"
    },
    {
      "description": "The specified claim does not exist",
      "name": "ClaimNotFound"
    },
    {
      "description": "Only the claimant can complete their own claim",
      "name": "Unauthorized"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "success": {
          "description": "Whether the claim was successfully completed",
          "type": "boolean"
        }
      },
      "required": [
        "success"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "canonicalUri": {
        "description": "AT-URI of the canonical record created in user's PDS",
        "format": "at-uri",
        "type": "string"
      },
      "claimId": {
        "description": "ID of the claim request to complete",
        "minimum": 1,
        "type": "integer"
      }
    },
    "required": [
      "claimId",
      "canonicalUri"
    ],
    "type": "params"
  },
  "type": "procedure"
}