Schemas
Reusable definitions exposed by the product OpenAPI contract.
AircraftChangeDiff
{
"type": "object",
"additionalProperties": false,
"required": [
"field",
"before",
"after"
],
"properties": {
"field": {
"type": "string",
"enum": [
"aircraft_assignment",
"registration_identifier",
"aircraft_model",
"engine_model",
"manufacture_year",
"aircraft_type",
"engine_type",
"registration_status",
"mode_s_code",
"certificate_issue_date",
"expiration_date",
"last_activity_date",
"airworthiness_date",
"fractional_ownership",
"registrant_type"
]
},
"before": {
"$ref": "#/components/schemas/AircraftChangeDiffSide"
},
"after": {
"$ref": "#/components/schemas/AircraftChangeDiffSide"
}
}
}AircraftChangeDiffSide
{
"type": "object",
"additionalProperties": false,
"required": [
"available",
"value"
],
"properties": {
"available": {
"type": "boolean",
"description": "Whether a matching retained public version exists on this side of the observed change. false is distinct from an available retained value that is itself null."
},
"value": {
"$ref": "#/components/schemas/AircraftChangeDiffValue"
}
}
}AircraftChangeDiffValue
{
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"modeSCodeOctal",
"modeSCodeHex"
],
"properties": {
"modeSCodeOctal": {
"type": [
"string",
"null"
]
},
"modeSCodeHex": {
"type": [
"string",
"null"
]
}
}
}
]
}AircraftChangeFeedItem
{
"type": "object",
"additionalProperties": false,
"required": [
"event",
"diffs"
],
"properties": {
"event": {
"$ref": "#/components/schemas/HistoryEvent"
},
"diffs": {
"type": "array",
"description": "Privacy-safe before/after values for the subset of changedFields supported by retained public versions. Historical make/model descriptions are intentionally not reconstructed from current reference data, and sensitive registrant values never appear here.",
"items": {
"$ref": "#/components/schemas/AircraftChangeDiff"
}
}
}
}AircraftChangeFeedPagination
{
"type": "object",
"additionalProperties": false,
"required": [
"limit",
"nextCursor"
],
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"nextCursor": {
"type": [
"string",
"null"
],
"maxLength": 2048
}
}
}AircraftChangeFeedResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"window",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AircraftChangeFeedItem"
}
},
"window": {
"$ref": "#/components/schemas/AircraftChangeFeedWindow"
},
"pagination": {
"$ref": "#/components/schemas/AircraftChangeFeedPagination"
}
}
}AircraftChangeFeedWindow
{
"type": "object",
"additionalProperties": false,
"required": [
"since",
"until",
"eventType"
],
"properties": {
"since": {
"type": "string",
"format": "date-time"
},
"until": {
"type": "string",
"format": "date-time"
},
"eventType": {
"type": [
"string",
"null"
],
"enum": [
"registration_added",
"registration_removed",
"registration_record_changed",
"aircraft_assignment_changed",
"status_changed",
"registrant_changed",
"registrant_pii_withheld",
"registrant_pii_released",
null
]
}
}
}AircraftChangeReportDefinition
{
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"query"
],
"properties": {
"kind": {
"type": "string",
"const": "change_feed"
},
"query": {
"type": "object",
"additionalProperties": false,
"required": [
"since",
"until",
"eventType"
],
"properties": {
"since": {
"type": "string",
"format": "date-time"
},
"until": {
"type": "string",
"format": "date-time"
},
"eventType": {
"type": [
"string",
"null"
],
"enum": [
"registration_added",
"registration_removed",
"registration_record_changed",
"aircraft_assignment_changed",
"status_changed",
"registrant_changed",
"registrant_pii_withheld",
"registrant_pii_released",
null
]
}
}
}
}
}AircraftCurrentRecord
{
"type": "object",
"additionalProperties": false,
"required": [
"contractVersion",
"aircraftId",
"registration",
"aircraft",
"registrant",
"source",
"history"
],
"properties": {
"contractVersion": {
"type": "string",
"const": "aircraft-public-v1"
},
"aircraftId": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"registration": {
"$ref": "#/components/schemas/Registration"
},
"aircraft": {
"$ref": "#/components/schemas/CurrentAircraft"
},
"registrant": {
"$ref": "#/components/schemas/Registrant"
},
"source": {
"$ref": "#/components/schemas/SourceSnapshot"
},
"history": {
"$ref": "#/components/schemas/HistorySummary"
}
}
}AircraftCurrentResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AircraftCurrentRecord"
}
}
}AircraftDiscoveryPagination
{
"type": "object",
"additionalProperties": false,
"required": [
"limit",
"nextCursor"
],
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"nextCursor": {
"type": [
"string",
"null"
],
"maxLength": 1024
}
}
}AircraftDiscoveryRecord
{
"type": "object",
"additionalProperties": false,
"required": [
"contractVersion",
"aircraftId",
"nNumber",
"sourceRegistrationStatusCode",
"serialNumber",
"manufactureYear",
"manufacturer",
"model",
"registrantState"
],
"properties": {
"contractVersion": {
"type": "string",
"const": "aircraft-discovery-v1"
},
"aircraftId": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"nNumber": {
"type": "string"
},
"sourceRegistrationStatusCode": {
"type": [
"string",
"null"
]
},
"serialNumber": {
"type": [
"string",
"null"
]
},
"manufactureYear": {
"type": [
"integer",
"null"
]
},
"manufacturer": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"registrantState": {
"type": [
"string",
"null"
]
}
}
}AircraftDiscoveryResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AircraftDiscoveryRecord"
}
},
"pagination": {
"$ref": "#/components/schemas/AircraftDiscoveryPagination"
}
}
}AircraftExportCreateInput
{
"type": "object",
"additionalProperties": false,
"required": [
"format"
],
"properties": {
"format": {
"type": "string",
"enum": [
"csv",
"json",
"xlsx"
]
},
"reportId": {
"type": [
"string",
"null"
],
"pattern": "^arp_[a-f0-9]{24}$"
},
"definition": {
"oneOf": [
{
"$ref": "#/components/schemas/AircraftSavedReportDefinition"
},
{
"type": "null"
}
]
}
},
"description": "Supply exactly one of reportId or definition."
}AircraftExportCreateResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"limits"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AircraftExportRun"
},
"limits": {
"type": "object",
"additionalProperties": false,
"required": [
"monthlyExportRunLimit",
"exportRowLimit",
"retentionHours"
],
"properties": {
"monthlyExportRunLimit": {
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"exportRowLimit": {
"type": "integer",
"minimum": 1,
"maximum": 25000
},
"retentionHours": {
"type": "integer",
"minimum": 1,
"maximum": 72
}
}
}
}
}AircraftExportRun
{
"type": "object",
"additionalProperties": false,
"required": [
"exportId",
"reportId",
"kind",
"format",
"status",
"rowLimit",
"rowCount",
"storageBytes",
"storageSha256",
"errorCode",
"createdAt",
"claimedAt",
"completedAt",
"expiresAt"
],
"properties": {
"exportId": {
"type": "string",
"pattern": "^aex_[a-f0-9]{24}$"
},
"reportId": {
"type": [
"string",
"null"
],
"pattern": "^arp_[a-f0-9]{24}$"
},
"kind": {
"type": "string",
"enum": [
"registry_query",
"change_feed"
]
},
"format": {
"type": "string",
"enum": [
"csv",
"json",
"xlsx"
]
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"completed",
"failed",
"expired"
]
},
"rowLimit": {
"type": "integer",
"minimum": 1,
"maximum": 25000
},
"rowCount": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 25000
},
"storageBytes": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 67108864
},
"storageSha256": {
"type": [
"string",
"null"
],
"pattern": "^[a-f0-9]{64}$"
},
"errorCode": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"claimedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"expiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
}AircraftExportRunListResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AircraftExportRun"
}
},
"pagination": {
"type": "object",
"additionalProperties": false,
"required": [
"limit"
],
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
}
}
}
}
}AircraftExportRunResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AircraftExportRun"
}
}
}AircraftHistoryResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"nNumber",
"versions",
"events"
],
"properties": {
"nNumber": {
"type": "string"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryVersion"
}
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryEvent"
}
}
}
},
"pagination": {
"type": "object",
"additionalProperties": false,
"required": [
"versions",
"events"
],
"properties": {
"versions": {
"$ref": "#/components/schemas/PageMeta"
},
"events": {
"$ref": "#/components/schemas/PageMeta"
}
}
}
}
}AircraftNNumberStatus
{
"type": "object",
"additionalProperties": false,
"required": [
"contractVersion",
"nNumber",
"state",
"availability",
"observedAt",
"source",
"registered",
"reserved",
"deregistered"
],
"properties": {
"contractVersion": {
"type": "string",
"const": "aircraft-n-number-status-v1"
},
"nNumber": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"registered",
"reserved",
"deregistered",
"unknown"
]
},
"availability": {
"type": "string",
"const": "not_determined",
"description": "AIR14D never infers FAA N-number availability from registry absence or lifecycle state."
},
"observedAt": {
"type": "string",
"format": "date-time"
},
"source": {
"$ref": "#/components/schemas/SourceSnapshot"
},
"registered": {
"oneOf": [
{
"$ref": "#/components/schemas/AircraftCurrentRecord"
},
{
"type": "null"
}
]
},
"reserved": {
"oneOf": [
{
"$ref": "#/components/schemas/ReservedNNumberContext"
},
{
"type": "null"
}
]
},
"deregistered": {
"oneOf": [
{
"$ref": "#/components/schemas/DeregisteredNNumberContext"
},
{
"type": "null"
}
]
}
}
}AircraftNNumberStatusResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AircraftNNumberStatus"
}
}
}AircraftRegistryColumnsResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"grammar"
],
"properties": {
"data": {
"type": "array",
"minItems": 8,
"maxItems": 8,
"items": {
"$ref": "#/components/schemas/AircraftRegistryQueryColumn"
}
},
"grammar": {
"type": "object",
"additionalProperties": false,
"required": [
"filter",
"columns",
"sort",
"maxFilters",
"maxInValues"
],
"properties": {
"filter": {
"type": "string"
},
"columns": {
"type": "string"
},
"sort": {
"type": "string"
},
"maxFilters": {
"type": "integer",
"minimum": 1,
"maximum": 8
},
"maxInValues": {
"type": "integer",
"minimum": 1
}
}
}
}
}AircraftRegistryQueryColumn
{
"type": "object",
"additionalProperties": false,
"required": [
"name",
"type",
"filterable",
"sortable",
"operators"
],
"properties": {
"name": {
"type": "string",
"enum": [
"aircraftId",
"nNumber",
"sourceRegistrationStatusCode",
"serialNumber",
"manufactureYear",
"manufacturer",
"model",
"registrantState"
]
},
"type": {
"type": "string",
"enum": [
"string",
"integer",
"uuid"
]
},
"filterable": {
"type": "boolean"
},
"sortable": {
"type": "boolean"
},
"operators": {
"type": "array",
"items": {
"type": "string",
"enum": [
"equals",
"contains",
"starts_with",
"in",
"gte",
"lte",
"between"
]
}
}
}
}AircraftRegistryQueryRecord
{
"type": "object",
"additionalProperties": false,
"required": [
"contractVersion"
],
"properties": {
"contractVersion": {
"type": "string",
"const": "aircraft-query-v1"
},
"aircraftId": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"nNumber": {
"type": "string"
},
"sourceRegistrationStatusCode": {
"type": [
"string",
"null"
]
},
"serialNumber": {
"type": [
"string",
"null"
]
},
"manufactureYear": {
"type": [
"integer",
"null"
]
},
"manufacturer": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"registrantState": {
"type": [
"string",
"null"
]
}
}
}AircraftRegistryQueryResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"query",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AircraftRegistryQueryRecord"
}
},
"query": {
"type": "object",
"additionalProperties": false,
"required": [
"columns",
"sort"
],
"properties": {
"columns": {
"type": "array",
"items": {
"type": "string",
"enum": [
"aircraftId",
"nNumber",
"sourceRegistrationStatusCode",
"serialNumber",
"manufactureYear",
"manufacturer",
"model",
"registrantState"
]
}
},
"sort": {
"type": "object",
"additionalProperties": false,
"required": [
"column",
"direction"
],
"properties": {
"column": {
"type": "string",
"enum": [
"aircraftId",
"nNumber",
"sourceRegistrationStatusCode",
"serialNumber",
"manufactureYear",
"manufacturer",
"model",
"registrantState"
]
},
"direction": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
}
},
"pagination": {
"type": "object",
"additionalProperties": false,
"required": [
"limit",
"nextCursor"
],
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"nextCursor": {
"type": [
"string",
"null"
],
"maxLength": 4096
}
}
}
}
}AircraftRegistryReportDefinition
{
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"query"
],
"properties": {
"kind": {
"type": "string",
"const": "registry_query"
},
"query": {
"type": "object",
"additionalProperties": false,
"required": [
"filters",
"columns",
"sort"
],
"properties": {
"filters": {
"type": "array",
"minItems": 1,
"maxItems": 8,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"column",
"operator",
"values"
],
"properties": {
"column": {
"type": "string",
"enum": [
"aircraftId",
"nNumber",
"sourceRegistrationStatusCode",
"serialNumber",
"manufactureYear",
"manufacturer",
"model",
"registrantState"
]
},
"operator": {
"type": "string",
"enum": [
"equals",
"contains",
"starts_with",
"in",
"gte",
"lte",
"between"
]
},
"values": {
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
}
}
}
},
"columns": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"enum": [
"aircraftId",
"nNumber",
"sourceRegistrationStatusCode",
"serialNumber",
"manufactureYear",
"manufacturer",
"model",
"registrantState"
]
}
},
"sort": {
"type": "object",
"additionalProperties": false,
"required": [
"column",
"direction"
],
"properties": {
"column": {
"type": "string",
"enum": [
"aircraftId",
"nNumber",
"sourceRegistrationStatusCode",
"serialNumber",
"manufactureYear",
"manufacturer",
"model",
"registrantState"
]
},
"direction": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
}
}
}
}AircraftSavedReport
{
"type": "object",
"additionalProperties": false,
"required": [
"reportId",
"name",
"kind",
"definition",
"createdAt",
"updatedAt"
],
"properties": {
"reportId": {
"type": "string",
"pattern": "^arp_[a-f0-9]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"kind": {
"type": "string",
"enum": [
"registry_query",
"change_feed"
]
},
"definition": {
"$ref": "#/components/schemas/AircraftSavedReportDefinition"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}AircraftSavedReportDefinition
{
"oneOf": [
{
"$ref": "#/components/schemas/AircraftRegistryReportDefinition"
},
{
"$ref": "#/components/schemas/AircraftChangeReportDefinition"
}
]
}AircraftSavedReportInput
{
"type": "object",
"additionalProperties": false,
"required": [
"name",
"definition"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"definition": {
"$ref": "#/components/schemas/AircraftSavedReportDefinition"
}
}
}AircraftSavedReportListResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"limits"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AircraftSavedReport"
}
},
"limits": {
"type": "object",
"additionalProperties": false,
"required": [
"savedReportLimit"
],
"properties": {
"savedReportLimit": {
"type": "integer",
"minimum": 0,
"maximum": 250
}
}
}
}
}AircraftSavedReportResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"limits"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AircraftSavedReport"
},
"limits": {
"type": "object",
"additionalProperties": false,
"required": [
"savedReportLimit"
],
"properties": {
"savedReportLimit": {
"type": "integer",
"minimum": 1,
"maximum": 250
}
}
}
}
}AircraftWebhookDelivery
{
"type": "object",
"additionalProperties": false,
"required": [
"deliveryId",
"eventId",
"eventKind",
"eventType",
"nNumber",
"observedAt",
"attemptCount",
"nextAttemptAt",
"deliveredAt",
"terminalAt",
"terminalReason",
"createdAt",
"attempts"
],
"properties": {
"deliveryId": {
"type": "string",
"pattern": "^awd_[a-f0-9]{24}$"
},
"eventId": {
"type": "string",
"pattern": "^aevt_(?:test_)?[a-f0-9]{24,32}$"
},
"eventKind": {
"type": "string",
"enum": [
"change",
"test"
]
},
"eventType": {
"type": [
"string",
"null"
],
"enum": [
"registration_added",
"registration_removed",
"registration_record_changed",
"aircraft_assignment_changed",
"status_changed",
"registrant_changed",
"registrant_pii_withheld",
"registrant_pii_released",
null
]
},
"nNumber": {
"type": "string",
"pattern": "^N(?:[1-9][0-9]{0,4}|[1-9][0-9]{0,3}[A-HJ-NP-Z]|[1-9][0-9]{0,2}[A-HJ-NP-Z]{2})$"
},
"observedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"attemptCount": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"nextAttemptAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"deliveredAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"terminalAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"terminalReason": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"attempts": {
"type": "array",
"maxItems": 5,
"items": {
"$ref": "#/components/schemas/AircraftWebhookDeliveryAttempt"
}
}
}
}AircraftWebhookDeliveryAttempt
{
"type": "object",
"additionalProperties": false,
"required": [
"attemptNumber",
"attemptedAt",
"outcome",
"httpStatus",
"errorCode",
"durationMs"
],
"properties": {
"attemptNumber": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"attemptedAt": {
"type": "string",
"format": "date-time"
},
"outcome": {
"type": "string",
"enum": [
"delivered",
"retryable",
"failed"
]
},
"httpStatus": {
"type": [
"integer",
"null"
],
"minimum": 100,
"maximum": 599
},
"errorCode": {
"type": [
"string",
"null"
]
},
"durationMs": {
"type": "integer",
"minimum": 0,
"maximum": 60000
}
}
}AircraftWebhookDeliveryListResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"watch",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AircraftWebhookDelivery"
}
},
"watch": {
"type": "object",
"additionalProperties": false,
"required": [
"watchId",
"nNumber"
],
"properties": {
"watchId": {
"type": "string",
"pattern": "^aw_[a-f0-9]{24}$"
},
"nNumber": {
"type": "string",
"pattern": "^N(?:[1-9][0-9]{0,4}|[1-9][0-9]{0,3}[A-HJ-NP-Z]|[1-9][0-9]{0,2}[A-HJ-NP-Z]{2})$"
}
}
},
"pagination": {
"type": "object",
"additionalProperties": false,
"required": [
"limit"
],
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
}
}
}
}AircraftWebhookTestResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"deliveryId",
"eventId",
"status",
"createdAt"
],
"properties": {
"deliveryId": {
"type": "string",
"pattern": "^awd_[a-f0-9]{24}$"
},
"eventId": {
"type": "string",
"pattern": "^aevt_test_[a-f0-9]{24}$"
},
"status": {
"type": "string",
"const": "queued"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
}
}
}AircraftWebhookWatch
{
"type": "object",
"additionalProperties": false,
"required": [
"watchId",
"nNumber",
"endpointUrl",
"eventTypes",
"status",
"createdAt",
"updatedAt"
],
"properties": {
"watchId": {
"type": "string",
"pattern": "^aw_[a-f0-9]{24}$"
},
"nNumber": {
"type": "string",
"pattern": "^N(?:[1-9][0-9]{0,4}|[1-9][0-9]{0,3}[A-HJ-NP-Z]|[1-9][0-9]{0,2}[A-HJ-NP-Z]{2})$"
},
"endpointUrl": {
"type": "string",
"format": "uri",
"maxLength": 2048
},
"eventTypes": {
"type": "array",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"registration_added",
"registration_removed",
"registration_record_changed",
"aircraft_assignment_changed",
"status_changed",
"registrant_changed",
"registrant_pii_withheld",
"registrant_pii_released"
]
}
},
"status": {
"type": "string",
"const": "active"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}AircraftWebhookWatchCreated
{
"type": "object",
"additionalProperties": false,
"required": [
"watchId",
"nNumber",
"endpointUrl",
"eventTypes",
"status",
"createdAt",
"updatedAt",
"signingSecret",
"signingVersion"
],
"properties": {
"watchId": {
"type": "string",
"pattern": "^aw_[a-f0-9]{24}$"
},
"nNumber": {
"type": "string",
"pattern": "^N(?:[1-9][0-9]{0,4}|[1-9][0-9]{0,3}[A-HJ-NP-Z]|[1-9][0-9]{0,2}[A-HJ-NP-Z]{2})$"
},
"endpointUrl": {
"type": "string",
"format": "uri",
"maxLength": 2048
},
"eventTypes": {
"type": "array",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"registration_added",
"registration_removed",
"registration_record_changed",
"aircraft_assignment_changed",
"status_changed",
"registrant_changed",
"registrant_pii_withheld",
"registrant_pii_released"
]
}
},
"status": {
"type": "string",
"const": "active"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"signingSecret": {
"type": "string",
"pattern": "^whsec_[A-Za-z0-9_-]+$",
"description": "Returned only once at watch creation. Use it to verify X-Grizzly-Bulls-Signature."
},
"signingVersion": {
"type": "string",
"const": "v1"
}
}
}AircraftWebhookWatchCreateInput
{
"type": "object",
"additionalProperties": false,
"required": [
"nNumber",
"endpointUrl"
],
"properties": {
"nNumber": {
"type": "string",
"description": "Canonical or normalizable U.S. N-number. AIR14F intentionally does not support saved searches or aircraftId watches."
},
"endpointUrl": {
"type": "string",
"format": "uri",
"maxLength": 2048,
"description": "HTTPS public-Internet endpoint. Redirects are not followed."
},
"eventTypes": {
"type": "array",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"description": "Optional exact AIR14C event-type subset. Omit to watch all reviewed event types.",
"items": {
"type": "string",
"enum": [
"registration_added",
"registration_removed",
"registration_record_changed",
"aircraft_assignment_changed",
"status_changed",
"registrant_changed",
"registrant_pii_withheld",
"registrant_pii_released"
]
}
}
}
}AircraftWebhookWatchCreateResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"limits"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AircraftWebhookWatchCreated"
},
"limits": {
"type": "object",
"additionalProperties": false,
"required": [
"watchLimit"
],
"properties": {
"watchLimit": {
"type": "integer",
"minimum": 1,
"maximum": 250
}
}
}
}
}AircraftWebhookWatchListResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"limits"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AircraftWebhookWatch"
}
},
"limits": {
"type": "object",
"additionalProperties": false,
"required": [
"watchLimit"
],
"properties": {
"watchLimit": {
"type": "integer",
"minimum": 0,
"maximum": 250
}
}
}
}
}CurrentAircraft
{
"type": "object",
"additionalProperties": false,
"required": [
"serialNumber",
"manufactureYear",
"manufacturer",
"model",
"sourceAircraftTypeCode",
"sourceEngineTypeCode",
"sourceCategoryCode",
"sourceWeightClassCode",
"engineCount",
"seatCount",
"airworthinessDate",
"modeSCodeOctal",
"modeSCodeHex",
"typeCertificateDataSheet",
"typeCertificateHolder",
"engine"
],
"properties": {
"serialNumber": {
"type": [
"string",
"null"
]
},
"manufactureYear": {
"type": [
"integer",
"null"
]
},
"manufacturer": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"sourceAircraftTypeCode": {
"type": [
"string",
"null"
]
},
"sourceEngineTypeCode": {
"type": [
"string",
"null"
]
},
"sourceCategoryCode": {
"type": [
"string",
"null"
]
},
"sourceWeightClassCode": {
"type": [
"string",
"null"
]
},
"engineCount": {
"type": [
"number",
"null"
]
},
"seatCount": {
"type": [
"number",
"null"
]
},
"airworthinessDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"modeSCodeOctal": {
"type": [
"string",
"null"
]
},
"modeSCodeHex": {
"type": [
"string",
"null"
]
},
"typeCertificateDataSheet": {
"type": [
"string",
"null"
]
},
"typeCertificateHolder": {
"type": [
"string",
"null"
]
},
"engine": {
"type": "object",
"additionalProperties": false,
"required": [
"manufacturer",
"model",
"sourceTypeCode",
"horsepower",
"thrust"
],
"properties": {
"manufacturer": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"sourceTypeCode": {
"type": [
"string",
"null"
]
},
"horsepower": {
"type": [
"number",
"null"
]
},
"thrust": {
"type": [
"number",
"null"
]
}
}
}
}
}DeregisteredNNumberContext
{
"type": "object",
"additionalProperties": false,
"required": [
"aircraftId",
"serialNumber",
"manufactureYear",
"sourceRegistrationStatusCode",
"cancellationDate",
"exportCountryCode",
"lastActivityDate",
"certificateIssueDate",
"airworthinessDate",
"modeSCodeOctal",
"modeSCodeHex",
"matchingRecordCount"
],
"properties": {
"aircraftId": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"serialNumber": {
"type": [
"string",
"null"
]
},
"manufactureYear": {
"type": [
"integer",
"null"
]
},
"sourceRegistrationStatusCode": {
"type": [
"string",
"null"
]
},
"cancellationDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"exportCountryCode": {
"type": [
"string",
"null"
]
},
"lastActivityDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"certificateIssueDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"airworthinessDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"modeSCodeOctal": {
"type": [
"string",
"null"
]
},
"modeSCodeHex": {
"type": [
"string",
"null"
]
},
"matchingRecordCount": {
"type": "integer",
"minimum": 1,
"description": "Number of current DEREG rows observed for this N-number. Context fields come from the deterministic latest reviewed row."
}
}
}ErrorResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"additionalProperties": false,
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"enum": [
"invalid_request",
"unauthenticated",
"rate_limited",
"not_entitled",
"conflict",
"limit_reached",
"not_found",
"not_ready",
"expired",
"method_not_allowed",
"service_unavailable",
"internal_error"
]
},
"message": {
"type": "string"
}
}
}
}
}HistoricalAircraft
{
"type": "object",
"additionalProperties": false,
"required": [
"serialNumber",
"manufactureYear",
"sourceAircraftTypeCode",
"sourceEngineTypeCode",
"airworthinessDate",
"modeSCodeOctal",
"modeSCodeHex"
],
"properties": {
"serialNumber": {
"type": [
"string",
"null"
]
},
"manufactureYear": {
"type": [
"integer",
"null"
]
},
"sourceAircraftTypeCode": {
"type": [
"string",
"null"
]
},
"sourceEngineTypeCode": {
"type": [
"string",
"null"
]
},
"airworthinessDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"modeSCodeOctal": {
"type": [
"string",
"null"
]
},
"modeSCodeHex": {
"type": [
"string",
"null"
]
}
}
}HistoryEvent
{
"type": "object",
"additionalProperties": false,
"required": [
"contractVersion",
"aircraftId",
"previousAircraftId",
"nNumber",
"eventType",
"oldSourceRegistrationStatusCode",
"newSourceRegistrationStatusCode",
"changedFields",
"sourceEffectiveDate",
"observedAt",
"previousObservedAt",
"source"
],
"properties": {
"contractVersion": {
"type": "string",
"const": "aircraft-public-v1"
},
"aircraftId": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"previousAircraftId": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"nNumber": {
"type": "string"
},
"eventType": {
"type": "string",
"enum": [
"registration_added",
"registration_removed",
"registration_record_changed",
"aircraft_assignment_changed",
"status_changed",
"registrant_changed",
"registrant_pii_withheld",
"registrant_pii_released"
]
},
"oldSourceRegistrationStatusCode": {
"type": [
"string",
"null"
]
},
"newSourceRegistrationStatusCode": {
"type": [
"string",
"null"
]
},
"changedFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"aircraft_assignment",
"registration_identifier",
"aircraft_model",
"engine_model",
"manufacture_year",
"aircraft_type",
"engine_type",
"registration_status",
"mode_s_code",
"certificate_issue_date",
"expiration_date",
"last_activity_date",
"airworthiness_date",
"fractional_ownership",
"registrant_type"
]
}
},
"sourceEffectiveDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"observedAt": {
"type": "string",
"format": "date-time"
},
"previousObservedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"source": {
"$ref": "#/components/schemas/SourceSnapshot"
}
}
}HistorySummary
{
"type": "object",
"additionalProperties": false,
"required": [
"firstObservedAt",
"lastObservedAt",
"versionCount",
"eventCount"
],
"properties": {
"firstObservedAt": {
"type": "string",
"format": "date-time"
},
"lastObservedAt": {
"type": "string",
"format": "date-time"
},
"versionCount": {
"type": "integer",
"minimum": 1
},
"eventCount": {
"type": "integer",
"minimum": 0
}
}
}HistoryVersion
{
"type": "object",
"additionalProperties": false,
"required": [
"contractVersion",
"aircraftId",
"registration",
"aircraft",
"registrant",
"sourceProvider",
"observedFrom",
"observedThrough"
],
"properties": {
"contractVersion": {
"type": "string",
"const": "aircraft-public-v1"
},
"aircraftId": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"registration": {
"$ref": "#/components/schemas/Registration"
},
"aircraft": {
"$ref": "#/components/schemas/HistoricalAircraft"
},
"registrant": {
"$ref": "#/components/schemas/Registrant"
},
"sourceProvider": {
"type": "string",
"const": "faa-releasable-aircraft-registry"
},
"observedFrom": {
"$ref": "#/components/schemas/ObservationBoundary"
},
"observedThrough": {
"$ref": "#/components/schemas/ObservationBoundary"
}
}
}ObservationBoundary
{
"type": "object",
"additionalProperties": false,
"required": [
"retrievedAt",
"sourceContractVersion",
"sourceUrl",
"archiveSha256"
],
"properties": {
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"sourceContractVersion": {
"type": "string"
},
"sourceUrl": {
"type": "string",
"format": "uri"
},
"archiveSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
}PageMeta
{
"type": "object",
"additionalProperties": false,
"required": [
"limit",
"offset",
"total",
"hasMore"
],
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"total": {
"type": "integer",
"minimum": 0
},
"hasMore": {
"type": "boolean"
}
}
}Registrant
{
"type": "object",
"additionalProperties": false,
"required": [
"sourceTypeCode",
"name",
"street1",
"street2",
"city",
"state",
"postalCode",
"countyCode",
"countryCode",
"otherNames"
],
"properties": {
"sourceTypeCode": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"street1": {
"type": [
"string",
"null"
]
},
"street2": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"postalCode": {
"type": [
"string",
"null"
]
},
"countyCode": {
"type": [
"string",
"null"
]
},
"countryCode": {
"type": [
"string",
"null"
]
},
"otherNames": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Registration
{
"type": "object",
"additionalProperties": false,
"required": [
"nNumber",
"sourceStatusCode",
"certificateIssueDate",
"expirationDate",
"lastActivityDate",
"fractionalOwnership"
],
"properties": {
"nNumber": {
"type": "string"
},
"sourceStatusCode": {
"type": [
"string",
"null"
]
},
"certificateIssueDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"expirationDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"lastActivityDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"fractionalOwnership": {
"type": [
"boolean",
"null"
]
}
}
}ReservedNNumberContext
{
"type": "object",
"additionalProperties": false,
"required": [
"reserveDate",
"sourceReservationTypeCode",
"expirationNoticeDate",
"purgeDate"
],
"properties": {
"reserveDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"sourceReservationTypeCode": {
"type": [
"string",
"null"
]
},
"expirationNoticeDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"purgeDate": {
"type": [
"string",
"null"
],
"format": "date"
}
}
}SourceSnapshot
{
"type": "object",
"additionalProperties": false,
"required": [
"provider",
"sourceContractVersion",
"sourceUrl",
"retrievedAt",
"archiveSha256"
],
"properties": {
"provider": {
"type": "string",
"const": "faa-releasable-aircraft-registry"
},
"sourceContractVersion": {
"type": "string"
},
"sourceUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"archiveSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
}