File an ownership/share claim on a work

curl --request POST \
  --url https://api.royalti.io/work/works/{workId}/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "claimantWriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "claimedShares": {
    "pr": 123,
    "mr": 123,
    "sr": 123
  },
  "parentClaimId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "evidenceUrls": [
    "<string>"
  ]
}
'

import requests

url = "https://api.royalti.io/work/works/{workId}/claims"

payload = {
    "claimantWriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimedShares": {
        "pr": 123,
        "mr": 123,
        "sr": 123
    },
    "parentClaimId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "evidenceUrls": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    claimantWriterId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    claimedShares: {pr: 123, mr: 123, sr: 123},
    parentClaimId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    evidenceUrls: ['<string>']
  })
};

fetch('https://api.royalti.io/work/works/{workId}/claims', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/work/works/{workId}/claims",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'claimantWriterId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'claimedShares' => [
        'pr' => 123,
        'mr' => 123,
        'sr' => 123
    ],
    'parentClaimId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'evidenceUrls' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/work/works/{workId}/claims"

	payload := strings.NewReader("{\n  \"claimantWriterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"claimedShares\": {\n    \"pr\": 123,\n    \"mr\": 123,\n    \"sr\": 123\n  },\n  \"parentClaimId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"evidenceUrls\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.royalti.io/work/works/{workId}/claims")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"claimantWriterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"claimedShares\": {\n    \"pr\": 123,\n    \"mr\": 123,\n    \"sr\": 123\n  },\n  \"parentClaimId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"evidenceUrls\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/work/works/{workId}/claims")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"claimantWriterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"claimedShares\": {\n    \"pr\": 123,\n    \"mr\": 123,\n    \"sr\": 123\n  },\n  \"parentClaimId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"evidenceUrls\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": 123,
    "workId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimantWriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimedRole": "CA",
    "claimedShares": {
      "pr": 123,
      "mr": 123,
      "sr": 123
    },
    "claimType": "ownership",
    "status": "filed",
    "evidenceUrls": [
      "<string>"
    ],
    "resolution": {
      "decision": "approved",
      "reason": "<string>",
      "resolvedById": "<string>",
      "resolvedAt": "2023-11-07T05:31:56Z"
    },
    "parentClaimId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

POST

work

works

{workId}

claims

File an ownership/share claim on a work

curl --request POST \
  --url https://api.royalti.io/work/works/{workId}/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "claimantWriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "claimedShares": {
    "pr": 123,
    "mr": 123,
    "sr": 123
  },
  "parentClaimId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "evidenceUrls": [
    "<string>"
  ]
}
'

import requests

url = "https://api.royalti.io/work/works/{workId}/claims"

payload = {
    "claimantWriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimedShares": {
        "pr": 123,
        "mr": 123,
        "sr": 123
    },
    "parentClaimId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "evidenceUrls": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    claimantWriterId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    claimedShares: {pr: 123, mr: 123, sr: 123},
    parentClaimId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    evidenceUrls: ['<string>']
  })
};

fetch('https://api.royalti.io/work/works/{workId}/claims', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/work/works/{workId}/claims",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'claimantWriterId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'claimedShares' => [
        'pr' => 123,
        'mr' => 123,
        'sr' => 123
    ],
    'parentClaimId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'evidenceUrls' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/work/works/{workId}/claims"

	payload := strings.NewReader("{\n  \"claimantWriterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"claimedShares\": {\n    \"pr\": 123,\n    \"mr\": 123,\n    \"sr\": 123\n  },\n  \"parentClaimId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"evidenceUrls\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.royalti.io/work/works/{workId}/claims")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"claimantWriterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"claimedShares\": {\n    \"pr\": 123,\n    \"mr\": 123,\n    \"sr\": 123\n  },\n  \"parentClaimId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"evidenceUrls\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/work/works/{workId}/claims")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"claimantWriterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"claimedShares\": {\n    \"pr\": 123,\n    \"mr\": 123,\n    \"sr\": 123\n  },\n  \"parentClaimId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"evidenceUrls\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": 123,
    "workId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimantWriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimedRole": "CA",
    "claimedShares": {
      "pr": 123,
      "mr": 123,
      "sr": 123
    },
    "claimType": "ownership",
    "status": "filed",
    "evidenceUrls": [
      "<string>"
    ],
    "resolution": {
      "decision": "approved",
      "reason": "<string>",
      "resolvedById": "<string>",
      "resolvedAt": "2023-11-07T05:31:56Z"
    },
    "parentClaimId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /work/works//claims Description: Files a WriterClaim (Phase 5). Caller must be an admin/owner OR the writer identified by claimantWriterId must actually be linked to the work (403 otherwise). New claims start in filed status. Supports an Idempotency-Key header (routeKey p5.claim.file) — a replayed key with an IDENTICAL body returns the original response; the same key with a DIFFERENT body returns 409. This endpoint only covers work-scoped filing/listing; the full claim lifecycle (transition, messages, evidence, bulk-resolve) lives under /publishing/claims (see publishing-claims.yaml). Authorization:

Required role: user or higher

Method: POST

Code Examples

const response = await fetch('https://api.royalti.io/work/works/{workId}/claims', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ref": "#/components/schemas/FileClaimRequest"
  })
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
  'https://api.royalti.io/work/works/{workId}/claims',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/FileClaimRequest"}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/work/works/{workId}/claims \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/FileClaimRequest"}'

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Headers

Idempotency-Key

string

Path Parameters

workId

string<uuid>

required

Body

application/json

Caller must be an admin/owner on the tenant OR the writer named by claimantWriterId must actually be linked to the work — otherwise a 403. New claims always start in filed status.

claimantWriterId

string<uuid>

required

claimedRole

enum<string>

required

Available options:

CA,

C,

A,

AR,

SA,

SR,

TR,

PA

claimType

enum<string>

required

Available options:

ownership,

share_dispute,

registration_conflict,

metadata

claimedShares

object

Show child attributes

parentClaimId

string<uuid> | null

evidenceUrls

string[]

Response

Claim filed

status

string

Example:

"success"

data

object

Ownership/share/metadata dispute filed against a work. Full claim lifecycle (transition, messages, evidence, bulk-resolve) is documented separately under publishing-claims.yaml; only the two work-scoped routes (file, list-for-work) live under /work.

Show child attributes

​Description

​Code Examples

Authorizations

Headers

Path Parameters

Body

Response

Description

Code Examples