XnY Protocol
ConceptsDeveloper
API ReferenceDatasets

Whether a CF's contributor can claim, with the claim bundle

Answers for the contributor who authored `cfId`. A blocked claim is a **200** carrying a `reason`; see the `Claimability` schema. Unlike the proof endpoint this never returns 409 — a pending proof surfaces as `reason: proof_pending` instead.

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

Path Parameters

id
Required
string

The dataset version's 32-byte id.

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

cfId
Required
string

The contribution fingerprint's 32-byte id. Note the spelling: the nested dataset routes use {cfId} while the top-level /v1/cfs routes use {cf_id} for the same value — see CfIdParam.

Pattern: "^0[xX][0-9a-fA-F]{64}$"
curl -X GET "http://lineage-api.xny-staging.svc.cluster.local:8001/v1/datasets/0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41/cf/0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41/claimability"

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

Tasks, newest first

Next

Two-layer Merkle proof for a CF in a dataset