XnY Protocol
ConceptsDeveloper
API ReferenceDatasets

Whether a DID can claim in this dataset, with the claim bundle

DID-keyed sibling of the per-CF endpoint, for a caller who holds a DID and no `cfId`. A claim is per-contributor, so the bundle is the contributor aggregate — identical to what the per-CF endpoint returns for any of that contributor's CFs in this dataset. `cfId` is omitted from the response, and the reason set differs — see `ClaimabilityReason`.

GET
/v1/datasets/{id}/claimability
/v1/datasets/{id}/claimability

Path Parameters

id
Required
string

The dataset version's 32-byte id.

Pattern: "^0[xX][0-9a-fA-F]{64}$"

Query Parameters

did
Required
string

Which contributor to report on. Accepts any of the four DID request forms.

curl -X GET "http://lineage-api.xny-staging.svc.cluster.local:8001/v1/datasets/0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41/claimability?did=string"

Claimability, whether or not the claim is possible.

{
  "cfId": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41",
  "datasetId": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41",
  "contributorDidId": "00000000-0000-0000-0000-0000000007d1",
  "claimable": true,
  "reason": "cf_not_found",
  "shareAmount": "string",
  "cfMerkleRoot": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41",
  "proof": [
    "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41"
  ],
  "ownershipBalance": "string",
  "hasClaimed": true,
  "proofStatus": "pending"
}

Last updated

Previous

Royalty distributions and claims, paginated independently

Next

Contribution fingerprints included in this dataset version