Register an uploaded evidence file on a claim

curl --request POST \
  --url https://api.royalti.io/publishing/claims/{id}/evidence/attach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileKey": "claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf",
  "fileName": "split-sheet-signed.pdf",
  "mimeType": "application/pdf",
  "size": 184320
}
'

import requests

url = "https://api.royalti.io/publishing/claims/{id}/evidence/attach"

payload = {
    "fileKey": "claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf",
    "fileName": "split-sheet-signed.pdf",
    "mimeType": "application/pdf",
    "size": 184320
}
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({
    fileKey: 'claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf',
    fileName: 'split-sheet-signed.pdf',
    mimeType: 'application/pdf',
    size: 184320
  })
};

fetch('https://api.royalti.io/publishing/claims/{id}/evidence/attach', 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/publishing/claims/{id}/evidence/attach",
  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([
    'fileKey' => 'claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf',
    'fileName' => 'split-sheet-signed.pdf',
    'mimeType' => 'application/pdf',
    'size' => 184320
  ]),
  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/publishing/claims/{id}/evidence/attach"

	payload := strings.NewReader("{\n  \"fileKey\": \"claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf\",\n  \"fileName\": \"split-sheet-signed.pdf\",\n  \"mimeType\": \"application/pdf\",\n  \"size\": 184320\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/publishing/claims/{id}/evidence/attach")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileKey\": \"claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf\",\n  \"fileName\": \"split-sheet-signed.pdf\",\n  \"mimeType\": \"application/pdf\",\n  \"size\": 184320\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publishing/claims/{id}/evidence/attach")

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  \"fileKey\": \"claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf\",\n  \"fileName\": \"split-sheet-signed.pdf\",\n  \"mimeType\": \"application/pdf\",\n  \"size\": 184320\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": {}
}

POST

publishing

claims

{id}

evidence

attach

curl --request POST \
  --url https://api.royalti.io/publishing/claims/{id}/evidence/attach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileKey": "claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf",
  "fileName": "split-sheet-signed.pdf",
  "mimeType": "application/pdf",
  "size": 184320
}
'

import requests

url = "https://api.royalti.io/publishing/claims/{id}/evidence/attach"

payload = {
    "fileKey": "claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf",
    "fileName": "split-sheet-signed.pdf",
    "mimeType": "application/pdf",
    "size": 184320
}
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({
    fileKey: 'claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf',
    fileName: 'split-sheet-signed.pdf',
    mimeType: 'application/pdf',
    size: 184320
  })
};

fetch('https://api.royalti.io/publishing/claims/{id}/evidence/attach', 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/publishing/claims/{id}/evidence/attach",
  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([
    'fileKey' => 'claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf',
    'fileName' => 'split-sheet-signed.pdf',
    'mimeType' => 'application/pdf',
    'size' => 184320
  ]),
  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/publishing/claims/{id}/evidence/attach"

	payload := strings.NewReader("{\n  \"fileKey\": \"claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf\",\n  \"fileName\": \"split-sheet-signed.pdf\",\n  \"mimeType\": \"application/pdf\",\n  \"size\": 184320\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/publishing/claims/{id}/evidence/attach")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileKey\": \"claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf\",\n  \"fileName\": \"split-sheet-signed.pdf\",\n  \"mimeType\": \"application/pdf\",\n  \"size\": 184320\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publishing/claims/{id}/evidence/attach")

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  \"fileKey\": \"claims-evidence/19/1b1b1b1b-1111-4111-8111-111111111111/1720000000000-split-sheet-signed.pdf\",\n  \"fileName\": \"split-sheet-signed.pdf\",\n  \"mimeType\": \"application/pdf\",\n  \"size\": 184320\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": {}
}

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

Description

POST /publishing/claims//evidence/attach Description: Companion to POST /publishing/claims/{id}/evidence — after the client’s signed PUT to GCS succeeds, call this to append the file to the claim’s evidenceUrls array and record a system message. fileKey must fall under the tenant+claim-scoped prefix returned by the evidence endpoint. Idempotent on fileKey — repeat calls with the same key return the claim unchanged, no duplicate row. Supports the Idempotency-Key header (route key p5.claim.evidence-attach). Authorization:

RBAC: user or higher; claimant-or-admin check enforced in the service
Requires an active publisher addon

Method: POST

Code Examples

const response = await fetch('https://api.royalti.io/publishing/claims/example-id/evidence/attach', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "fileKey": "sample-fileKey",
    "fileName": "sample-fileName",
    "mimeType": "sample-mimeType",
    "size": 1
  })
});

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

import requests

response = requests.post(
  'https://api.royalti.io/publishing/claims/example-id/evidence/attach',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"fileKey":"sample-fileKey","fileName":"sample-fileName","mimeType":"sample-mimeType","size":1}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/publishing/claims/example-id/evidence/attach \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"fileKey":"sample-fileKey","fileName":"sample-fileName","mimeType":"sample-mimeType","size":1}'

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string

Path Parameters

string<uuid>

required

Body

application/json

fileKey

string

required

Must start with claims-evidence/{tenantId}/{claimId}/ — the prefix returned by the evidence endpoint.

fileName

string

required

mimeType

string

required

size

integer

required

Bytes. Must not exceed 25 MB (26214400).

Response

Evidence attached (or already-attached claim returned unchanged)

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