Skip to main content
GET
Read a policy by composite key

Path Parameters

productId
string
required

32-byte 0x-prefixed hex string (e.g. a productId or txHash).

Pattern: ^0x[0-9a-fA-F]{64}$
Example:

"0x0000000000000000000000000000000000000000000000000000000000000000"

policyId
string
required

A non-negative integer encoded as a decimal string (used for token amounts, prices, and other on-chain bigint values).

Pattern: ^\d+$
Example:

"1000000"

Response

Policy.

productId
string
required

32-byte 0x-prefixed hex string (e.g. a productId or txHash).

Pattern: ^0x[0-9a-fA-F]{64}$
Example:

"0x0000000000000000000000000000000000000000000000000000000000000000"

policyId
string
required

A non-negative integer encoded as a decimal string (used for token amounts, prices, and other on-chain bigint values).

Pattern: ^\d+$
Example:

"1000000"

shield
string
required

Ethereum 0x-prefixed checksummed or lowercase address.

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x0000000000000000000000000000000000000000"

buyer
string
required

Ethereum 0x-prefixed checksummed or lowercase address.

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x0000000000000000000000000000000000000000"

holder
string
required

Ethereum 0x-prefixed checksummed or lowercase address.

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x0000000000000000000000000000000000000000"

coverageAmount
string
required

A non-negative integer encoded as a decimal string (used for token amounts, prices, and other on-chain bigint values).

Pattern: ^\d+$
Example:

"1000000"

payoutAmount
string
required

A non-negative integer encoded as a decimal string (used for token amounts, prices, and other on-chain bigint values).

Pattern: ^\d+$
Example:

"1000000"

premiumPaid
string
required

USDC base units (6-dec).

Pattern: ^\d+$
Example:

"1000000"

createdAt
string
required

Unix seconds.

Pattern: ^\d+$
Example:

"1000000"

expiresAt
string
required

Unix seconds.

Pattern: ^\d+$
Example:

"1000000"

status
enum<string>
required
Available options:
Waiting,
Active,
Triggered,
Expired,
Cancelled
triggered
boolean
required
expired
boolean
required
productName
string

Human-readable name derived from PRODUCT_ID preimage.

purchasedAt
string

Unix seconds.

Pattern: ^\d+$
Example:

"1000000"

waitingEndsAt
string | null

Unix-seconds string when the waiting period ends, or null.

productActive
boolean
priceSnapshot
string

LUMINA/USD 18-dec snapshot at purchase. '0' for legacy V5.0 policies.

Pattern: ^\d+$
Example:

"1000000"

triggeredAt
string | null

Unix-seconds when triggered, or null.

bondId
string | null

BondVault epochId minted at trigger, or null.