SDK Reference

@proveanything/smartlinks

npm install @proveanything/smartlinks

View on npm →

Namespaces

NFC, Proofs & Claims

proof

Create, update, claim, and list product proofs (digital certificates).

12 functions5 types

get

Retrieves a single Proof by Collection ID, Product ID, and Proof ID. Both public and admin endpoints now include productId in the path.

admin

get(collectionId: string,
    productId: string,
    proofId: string,
    admin?: boolean,
    include?: string[]) → Promise<>

list

List all Proofs for a Collection.

public

list(collectionId: string,
    include?: string[]) → Promise<[]>

create

Create a proof for a product (admin only). POST /admin/collection/:collectionId/product/:productId/proof

public

create(collectionId: string,
    productId: string,
    values: ) → Promise<>

update

Update a proof for a product (admin only). PUT /admin/collection/:collectionId/product/:productId/proof/:proofId

public

update(collectionId: string,
    productId: string,
    proofId: string,
    values: ) → Promise<>

claim

Claim a proof for a product using a proof ID (serial number, NFC tag, etc.). PUT /public/collection/:collectionId/product/:productId/proof/:proofId/claim

public

claim(collectionId: string,
    productId: string,
    proofId: string,
    values: ) → Promise<>

claimProduct

Claim a product without providing a proof ID. System auto-generates a unique serial number on-demand. Requires allowAutoGenerateClaims to be enabled on the collection or product. PUT /public/collection/:collectionId/product/:productId/proof/claim typescript const proof = await proof.claimProduct( 'beauty-brand', 'moisturizer-pro', { purchaseDate: '2026-02-17', store: 'Target' } ); console.log('Auto-generated ID:', proof.id);

public

claimProduct(collectionId: string,
    productId: string,
    values?: ) → Promise<>

remove

Delete a proof for a product (admin only). DELETE /admin/collection/:collectionId/product/:productId/proof/:proofId

public

remove(collectionId: string,
    productId: string,
    proofId: string) → Promise<void>

getByUser

Get proofs for a user in a collection (admin only). GET /admin/collection/:collectionId/proof/findByUser/:userId

public

getByUser(collectionId: string,
    userId: string) → Promise<[]>

getByProduct

Get proofs for a product (admin only). GET /admin/collection/:collectionId/product/:productId/proof

public

getByProduct(collectionId: string,
    productId: string) → Promise<[]>

findByProduct

Find proofs for a product (admin only). POST /admin/collection/:collectionId/product/:productId/proof/find

public

findByProduct(collectionId: string,
    productId: string,
    query: any) → Promise<[]>

getByBatch

Get proofs for a batch (admin only). GET /admin/collection/:collectionId/product/:productId/batch/:batchId/proof

public

getByBatch(collectionId: string,
    productId: string,
    batchId: string) → Promise<[]>

migrate

Migrate a proof to a different product within the same collection (admin only). Because the Firestore ledger document ID is {productId}-{proofId}, a proof cannot simply be re-assigned to another product by updating a field — the document must be re-keyed. This endpoint handles that atomically: 1. Reads the source ledger document ({sourceProductId}-{proofId}). 2. Writes a new document ({targetProductId}-{proofId}) with productId and proofGroup updated. The short proofId (nanoid) is unchanged. 3. Writes a migration history entry to the new document's history subcollection (snapshot of the original proof + migration metadata). 4. Copies all subcollections — assets, attestations, history — from the old document to the new one. 5. Deletes the old subcollections and then the old document. Repeated migrations are safe — each one appends a history record; no migration metadata is stored on the proof document itself. typescript const migrated = await proof.migrate('coll_123', 'prod_old', 'proof_abc', { targetProductId: 'prod_new', }) console.log(migrated.productId) // 'prod_new'

public

migrate(collectionId: string,
    productId: string,
    proofId: string,
    /** The destination product ID */
    data: { targetProductId: string }) → Promise<>