Akahu · JSON-LD Context

Akahu Context

JSON-LD context defining the semantic vocabulary for Akahu from Akahu.

120 Classes 52 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
akahu: https://akahu.nz/schema#

Classes

TestWebhookPayload TestWebhookEvent ApplicationCreatedWebhookPayload ApplicationCreatedWebhookEvent ApplicationArchivedWebhookPayload ApplicationArchivedWebhookEvent ApplicationUnarchivedWebhookPayload ApplicationUnarchivedWebhookEvent SharingRequestViewedWebhookPayload SharingRequestViewedWebhookEvent SharingRequestSubmittedWebhookPayload SharingRequestSubmittedWebhookEvent DocumentUploadedWebhookPayload DocumentUploadedWebhookEvent DocumentCompletedWebhookPayload DocumentCompletedWebhookEvent DocumentFailedWebhookPayload DocumentFailedWebhookEvent ReportCompletedWebhookPayload ReportCompletedWebhookEvent ReportFailedWebhookPayload ReportFailedWebhookEvent ReferralCreatedWebhookPayload ReferralCreatedWebhookEvent ReferralRevokedWebhookPayload ReferralRevokedWebhookEvent ReferralRedeemedWebhookPayload ReferralRedeemedWebhookEvent ReferralRedemptionCreatedWebhookPayload ReferralRedemptionCreatedWebhookEvent ReferralRedemptionCompletedWebhookPayload ReferralRedemptionCompletedWebhookEvent ReferralRedemptionFailedWebhookPayload ReferralRedemptionFailedWebhookEvent Org Generic400ErrorResponseCode Generic400ErrorResponse Generic401ErrorResponseCode Generic401ErrorResponse Generic403ErrorResponseCode Generic403ErrorResponse Generic404ErrorResponseCode Generic404ErrorResponse Generic429ErrorResponseCode Generic429ErrorResponse Generic500ErrorResponseCode Generic500ErrorResponse ReportType ApplicationStatus Application CreateApplication400ErrorResponseCode CreateApplication400ErrorResponse ApplicationCreateParams UpdateApplication400ErrorResponseCode UpdateApplication400ErrorResponse ApplicationUpdateParams ReferralStatus ReferralOrgDetails Referral CreateReferral400ErrorResponseCode CreateReferral400ErrorResponse CreateReferralParams ListReferrals400ErrorResponseCode ListReferrals400ErrorResponse GetReferral400ErrorResponseCode GetReferral400ErrorResponse RevokeReferral400ErrorResponseCode RevokeReferral400ErrorResponse ReferralRedemptionProcessing ReferralRedemptionCompleted ReferralRedemptionFailureReasonCode ReferralRedemptionFailureReason ReferralRedemptionFailed CreateReferralRedemption400ErrorResponseCode CreateReferralRedemption400ErrorResponse CreateReferralRedemptionParams GetReferralRedemption400ErrorResponseCode GetReferralRedemption400ErrorResponse CreateDocument400ErrorResponseCode CreateDocument400ErrorResponse DocumentStatus DocumentFailureReasonCode DocumentChannelSharingRequest DocumentChannelApi DocumentChannelPortal DocumentChannelReferral DocumentSourceDirectUpload DocumentSourceOneoffObConnection DocumentRangeOutcome DocumentContentType DocumentContentRange DocumentContentDetails Document DeleteDocument400ErrorResponseCode DeleteDocument400ErrorResponse DownloadDocument400ErrorResponseCode DownloadDocument400ErrorResponse CreateDatafile400ErrorResponseCode CreateDatafile400ErrorResponse DatafileStatus DatafileFailureReasonCode Datafile DeleteDatafile400ErrorResponseCode DeleteDatafile400ErrorResponse DownloadDatafile400ErrorResponseCode DownloadDatafile400ErrorResponse ReportStatus ReportFailureReasonCode ReportFailureReason ReportResourceDocument ReportResourceDatafile ReportResourceOneoffOpenBankingConnection SpendingCategory IncomeCategory Report CreateReport400ErrorResponseCode CreateReport400ErrorResponse GetReportHtmlDownload400ErrorResponseCode GetReportHtmlDownload400ErrorResponse DocumentCompleteSource

Properties

Property Type Container
type string
_org reference
_endpoint reference
_id reference
emitted_at dateTime
payload reference
_application reference
_sharing_request reference
_document reference
_report reference
_referral reference
_referral_redemption reference
name string
logo string
default_report_type string
report_type_locked boolean
issues list
reference string
report_type reference
status reference
last_applicant_submission_at dateTime
archived_at dateTime
created_at dateTime
updated_at dateTime
code reference
expires_at dateTime
revoked_at dateTime
redeemed_by list
referrer reference
message string
failure_reason reference
original_channel_type string
start decimal
end decimal
outcome reference
inferred_content reference
page_count decimal
processed_count decimal
skipped_count decimal
unprocessed_count decimal
ranges list
channel
source
content_details reference
content_type string
resources list
generated_at dateTime
spending_categories list
income_categories list
insights list
filename string
unreadable boolean

JSON-LD Document

Raw ↑ 
{
  "@context": {
    "@vocab": "https://akahu.nz/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "akahu": "https://akahu.nz/schema#",
    "TestWebhookPayload": "akahu:TestWebhookPayload",
    "type": {
      "@id": "akahu:type",
      "@type": "xsd:string"
    },
    "_org": {
      "@id": "akahu:_org",
      "@type": "@id"
    },
    "_endpoint": {
      "@id": "akahu:_endpoint",
      "@type": "@id"
    },
    "TestWebhookEvent": "akahu:TestWebhookEvent",
    "_id": {
      "@id": "akahu:_id",
      "@type": "@id"
    },
    "emitted_at": {
      "@id": "akahu:emitted_at",
      "@type": "xsd:dateTime"
    },
    "payload": {
      "@id": "akahu:payload",
      "@type": "@id"
    },
    "ApplicationCreatedWebhookPayload": "akahu:ApplicationCreatedWebhookPayload",
    "_application": {
      "@id": "akahu:_application",
      "@type": "@id"
    },
    "ApplicationCreatedWebhookEvent": "akahu:ApplicationCreatedWebhookEvent",
    "ApplicationArchivedWebhookPayload": "akahu:ApplicationArchivedWebhookPayload",
    "ApplicationArchivedWebhookEvent": "akahu:ApplicationArchivedWebhookEvent",
    "ApplicationUnarchivedWebhookPayload": "akahu:ApplicationUnarchivedWebhookPayload",
    "ApplicationUnarchivedWebhookEvent": "akahu:ApplicationUnarchivedWebhookEvent",
    "SharingRequestViewedWebhookPayload": "akahu:SharingRequestViewedWebhookPayload",
    "_sharing_request": {
      "@id": "akahu:_sharing_request",
      "@type": "@id"
    },
    "SharingRequestViewedWebhookEvent": "akahu:SharingRequestViewedWebhookEvent",
    "SharingRequestSubmittedWebhookPayload": "akahu:SharingRequestSubmittedWebhookPayload",
    "SharingRequestSubmittedWebhookEvent": "akahu:SharingRequestSubmittedWebhookEvent",
    "DocumentUploadedWebhookPayload": "akahu:DocumentUploadedWebhookPayload",
    "_document": {
      "@id": "akahu:_document",
      "@type": "@id"
    },
    "DocumentUploadedWebhookEvent": "akahu:DocumentUploadedWebhookEvent",
    "DocumentCompletedWebhookPayload": "akahu:DocumentCompletedWebhookPayload",
    "DocumentCompletedWebhookEvent": "akahu:DocumentCompletedWebhookEvent",
    "DocumentFailedWebhookPayload": "akahu:DocumentFailedWebhookPayload",
    "DocumentFailedWebhookEvent": "akahu:DocumentFailedWebhookEvent",
    "ReportCompletedWebhookPayload": "akahu:ReportCompletedWebhookPayload",
    "_report": {
      "@id": "akahu:_report",
      "@type": "@id"
    },
    "ReportCompletedWebhookEvent": "akahu:ReportCompletedWebhookEvent",
    "ReportFailedWebhookPayload": "akahu:ReportFailedWebhookPayload",
    "ReportFailedWebhookEvent": "akahu:ReportFailedWebhookEvent",
    "ReferralCreatedWebhookPayload": "akahu:ReferralCreatedWebhookPayload",
    "_referral": {
      "@id": "akahu:_referral",
      "@type": "@id"
    },
    "ReferralCreatedWebhookEvent": "akahu:ReferralCreatedWebhookEvent",
    "ReferralRevokedWebhookPayload": "akahu:ReferralRevokedWebhookPayload",
    "ReferralRevokedWebhookEvent": "akahu:ReferralRevokedWebhookEvent",
    "ReferralRedeemedWebhookPayload": "akahu:ReferralRedeemedWebhookPayload",
    "ReferralRedeemedWebhookEvent": "akahu:ReferralRedeemedWebhookEvent",
    "ReferralRedemptionCreatedWebhookPayload": "akahu:ReferralRedemptionCreatedWebhookPayload",
    "_referral_redemption": {
      "@id": "akahu:_referral_redemption",
      "@type": "@id"
    },
    "ReferralRedemptionCreatedWebhookEvent": "akahu:ReferralRedemptionCreatedWebhookEvent",
    "ReferralRedemptionCompletedWebhookPayload": "akahu:ReferralRedemptionCompletedWebhookPayload",
    "ReferralRedemptionCompletedWebhookEvent": "akahu:ReferralRedemptionCompletedWebhookEvent",
    "ReferralRedemptionFailedWebhookPayload": "akahu:ReferralRedemptionFailedWebhookPayload",
    "ReferralRedemptionFailedWebhookEvent": "akahu:ReferralRedemptionFailedWebhookEvent",
    "Org": "akahu:Org",
    "name": {
      "@id": "akahu:name",
      "@type": "xsd:string"
    },
    "logo": {
      "@id": "akahu:logo",
      "@type": "xsd:string"
    },
    "default_report_type": {
      "@id": "akahu:default_report_type",
      "@type": "xsd:string"
    },
    "report_type_locked": {
      "@id": "akahu:report_type_locked",
      "@type": "xsd:boolean"
    },
    "Generic400ErrorResponseCode": "akahu:Generic400ErrorResponseCode",
    "Generic400ErrorResponse": "akahu:Generic400ErrorResponse",
    "issues": {
      "@id": "akahu:issues",
      "@container": "@list"
    },
    "Generic401ErrorResponseCode": "akahu:Generic401ErrorResponseCode",
    "Generic401ErrorResponse": "akahu:Generic401ErrorResponse",
    "Generic403ErrorResponseCode": "akahu:Generic403ErrorResponseCode",
    "Generic403ErrorResponse": "akahu:Generic403ErrorResponse",
    "Generic404ErrorResponseCode": "akahu:Generic404ErrorResponseCode",
    "Generic404ErrorResponse": "akahu:Generic404ErrorResponse",
    "Generic429ErrorResponseCode": "akahu:Generic429ErrorResponseCode",
    "Generic429ErrorResponse": "akahu:Generic429ErrorResponse",
    "Generic500ErrorResponseCode": "akahu:Generic500ErrorResponseCode",
    "Generic500ErrorResponse": "akahu:Generic500ErrorResponse",
    "ReportType": "akahu:ReportType",
    "ApplicationStatus": "akahu:ApplicationStatus",
    "Application": "akahu:Application",
    "reference": {
      "@id": "akahu:reference",
      "@type": "xsd:string"
    },
    "report_type": {
      "@id": "akahu:report_type",
      "@type": "@id"
    },
    "status": {
      "@id": "akahu:status",
      "@type": "@id"
    },
    "last_applicant_submission_at": {
      "@id": "akahu:last_applicant_submission_at",
      "@type": "xsd:dateTime"
    },
    "archived_at": {
      "@id": "akahu:archived_at",
      "@type": "xsd:dateTime"
    },
    "created_at": {
      "@id": "akahu:created_at",
      "@type": "xsd:dateTime"
    },
    "updated_at": {
      "@id": "akahu:updated_at",
      "@type": "xsd:dateTime"
    },
    "CreateApplication400ErrorResponseCode": "akahu:CreateApplication400ErrorResponseCode",
    "CreateApplication400ErrorResponse": "akahu:CreateApplication400ErrorResponse",
    "ApplicationCreateParams": "akahu:ApplicationCreateParams",
    "UpdateApplication400ErrorResponseCode": "akahu:UpdateApplication400ErrorResponseCode",
    "UpdateApplication400ErrorResponse": "akahu:UpdateApplication400ErrorResponse",
    "ApplicationUpdateParams": "akahu:ApplicationUpdateParams",
    "ReferralStatus": "akahu:ReferralStatus",
    "ReferralOrgDetails": "akahu:ReferralOrgDetails",
    "Referral": "akahu:Referral",
    "code": {
      "@id": "akahu:code",
      "@type": "@id"
    },
    "expires_at": {
      "@id": "akahu:expires_at",
      "@type": "xsd:dateTime"
    },
    "revoked_at": {
      "@id": "akahu:revoked_at",
      "@type": "xsd:dateTime"
    },
    "redeemed_by": {
      "@id": "akahu:redeemed_by",
      "@container": "@list"
    },
    "CreateReferral400ErrorResponseCode": "akahu:CreateReferral400ErrorResponseCode",
    "CreateReferral400ErrorResponse": "akahu:CreateReferral400ErrorResponse",
    "CreateReferralParams": "akahu:CreateReferralParams",
    "ListReferrals400ErrorResponseCode": "akahu:ListReferrals400ErrorResponseCode",
    "ListReferrals400ErrorResponse": "akahu:ListReferrals400ErrorResponse",
    "GetReferral400ErrorResponseCode": "akahu:GetReferral400ErrorResponseCode",
    "GetReferral400ErrorResponse": "akahu:GetReferral400ErrorResponse",
    "RevokeReferral400ErrorResponseCode": "akahu:RevokeReferral400ErrorResponseCode",
    "RevokeReferral400ErrorResponse": "akahu:RevokeReferral400ErrorResponse",
    "ReferralRedemptionProcessing": "akahu:ReferralRedemptionProcessing",
    "referrer": {
      "@id": "akahu:referrer",
      "@type": "@id"
    },
    "ReferralRedemptionCompleted": "akahu:ReferralRedemptionCompleted",
    "ReferralRedemptionFailureReasonCode": "akahu:ReferralRedemptionFailureReasonCode",
    "ReferralRedemptionFailureReason": "akahu:ReferralRedemptionFailureReason",
    "message": {
      "@id": "akahu:message",
      "@type": "xsd:string"
    },
    "ReferralRedemptionFailed": "akahu:ReferralRedemptionFailed",
    "failure_reason": {
      "@id": "akahu:failure_reason",
      "@type": "@id"
    },
    "CreateReferralRedemption400ErrorResponseCode": "akahu:CreateReferralRedemption400ErrorResponseCode",
    "CreateReferralRedemption400ErrorResponse": "akahu:CreateReferralRedemption400ErrorResponse",
    "CreateReferralRedemptionParams": "akahu:CreateReferralRedemptionParams",
    "GetReferralRedemption400ErrorResponseCode": "akahu:GetReferralRedemption400ErrorResponseCode",
    "GetReferralRedemption400ErrorResponse": "akahu:GetReferralRedemption400ErrorResponse",
    "CreateDocument400ErrorResponseCode": "akahu:CreateDocument400ErrorResponseCode",
    "CreateDocument400ErrorResponse": "akahu:CreateDocument400ErrorResponse",
    "DocumentStatus": "akahu:DocumentStatus",
    "DocumentFailureReasonCode": "akahu:DocumentFailureReasonCode",
    "DocumentChannelSharingRequest": "akahu:DocumentChannelSharingRequest",
    "DocumentChannelApi": "akahu:DocumentChannelApi",
    "DocumentChannelPortal": "akahu:DocumentChannelPortal",
    "DocumentChannelReferral": "akahu:DocumentChannelReferral",
    "original_channel_type": {
      "@id": "akahu:original_channel_type",
      "@type": "xsd:string"
    },
    "DocumentSourceDirectUpload": "akahu:DocumentSourceDirectUpload",
    "DocumentSourceOneoffObConnection": "akahu:DocumentSourceOneoffObConnection",
    "DocumentRangeOutcome": "akahu:DocumentRangeOutcome",
    "DocumentContentType": "akahu:DocumentContentType",
    "DocumentContentRange": "akahu:DocumentContentRange",
    "start": {
      "@id": "akahu:start",
      "@type": "xsd:decimal"
    },
    "end": {
      "@id": "akahu:end",
      "@type": "xsd:decimal"
    },
    "outcome": {
      "@id": "akahu:outcome",
      "@type": "@id"
    },
    "inferred_content": {
      "@id": "akahu:inferred_content",
      "@type": "@id"
    },
    "DocumentContentDetails": "akahu:DocumentContentDetails",
    "page_count": {
      "@id": "akahu:page_count",
      "@type": "xsd:decimal"
    },
    "processed_count": {
      "@id": "akahu:processed_count",
      "@type": "xsd:decimal"
    },
    "skipped_count": {
      "@id": "akahu:skipped_count",
      "@type": "xsd:decimal"
    },
    "unprocessed_count": {
      "@id": "akahu:unprocessed_count",
      "@type": "xsd:decimal"
    },
    "ranges": {
      "@id": "akahu:ranges",
      "@container": "@list"
    },
    "Document": "akahu:Document",
    "channel": {
      "@id": "akahu:channel"
    },
    "source": {
      "@id": "akahu:source"
    },
    "content_details": {
      "@id": "akahu:content_details",
      "@type": "@id"
    },
    "DeleteDocument400ErrorResponseCode": "akahu:DeleteDocument400ErrorResponseCode",
    "DeleteDocument400ErrorResponse": "akahu:DeleteDocument400ErrorResponse",
    "DownloadDocument400ErrorResponseCode": "akahu:DownloadDocument400ErrorResponseCode",
    "DownloadDocument400ErrorResponse": "akahu:DownloadDocument400ErrorResponse",
    "CreateDatafile400ErrorResponseCode": "akahu:CreateDatafile400ErrorResponseCode",
    "CreateDatafile400ErrorResponse": "akahu:CreateDatafile400ErrorResponse",
    "DatafileStatus": "akahu:DatafileStatus",
    "DatafileFailureReasonCode": "akahu:DatafileFailureReasonCode",
    "Datafile": "akahu:Datafile",
    "content_type": {
      "@id": "akahu:content_type",
      "@type": "xsd:string"
    },
    "DeleteDatafile400ErrorResponseCode": "akahu:DeleteDatafile400ErrorResponseCode",
    "DeleteDatafile400ErrorResponse": "akahu:DeleteDatafile400ErrorResponse",
    "DownloadDatafile400ErrorResponseCode": "akahu:DownloadDatafile400ErrorResponseCode",
    "DownloadDatafile400ErrorResponse": "akahu:DownloadDatafile400ErrorResponse",
    "ReportStatus": "akahu:ReportStatus",
    "ReportFailureReasonCode": "akahu:ReportFailureReasonCode",
    "ReportFailureReason": "akahu:ReportFailureReason",
    "ReportResourceDocument": "akahu:ReportResourceDocument",
    "ReportResourceDatafile": "akahu:ReportResourceDatafile",
    "ReportResourceOneoffOpenBankingConnection": "akahu:ReportResourceOneoffOpenBankingConnection",
    "SpendingCategory": "akahu:SpendingCategory",
    "IncomeCategory": "akahu:IncomeCategory",
    "Report": "akahu:Report",
    "resources": {
      "@id": "akahu:resources",
      "@container": "@list"
    },
    "generated_at": {
      "@id": "akahu:generated_at",
      "@type": "xsd:dateTime"
    },
    "spending_categories": {
      "@id": "akahu:spending_categories",
      "@container": "@list"
    },
    "income_categories": {
      "@id": "akahu:income_categories",
      "@container": "@list"
    },
    "insights": {
      "@id": "akahu:insights",
      "@container": "@list"
    },
    "CreateReport400ErrorResponseCode": "akahu:CreateReport400ErrorResponseCode",
    "CreateReport400ErrorResponse": "akahu:CreateReport400ErrorResponse",
    "GetReportHtmlDownload400ErrorResponseCode": "akahu:GetReportHtmlDownload400ErrorResponseCode",
    "GetReportHtmlDownload400ErrorResponse": "akahu:GetReportHtmlDownload400ErrorResponse",
    "DocumentCompleteSource": "akahu:DocumentCompleteSource",
    "filename": {
      "@id": "akahu:filename",
      "@type": "xsd:string"
    },
    "unreadable": {
      "@id": "akahu:unreadable",
      "@type": "xsd:boolean"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "Akahu API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Akahu's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-27) from openapi/akahu-apply-api-openapi.yml, openapi/akahu-enduring-api-openapi.yml, openapi/akahu-genie-transaction-enrichment-api-openapi.yml.",
  "dcterms:created": "2026-10-27",
  "dcterms:source": [
    "openapi/akahu-apply-api-openapi.yml",
    "openapi/akahu-enduring-api-openapi.yml",
    "openapi/akahu-genie-transaction-enrichment-api-openapi.yml",
    "openapi/akahu-one-off-payments-api-openapi.yml",
    "openapi/akahu-one-off-rest-api-openapi.yml"
  ]
}