Complete a claim after the user creates their canonical record in their PDS. Requires authentication and claimant ownership.
Parameters
Output
Encoding
application/jsonsuccess
boolean
Required
Whether the claim was successfully completed
Errors
AuthenticationRequired
Authentication is required to complete claims ClaimNotFound
The specified claim does not exist Unauthorized
Only the claimant can complete their own claim Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "procedure",
"errors": [
{
"name": "AuthenticationRequired",
"description": "Authentication is required to complete claims"
},
{
"name": "ClaimNotFound",
"description": "The specified claim does not exist"
},
{
"name": "Unauthorized",
"description": "Only the claimant can complete their own claim"
}
],
"output": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"description": "Whether the claim was successfully completed"
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"required": [
"claimId",
"canonicalUri"
],
"properties": {
"claimId": {
"type": "integer",
"minimum": 1,
"description": "ID of the claim request to complete"
},
"canonicalUri": {
"type": "string",
"format": "at-uri",
"description": "AT-URI of the canonical record created in user's PDS"
}
}
},
"description": "Complete a claim after the user creates their canonical record in their PDS. Requires authentication and claimant ownership."
}