Schemas
Reusable definitions exposed by the product OpenAPI contract.
DatasetMeta
{
"type": "object",
"additionalProperties": false,
"required": [
"apiVersion",
"knowledgeAsOf",
"effectiveAsOf",
"payloadSha256",
"coverage"
],
"properties": {
"apiVersion": {
"type": "string",
"const": "wealth-api-v1"
},
"knowledgeAsOf": {
"type": "string"
},
"effectiveAsOf": {
"type": [
"string",
"null"
]
},
"payloadSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"coverage": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"domain",
"status"
],
"properties": {
"domain": {
"type": "string",
"enum": [
"bb",
"cp",
"siw"
]
},
"status": {
"type": "string",
"enum": [
"admitted",
"runtime-not-loaded"
]
}
}
}
}
}
}ErrorResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"additionalProperties": false,
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"enum": [
"invalid_request",
"method_not_allowed",
"unauthenticated",
"forbidden",
"rate_limited",
"not_found",
"service_unavailable",
"internal_error"
]
},
"message": {
"type": "string"
}
}
}
}
}FinancialEvent
{
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"recordId",
"eventType",
"balanceSheetRole",
"measures",
"effectiveAt",
"version",
"sources"
],
"properties": {
"kind": {
"type": "string",
"const": "financial-event"
},
"recordId": {
"type": "string"
},
"eventType": {
"type": "string"
},
"balanceSheetRole": {
"type": "string"
},
"measures": {
"type": "array",
"items": {
"type": "object"
}
},
"effectiveAt": {
"type": [
"string",
"null"
]
},
"version": {
"$ref": "#/components/schemas/Version"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Source"
}
}
}
}HistoryRecord
{
"oneOf": [
{
"$ref": "#/components/schemas/Ownership"
},
{
"$ref": "#/components/schemas/WealthEstimate"
},
{
"$ref": "#/components/schemas/WealthComponent"
},
{
"$ref": "#/components/schemas/Valuation"
},
{
"$ref": "#/components/schemas/FinancialEvent"
}
]
}HistoryResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"person",
"records"
],
"properties": {
"person": {
"$ref": "#/components/schemas/Person"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryRecord"
}
}
}
},
"pagination": {
"type": "object",
"additionalProperties": false,
"required": [
"limit",
"offset",
"total",
"hasMore"
],
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 500
},
"offset": {
"type": "integer",
"minimum": 0
},
"total": {
"type": "integer",
"minimum": 0
},
"hasMore": {
"type": "boolean"
}
}
},
"meta": {
"$ref": "#/components/schemas/DatasetMeta"
}
}
}Ownership
{
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"recordId",
"ownerId",
"ownedAsset",
"ownershipKind",
"relationshipState",
"percentage",
"quantity",
"effectiveAt",
"version",
"sources"
],
"properties": {
"kind": {
"type": "string",
"const": "ownership"
},
"recordId": {
"type": "string"
},
"ownerId": {
"type": "string"
},
"ownedAsset": {
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"id"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"organization",
"security",
"asset"
]
},
"id": {
"type": "string"
}
}
},
"ownershipKind": {
"type": "string"
},
"relationshipState": {
"type": "string"
},
"percentage": {
"type": [
"number",
"null"
]
},
"quantity": {
"type": [
"object",
"null"
]
},
"effectiveAt": {
"type": [
"string",
"null"
]
},
"version": {
"$ref": "#/components/schemas/Version"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Source"
}
}
}
}OwnershipResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"person",
"ownership"
],
"properties": {
"person": {
"$ref": "#/components/schemas/Person"
},
"ownership": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Ownership"
}
}
}
},
"meta": {
"$ref": "#/components/schemas/DatasetMeta"
}
}
}PeopleSearchResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"search",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"people"
],
"properties": {
"people": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"search": {
"type": "object",
"additionalProperties": false,
"required": [
"query",
"limit",
"total",
"hasMore"
],
"properties": {
"query": {
"type": "string"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 25
},
"total": {
"type": "integer",
"minimum": 0
},
"hasMore": {
"type": "boolean"
}
}
},
"meta": {
"$ref": "#/components/schemas/DatasetMeta"
}
}
}Person
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"graphKey",
"label",
"correctionsUrl"
],
"properties": {
"id": {
"type": "string"
},
"graphKey": {
"type": "string",
"pattern": "^person:"
},
"label": {
"type": "string"
},
"correctionsUrl": {
"type": "string",
"format": "uri",
"description": "Public correction channel for identity or data issues on this person record."
}
}
}PersonResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"person",
"current"
],
"properties": {
"person": {
"$ref": "#/components/schemas/Person"
},
"current": {
"type": "object",
"additionalProperties": false,
"required": [
"estimates",
"ownership",
"components",
"valuations"
],
"properties": {
"estimates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WealthEstimate"
}
},
"ownership": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Ownership"
}
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WealthComponent"
}
},
"valuations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Valuation"
}
}
}
}
}
},
"meta": {
"$ref": "#/components/schemas/DatasetMeta"
}
}
}Scenario
{
"type": "object",
"additionalProperties": false,
"required": [
"bear",
"base",
"bull"
],
"properties": {
"bear": {
"type": [
"number",
"null"
]
},
"base": {
"type": [
"number",
"null"
]
},
"bull": {
"type": [
"number",
"null"
]
}
}
}Source
{
"type": "object",
"additionalProperties": false,
"required": [
"sourceId",
"publisher",
"title",
"locator",
"publishedAt"
],
"properties": {
"sourceId": {
"type": "string"
},
"publisher": {
"type": "string"
},
"title": {
"type": "string"
},
"locator": {
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"value"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"url",
"sec-accession",
"unavailable"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
},
"publishedAt": {
"type": [
"string",
"null"
]
}
}
}Valuation
{
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"recordId",
"objectId",
"value",
"currency",
"valuationMethod",
"effectiveAt",
"version",
"sources"
],
"properties": {
"kind": {
"type": "string",
"const": "valuation"
},
"recordId": {
"type": "string"
},
"objectId": {
"type": "string"
},
"value": {
"type": [
"number",
"string"
]
},
"currency": {
"type": "string"
},
"valuationMethod": {
"type": [
"string",
"null"
]
},
"effectiveAt": {
"type": [
"string",
"null"
]
},
"version": {
"$ref": "#/components/schemas/Version"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Source"
}
}
}
}Version
{
"type": "object",
"additionalProperties": false,
"required": [
"versionId",
"lineageId",
"knowledgeRecordedAt",
"knowledgeValidFrom",
"knowledgeValidThrough",
"changeKind"
],
"properties": {
"versionId": {
"type": "string"
},
"lineageId": {
"type": "string"
},
"knowledgeRecordedAt": {
"type": "string"
},
"knowledgeValidFrom": {
"type": "string"
},
"knowledgeValidThrough": {
"type": [
"string",
"null"
]
},
"changeKind": {
"type": "string",
"enum": [
"initial",
"update",
"correction",
"supersession"
]
}
}
}WealthComponent
{
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"recordId",
"componentKind",
"assetClass",
"objectId",
"scenario",
"currency",
"valuationMethod",
"effectiveAt",
"version",
"sources"
],
"properties": {
"kind": {
"type": "string",
"const": "wealth-component"
},
"recordId": {
"type": "string"
},
"componentKind": {
"type": "string"
},
"assetClass": {
"type": "string"
},
"objectId": {
"type": [
"string",
"null"
]
},
"scenario": {
"$ref": "#/components/schemas/Scenario"
},
"currency": {
"type": "string"
},
"valuationMethod": {
"type": [
"string",
"null"
]
},
"effectiveAt": {
"type": [
"string",
"null"
]
},
"version": {
"$ref": "#/components/schemas/Version"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Source"
}
}
}
}WealthEstimate
{
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"recordId",
"estimateKind",
"scenario",
"currency",
"confidence",
"methodologyVersion",
"effectiveAt",
"version",
"sources"
],
"properties": {
"kind": {
"type": "string",
"const": "wealth-estimate"
},
"recordId": {
"type": "string"
},
"estimateKind": {
"type": "string"
},
"scenario": {
"$ref": "#/components/schemas/Scenario"
},
"currency": {
"type": "string"
},
"confidence": {
"type": [
"number",
"null"
]
},
"methodologyVersion": {
"type": "string"
},
"effectiveAt": {
"type": [
"string",
"null"
]
},
"version": {
"$ref": "#/components/schemas/Version"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Source"
}
}
}
}