Proofs API

10 endpoints

Product proof generation and verification.

GET

Auth Required

Get proofs for a product (admin only).

Endpoint

/admin/collection/{collectionId}/product/{productId}/batch/{batchId}/proof

Parameters

collectionId

path

string

Required

productId

path

string

Required

batchId

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found

GET

Auth Required

Delete a proof for a product (admin only).

Endpoint

/admin/collection/{collectionId}/product/{productId}/proof

Parameters

collectionId

path

string

Required

productId

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found

POST

Auth Required

List all Proofs for a Collection.

Endpoint

/admin/collection/{collectionId}/product/{productId}/proof

Parameters

collectionId

path

string

Required

productId

path

string

Required

body

body

ProofCreateRequest

Required

See ProofCreateRequest schema

Responses

200

Success

{
  "schema": "ProofResponse"
}

400

Bad request

401

Unauthorized

404

Not found

POST

Auth Required

Get proofs for a user in a collection (admin only).

Endpoint

/admin/collection/{collectionId}/product/{productId}/proof/find

Parameters

collectionId

path

string

Required

productId

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found

PUT

Auth Required

Create a proof for a product (admin only).

Endpoint

/admin/collection/{collectionId}/product/{productId}/proof/{proofId}

Parameters

collectionId

path

string

Required

productId

path

string

Required

proofId

path

string

Required

body

body

ProofUpdateRequest

Required

See ProofUpdateRequest schema

Responses

200

Success

{
  "schema": "ProofResponse"
}

400

Bad request

401

Unauthorized

404

Not found

DELETE

Auth Required

Delete a proof for a product (admin only).

Endpoint

/admin/collection/{collectionId}/product/{productId}/proof/{proofId}

Parameters

collectionId

path

string

Required

productId

path

string

Required

proofId

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found

GET

Auth Required

Delete a proof for a product (admin only).

Endpoint

/admin/collection/{collectionId}/proof/findByUser/{userId}

Parameters

collectionId

path

string

Required

userId

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found

PUT

Auth Required

Claim a product without providing a proof ID.

Endpoint

/public/collection/{collectionId}/product/{productId}/proof/claim

Parameters

collectionId

path

string

Required

productId

path

string

Required

body

body

ProofClaimRequest

Required

See ProofClaimRequest schema

Responses

200

Success

{
  "schema": "ProofResponse"
}

400

Bad request

401

Unauthorized

404

Not found

PUT

Auth Required

Update a proof for a product (admin only).

Endpoint

/public/collection/{collectionId}/product/{productId}/proof/{proofId}/claim

Parameters

collectionId

path

string

Required

productId

path

string

Required

proofId

path

string

Required

body

body

ProofClaimRequest

Required

See ProofClaimRequest schema

Responses

200

Success

{
  "schema": "ProofResponse"
}

400

Bad request

401

Unauthorized

404

Not found

GET

Auth Required

Retrieves a single Proof by Collection ID, Product ID, and Proof ID.

Endpoint

/public/collection/{collectionId}/proof{qp}

Parameters

collectionId

path

string

Required

qp

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found