Klineo/Docs
Open app ↗

API schemas

PartnerPortfolio

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
schemaVersion Yes Constant partner-portfolio-view-v2 —
partnerId Yes string Min length: 3; Max length: 160
partnerConfigurationResourceVersion Yes Hash —
partnerConfigurationArtifactHash Yes Hash —
brand Yes object Additional properties rejected
brand.name Yes string —
brand.reportBrandName Yes string —
brand.accentColor Yes string —
brand.verifiedDomains Yes Array of string —
issuers Yes Array of Exactly one of: object; object —
issuers[].oneOf[1].issuerOrganizationId Yes string Min length: 3; Max length: 160
issuers[].oneOf[1].availability Yes Constant AVAILABLE —
issuers[].oneOf[1].consentArtifactHash Yes Hash —
issuers[].oneOf[1].consentResourceVersion Yes Hash —
issuers[].oneOf[1].consentStatus Yes Constant ACTIVE —
issuers[].oneOf[1].consentExpiresAt Yes At least one of: string; null —
issuers[].oneOf[1].proposalPreparationScope Yes string Allowed: DECLARED, NOT_DECLARED
issuers[].oneOf[1].marketQuality Yes At least one of: object; object —
issuers[].oneOf[1].marketQuality.anyOf[1].score Yes integer Minimum: 0; Maximum: 100
issuers[].oneOf[1].marketQuality.anyOf[1].capturedAt Yes string Format: date-time
issuers[].oneOf[1].marketQuality.anyOf[1].coveragePips Yes Pips —
issuers[].oneOf[1].marketQuality.anyOf[1].artifactHash Yes Hash —
issuers[].oneOf[1].marketQuality.anyOf[2].availability Yes Constant UNAVAILABLE —
issuers[].oneOf[1].venueCount Yes integer Minimum: 0
issuers[].oneOf[1].proposals Yes Array of object —
issuers[].oneOf[1].proposals[].proposalId Yes string Min length: 3; Max length: 160
issuers[].oneOf[1].proposals[].title Yes string —
issuers[].oneOf[1].proposals[].status Yes OperatingSystemRecordStatus —
issuers[].oneOf[1].proposals[].expiresAt Yes string Format: date-time
issuers[].oneOf[1].proposals[].artifactHash Yes Hash —
issuers[].oneOf[2].issuerOrganizationId Yes string Min length: 3; Max length: 160
issuers[].oneOf[2].availability Yes Constant UNAVAILABLE_NO_BILATERAL_CONSENT —
generatedAt Yes string Format: date-time
custodyAuthorityGranted Yes Constant false —
crossIssuerMutationAuthorityGranted Yes Constant false —

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/PartnerPortfolio in the OpenAPI contract.