Klineo/Docs
Open app ↗

API schemas

LiquidityPassport

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
passportVersion Yes Constant liquidity-passport-v1 —
artifactRendererVersion Yes string Allowed: liquidity-passport-artifacts-v1, liquidity-passport-artifacts-v2
signatureAlgorithm Yes Constant Ed25519 —
signerProviderId Yes string —
signerKeyResourceVersion Yes Hash —
slug Yes string —
vaultId Yes string —
issuerName Yes string —
reportBrand No object Additional properties rejected
reportBrand.partnerId Yes string —
reportBrand.name Yes string —
reportBrand.accentColor Yes string Pattern: ^#[0-9a-fA-F]{6}$
reportBrand.logoContentHash No Hash —
reportBrand.sourceBinding No object Additional properties rejected
reportBrand.sourceBinding.partnerOrganizationId Yes string —
reportBrand.sourceBinding.partnerConfigurationResourceVersion Yes Hash —
reportBrand.sourceBinding.partnerConfigurationArtifactHash Yes Hash —
reportBrand.sourceBinding.consentId Yes string —
reportBrand.sourceBinding.consentResourceVersion Yes Hash —
reportBrand.sourceBinding.consentArtifactHash Yes Hash —
generatedAt Yes string Format: date-time
validUntil Yes string Format: date-time
marketQualityScore Yes MarketQualityScore —
usableDepthByTradeSize Yes Array of object Min items: 1
usableDepthByTradeSize[].tradeSizeQuote Yes AtomicAmount —
usableDepthByTradeSize[].buySlippagePips Yes Pips —
usableDepthByTradeSize[].sellSlippagePips Yes Pips —
historicalReliabilityPips Yes Pips —
policyCompliancePips Yes At least one of: Pips; null —
policyLimits No object Additional properties rejected
policyLimits.level Yes integer Allowed: 0, 1, 2, 3, 4
policyLimits.maximumAmountPerTransaction Yes AtomicAmount —
policyLimits.maximumDailyTurnover Yes AtomicAmount —
policyLimits.maximumSlippagePips Yes Pips —
policyLimits.approvedContracts Yes Array of Address Max items: 256
policyLimits.approvedAssets Yes Array of Address Max items: 256
policyLimits.approvedAdapterIds Yes Array of string Max items: 256
policyLimits.minimumSecondsBetweenActions Yes integer Minimum: 0; Maximum: 31536000
policyLimits.minimumPriceX18 No AtomicAmount —
policyLimits.maximumPriceX18 No AtomicAmount —
policyLimits.oracleMaximumAgeSeconds Yes integer Minimum: 1; Maximum: 86400
policyLimits.expiresAt Yes string Format: date-time
policyLimits.controlEpoch Yes AtomicAmount —
policyLimits.publicMempoolFallbackAllowed Yes boolean —
reconciledPositionCount Yes integer Minimum: 0
majorIncidentCount Yes integer Minimum: 0
treasuryOwnedLiquidityQuote No AtomicAmount —
rentedLiquidityQuote No AtomicAmount —
incidentDetails No object Additional properties rejected
incidentDetails.v1IncidentEvidenceHashes Yes Array of Hash Max items: 256
incidentDetails.anomalies Yes Array of object Max items: 256
incidentDetails.anomalies[].detectorVersion Yes Constant robust-mad-v1 —
incidentDetails.anomalies[].kind Yes string Allowed: LIQUIDITY_DISAPPEARANCE, ONE_SIDED_FLOW, INACTIVE_RANGE, STABLECOIN_DEPEG, ORACLE_DISAGREEMENT, INVENTORY_ACCUMULATION, EXCESSIVE_TURNOVER, MANIPULATION_INDICATOR, SIMULATED_REALIZED_DIVERGENCE
incidentDetails.anomalies[].severity Yes string Allowed: INFO, WARNING, CRITICAL
incidentDetails.anomalies[].artifactHash Yes Hash —
externalManagerExposureQuote No AtomicAmount —
externalManagerNames No Array of string —
dataFreshnessSeconds Yes integer Minimum: 0
disclosure Yes object Additional properties rejected
disclosure.showTreasuryOwnership Yes boolean —
disclosure.showExternalManagerNames Yes boolean —
disclosure.showIncidentDetails Yes boolean —
disclosure.showPolicyLimits Yes boolean —
reportHashes Yes Array of Hash Min items: 1; Max items: 128
sourceBindings Yes LiquidityPassportSourceBindings —
resultsRegistryProviderId No string —
resultsRegistryProviderResourceVersion No Hash —
resultsRegistryProviderAttestationHash No Hash —
resultsRegistryCommitmentHash No Hash —
resultsRegistryReceipt No object Additional properties rejected
resultsRegistryReceipt.receiptVersion Yes Constant liquidity-passport-results-registry-receipt-v1 —
resultsRegistryReceipt.providerId Yes string —
resultsRegistryReceipt.providerResourceVersion Yes Hash —
resultsRegistryReceipt.providerAttestationHash Yes Hash —
resultsRegistryReceipt.passportSubjectHash Yes Hash —
resultsRegistryReceipt.commitmentHash Yes Hash —
resultsRegistryReceipt.issuedAt Yes string Format: date-time
resultsRegistryReceipt.signature Yes string Content encoding: base64
supersedesPassportHash No Hash —
contentHash Yes Hash —
signature Yes string Content encoding: base64

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: #/components/schemas/LiquidityPassport in the OpenAPI contract.