Files
zeekay 1df3ddf6bd Regenerate against the document the deployment answers for
The projection these were generated from predated the compute migration, so
they described /v1/visor — which the API serves at zero paths now.

No /v1/visor path survives here.
2026-09-05 18:55:38 -07:00

740 lines
46 KiB
Swift

//
// ComplianceAPI.swift
//
// Generated by openapi-generator
// https://openapi-generator.tech
//
import Foundation
open class ComplianceAPI {
/**
Returns the org's tracked accreditation-state records, newest first — evidence entries the org keeps, never a platform certification.
- parameter limit: (query) Limit caps the rows returned; non-positive means the server default. (optional)
- parameter apiConfiguration: The configuration for the http request.
- returns: AccList
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func getComplianceAccreditation(limit: Int64? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> AccList {
return try await getComplianceAccreditationWithRequestBuilder(limit: limit, apiConfiguration: apiConfiguration).execute().body
}
/**
Returns the org's tracked accreditation-state records, newest first — evidence entries the org keeps, never a platform certification.
- GET /v1/compliance/accreditation
- Returns the org's tracked accreditation-state records, newest first — evidence entries the org keeps, never a platform certification.
- Bearer Token:
- type: http
- name: bearer
- parameter limit: (query) Limit caps the rows returned; non-positive means the server default. (optional)
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<AccList>
*/
open class func getComplianceAccreditationWithRequestBuilder(limit: Int64? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<AccList> {
let localVariablePath = "/v1/compliance/accreditation"
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
var localVariableUrlComponents = URLComponents(string: localVariableURLString)
localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([
"limit": (wrappedValue: limit?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
])
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<AccList>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "GET", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Returns one tracked accreditation record.
- parameter id: (path) ID is the accreditation record to read, from the path.
- parameter apiConfiguration: The configuration for the http request.
- returns: AccView
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func getComplianceAccreditationById(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> AccView {
return try await getComplianceAccreditationByIdWithRequestBuilder(id: id, apiConfiguration: apiConfiguration).execute().body
}
/**
Returns one tracked accreditation record.
- GET /v1/compliance/accreditation/{id}
- Returns one tracked accreditation record.
- Bearer Token:
- type: http
- name: bearer
- parameter id: (path) ID is the accreditation record to read, from the path.
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<AccView>
*/
open class func getComplianceAccreditationByIdWithRequestBuilder(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<AccView> {
var localVariablePath = "/v1/compliance/accreditation/{id}"
let idPreEscape = "\(APIHelper.mapValueToPathItem(id))"
let idPostEscape = idPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
localVariablePath = localVariablePath.replacingOccurrences(of: "{id}", with: idPostEscape, options: .literal, range: nil)
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<AccView>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "GET", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
AuditRead is the compliance read of the SHARED tamper-evident audit plane — the SOC 2 posture surface (privileged actions: who started/decided what, when).
- parameter result: (query) Result filters rows by outcome result: success, deny, or error; empty means all. (optional)
- parameter apiConfiguration: The configuration for the http request.
- returns: AuditList
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func getComplianceAudit(result: String? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> AuditList {
return try await getComplianceAuditWithRequestBuilder(result: result, apiConfiguration: apiConfiguration).execute().body
}
/**
AuditRead is the compliance read of the SHARED tamper-evident audit plane — the SOC 2 posture surface (privileged actions: who started/decided what, when).
- GET /v1/compliance/audit
- AuditRead is the compliance read of the SHARED tamper-evident audit plane — the SOC 2 posture surface (privileged actions: who started/decided what, when). The org is PINNED to the caller's validated org and the rows are narrowed to compliance.* actions. Fail-closed: no principal is a 403, no configured audit store a 501.
- Bearer Token:
- type: http
- name: bearer
- parameter result: (query) Result filters rows by outcome result: success, deny, or error; empty means all. (optional)
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<AuditList>
*/
open class func getComplianceAuditWithRequestBuilder(result: String? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<AuditList> {
let localVariablePath = "/v1/compliance/audit"
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
var localVariableUrlComponents = URLComponents(string: localVariableURLString)
localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([
"result": (wrappedValue: result?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
])
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<AuditList>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "GET", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Health reports subsystem liveness and the wired verification provider.
- parameter apiConfiguration: The configuration for the http request.
- returns: HealthView
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func getComplianceHealth(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> HealthView {
return try await getComplianceHealthWithRequestBuilder(apiConfiguration: apiConfiguration).execute().body
}
/**
Health reports subsystem liveness and the wired verification provider.
- GET /v1/compliance/health
- Health reports subsystem liveness and the wired verification provider. Fail-open on purpose: it never probes the external provider, so a provider outage cannot fail liveness.
- Bearer Token:
- type: http
- name: bearer
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<HealthView>
*/
open class func getComplianceHealthWithRequestBuilder(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<HealthView> {
let localVariablePath = "/v1/compliance/health"
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<HealthView>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "GET", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
ListRecords is the unified compliance-record view for the org: its verifications and accreditation records together, each provider-reported or tracked, never platform-asserted.
- parameter limit: (query) Limit caps the rows returned; non-positive means the server default. (optional)
- parameter apiConfiguration: The configuration for the http request.
- returns: RecordList
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func getComplianceRecords(limit: Int64? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> RecordList {
return try await getComplianceRecordsWithRequestBuilder(limit: limit, apiConfiguration: apiConfiguration).execute().body
}
/**
ListRecords is the unified compliance-record view for the org: its verifications and accreditation records together, each provider-reported or tracked, never platform-asserted.
- GET /v1/compliance/records
- ListRecords is the unified compliance-record view for the org: its verifications and accreditation records together, each provider-reported or tracked, never platform-asserted. PII stays in the subject store; records carry only opaque ids and statuses.
- Bearer Token:
- type: http
- name: bearer
- parameter limit: (query) Limit caps the rows returned; non-positive means the server default. (optional)
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<RecordList>
*/
open class func getComplianceRecordsWithRequestBuilder(limit: Int64? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<RecordList> {
let localVariablePath = "/v1/compliance/records"
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
var localVariableUrlComponents = URLComponents(string: localVariableURLString)
localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([
"limit": (wrappedValue: limit?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
])
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<RecordList>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "GET", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Status is the org's honest posture read: the wired provider and the per-status tally of its verifications.
- parameter apiConfiguration: The configuration for the http request.
- returns: StatusView
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func getComplianceStatus(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> StatusView {
return try await getComplianceStatusWithRequestBuilder(apiConfiguration: apiConfiguration).execute().body
}
/**
Status is the org's honest posture read: the wired provider and the per-status tally of its verifications.
- GET /v1/compliance/status
- Status is the org's honest posture read: the wired provider and the per-status tally of its verifications. It is deliberately NOT a boolean \"compliant\" — it reports counts of provider-reported states and carries the boundary disclaimer.
- Bearer Token:
- type: http
- name: bearer
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<StatusView>
*/
open class func getComplianceStatusWithRequestBuilder(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<StatusView> {
let localVariablePath = "/v1/compliance/status"
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<StatusView>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "GET", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Returns the org's subjects as PII-MINIMIZED summaries — no name or email, only whether an email is on file.
- parameter limit: (query) Limit caps the rows returned; non-positive means the server default. (optional)
- parameter apiConfiguration: The configuration for the http request.
- returns: SubjectList
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func getComplianceSubjects(limit: Int64? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> SubjectList {
return try await getComplianceSubjectsWithRequestBuilder(limit: limit, apiConfiguration: apiConfiguration).execute().body
}
/**
Returns the org's subjects as PII-MINIMIZED summaries — no name or email, only whether an email is on file.
- GET /v1/compliance/subjects
- Returns the org's subjects as PII-MINIMIZED summaries — no name or email, only whether an email is on file. The full record is returned only by the explicit single-subject read.
- Bearer Token:
- type: http
- name: bearer
- parameter limit: (query) Limit caps the rows returned; non-positive means the server default. (optional)
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<SubjectList>
*/
open class func getComplianceSubjectsWithRequestBuilder(limit: Int64? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<SubjectList> {
let localVariablePath = "/v1/compliance/subjects"
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
var localVariableUrlComponents = URLComponents(string: localVariableURLString)
localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([
"limit": (wrappedValue: limit?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
])
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<SubjectList>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "GET", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Returns one subject WITH its contact PII — the only surface that returns it, and only to the owning org.
- parameter id: (path) ID is the subject to read, from the path.
- parameter apiConfiguration: The configuration for the http request.
- returns: Subject
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func getComplianceSubjectsById(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> Subject {
return try await getComplianceSubjectsByIdWithRequestBuilder(id: id, apiConfiguration: apiConfiguration).execute().body
}
/**
Returns one subject WITH its contact PII — the only surface that returns it, and only to the owning org.
- GET /v1/compliance/subjects/{id}
- Returns one subject WITH its contact PII — the only surface that returns it, and only to the owning org. The response is never cached by any intermediary.
- Bearer Token:
- type: http
- name: bearer
- parameter id: (path) ID is the subject to read, from the path.
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<Subject>
*/
open class func getComplianceSubjectsByIdWithRequestBuilder(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Subject> {
var localVariablePath = "/v1/compliance/subjects/{id}"
let idPreEscape = "\(APIHelper.mapValueToPathItem(id))"
let idPostEscape = idPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
localVariablePath = localVariablePath.replacingOccurrences(of: "{id}", with: idPostEscape, options: .literal, range: nil)
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<Subject>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "GET", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Returns the org's KYC/KYB verifications, newest first — opaque subject references and provider-reported statuses only, no subject PII.
- parameter limit: (query) Limit caps the rows returned; non-positive means the server default. (optional)
- parameter apiConfiguration: The configuration for the http request.
- returns: CheckList
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func getComplianceVerifications(limit: Int64? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> CheckList {
return try await getComplianceVerificationsWithRequestBuilder(limit: limit, apiConfiguration: apiConfiguration).execute().body
}
/**
Returns the org's KYC/KYB verifications, newest first — opaque subject references and provider-reported statuses only, no subject PII.
- GET /v1/compliance/verifications
- Returns the org's KYC/KYB verifications, newest first — opaque subject references and provider-reported statuses only, no subject PII.
- Bearer Token:
- type: http
- name: bearer
- parameter limit: (query) Limit caps the rows returned; non-positive means the server default. (optional)
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<CheckList>
*/
open class func getComplianceVerificationsWithRequestBuilder(limit: Int64? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<CheckList> {
let localVariablePath = "/v1/compliance/verifications"
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
var localVariableUrlComponents = URLComponents(string: localVariableURLString)
localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([
"limit": (wrappedValue: limit?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
])
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<CheckList>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "GET", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Returns one verification — its opaque subject reference and provider-reported status, no subject PII.
- parameter id: (path) ID is the verification to act on, from the path.
- parameter apiConfiguration: The configuration for the http request.
- returns: CheckView
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func getComplianceVerificationsById(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> CheckView {
return try await getComplianceVerificationsByIdWithRequestBuilder(id: id, apiConfiguration: apiConfiguration).execute().body
}
/**
Returns one verification — its opaque subject reference and provider-reported status, no subject PII.
- GET /v1/compliance/verifications/{id}
- Returns one verification — its opaque subject reference and provider-reported status, no subject PII.
- Bearer Token:
- type: http
- name: bearer
- parameter id: (path) ID is the verification to act on, from the path.
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<CheckView>
*/
open class func getComplianceVerificationsByIdWithRequestBuilder(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<CheckView> {
var localVariablePath = "/v1/compliance/verifications/{id}"
let idPreEscape = "\(APIHelper.mapValueToPathItem(id))"
let idPostEscape = idPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
localVariablePath = localVariablePath.replacingOccurrences(of: "{id}", with: idPostEscape, options: .literal, range: nil)
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<CheckView>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "GET", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Records an ASSERTED accreditation state for a subject — the subject's own assertion, with no verifier.
- parameter accreditationReq: (body)
- parameter apiConfiguration: The configuration for the http request.
- returns: AccView
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func postComplianceAccreditation(accreditationReq: AccreditationReq, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> AccView {
return try await postComplianceAccreditationWithRequestBuilder(accreditationReq: accreditationReq, apiConfiguration: apiConfiguration).execute().body
}
/**
Records an ASSERTED accreditation state for a subject — the subject's own assertion, with no verifier.
- POST /v1/compliance/accreditation
- Records an ASSERTED accreditation state for a subject — the subject's own assertion, with no verifier. Every CONFIRMED state (provider_verified, reviewer_confirmed) and every rejected/expired state is a DECISION recorded via the decision endpoint, attributed to the reviewer — a create can never stamp a confirmation. The underlying figures (income, net worth) are never stored; only the method, category, and state.
- Bearer Token:
- type: http
- name: bearer
- parameter accreditationReq: (body)
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<AccView>
*/
open class func postComplianceAccreditationWithRequestBuilder(accreditationReq: AccreditationReq, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<AccView> {
let localVariablePath = "/v1/compliance/accreditation"
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: accreditationReq, codableHelper: apiConfiguration.codableHelper)
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
"Content-Type": "application/json",
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<AccView>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Records an org reviewer's decision on an accreditation record — a reviewer confirmation, a provider verification the reviewer has evidence of (a CPA/attorney letter, a verifier report), a rejection, or an expiry.
- parameter id: (path) ID is the accreditation record to decide, from the path.
- parameter accreditationDecision: (body)
- parameter apiConfiguration: The configuration for the http request.
- returns: AccView
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func postComplianceAccreditationByIdDecision(id: String, accreditationDecision: AccreditationDecision, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> AccView {
return try await postComplianceAccreditationByIdDecisionWithRequestBuilder(id: id, accreditationDecision: accreditationDecision, apiConfiguration: apiConfiguration).execute().body
}
/**
Records an org reviewer's decision on an accreditation record — a reviewer confirmation, a provider verification the reviewer has evidence of (a CPA/attorney letter, a verifier report), a rejection, or an expiry.
- POST /v1/compliance/accreditation/{id}/decision
- Records an org reviewer's decision on an accreditation record — a reviewer confirmation, a provider verification the reviewer has evidence of (a CPA/attorney letter, a verifier report), a rejection, or an expiry. ROLE-GATED (an org admin or platform reviewer) and ATTRIBUTED: the reviewer's identity is recorded as ReviewerSub and audited. Human-in-the-loop: the platform never confirms on its own, and even a provider_verified state carries the reviewer who recorded it.
- Bearer Token:
- type: http
- name: bearer
- parameter id: (path) ID is the accreditation record to decide, from the path.
- parameter accreditationDecision: (body)
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<AccView>
*/
open class func postComplianceAccreditationByIdDecisionWithRequestBuilder(id: String, accreditationDecision: AccreditationDecision, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<AccView> {
var localVariablePath = "/v1/compliance/accreditation/{id}/decision"
let idPreEscape = "\(APIHelper.mapValueToPathItem(id))"
let idPostEscape = idPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
localVariablePath = localVariablePath.replacingOccurrences(of: "{id}", with: idPostEscape, options: .literal, range: nil)
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: accreditationDecision, codableHelper: apiConfiguration.codableHelper)
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
"Content-Type": "application/json",
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<AccView>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Records a party the org is verifying as part of its own onboarding/compliance — a team member, vendor, customer, or counterparty.
- parameter subjectReq: (body)
- parameter apiConfiguration: The configuration for the http request.
- returns: Subject
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func postComplianceSubjects(subjectReq: SubjectReq, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> Subject {
return try await postComplianceSubjectsWithRequestBuilder(subjectReq: subjectReq, apiConfiguration: apiConfiguration).execute().body
}
/**
Records a party the org is verifying as part of its own onboarding/compliance — a team member, vendor, customer, or counterparty.
- POST /v1/compliance/subjects
- Records a party the org is verifying as part of its own onboarding/compliance — a team member, vendor, customer, or counterparty. The subject's contact PII (name/email) is sealed at rest and returned only to the owning org; downstream records reference the subject by opaque id.
- Bearer Token:
- type: http
- name: bearer
- parameter subjectReq: (body)
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<Subject>
*/
open class func postComplianceSubjectsWithRequestBuilder(subjectReq: SubjectReq, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Subject> {
let localVariablePath = "/v1/compliance/subjects"
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: subjectReq, codableHelper: apiConfiguration.codableHelper)
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
"Content-Type": "application/json",
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<Subject>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Begins a KYC/KYB verification of a subject through the wired provider — an existing subject by id, or one created inline from the request.
- parameter verificationReq: (body)
- parameter apiConfiguration: The configuration for the http request.
- returns: CheckView
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func postComplianceVerifications(verificationReq: VerificationReq, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> CheckView {
return try await postComplianceVerificationsWithRequestBuilder(verificationReq: verificationReq, apiConfiguration: apiConfiguration).execute().body
}
/**
Begins a KYC/KYB verification of a subject through the wired provider — an existing subject by id, or one created inline from the request.
- POST /v1/compliance/verifications
- Begins a KYC/KYB verification of a subject through the wired provider — an existing subject by id, or one created inline from the request. The returned status is provider-reported and never terminal on a fresh start: starting a verification can never yield a verified record, and a provider error is a 502, never a verification.
- Bearer Token:
- type: http
- name: bearer
- parameter verificationReq: (body)
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<CheckView>
*/
open class func postComplianceVerificationsWithRequestBuilder(verificationReq: VerificationReq, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<CheckView> {
let localVariablePath = "/v1/compliance/verifications"
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: verificationReq, codableHelper: apiConfiguration.codableHelper)
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
"Content-Type": "application/json",
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<CheckView>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Records a privileged reviewer's MANUAL decision on a verification — the human-in-the-loop path, and the ONLY route to a passing status when no real provider is wired.
- parameter id: (path) ID is the verification to decide, from the path.
- parameter verificationDecision: (body)
- parameter apiConfiguration: The configuration for the http request.
- returns: CheckView
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func postComplianceVerificationsByIdDecision(id: String, verificationDecision: VerificationDecision, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> CheckView {
return try await postComplianceVerificationsByIdDecisionWithRequestBuilder(id: id, verificationDecision: verificationDecision, apiConfiguration: apiConfiguration).execute().body
}
/**
Records a privileged reviewer's MANUAL decision on a verification — the human-in-the-loop path, and the ONLY route to a passing status when no real provider is wired.
- POST /v1/compliance/verifications/{id}/decision
- Records a privileged reviewer's MANUAL decision on a verification — the human-in-the-loop path, and the ONLY route to a passing status when no real provider is wired. It produces a DISTINCT reviewer_confirmed, never a provider_verified (a provider decision is the provider's to report, via the webhook or a reconcile), and it is ROLE-GATED (an org admin or platform reviewer) AND ATTRIBUTED (the reviewer's user id is DecidedBy), so a manual pass is always accountable.
- Bearer Token:
- type: http
- name: bearer
- parameter id: (path) ID is the verification to decide, from the path.
- parameter verificationDecision: (body)
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<CheckView>
*/
open class func postComplianceVerificationsByIdDecisionWithRequestBuilder(id: String, verificationDecision: VerificationDecision, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<CheckView> {
var localVariablePath = "/v1/compliance/verifications/{id}/decision"
let idPreEscape = "\(APIHelper.mapValueToPathItem(id))"
let idPostEscape = idPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
localVariablePath = localVariablePath.replacingOccurrences(of: "{id}", with: idPostEscape, options: .literal, range: nil)
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: verificationDecision, codableHelper: apiConfiguration.codableHelper)
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
"Content-Type": "application/json",
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<CheckView>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Polls the wired provider for its current decision and records it, ATTRIBUTED to the provider — the internal PULL reconcile.
- parameter id: (path) ID is the verification to act on, from the path.
- parameter apiConfiguration: The configuration for the http request.
- returns: CheckView
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func postComplianceVerificationsByIdRefresh(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> CheckView {
return try await postComplianceVerificationsByIdRefreshWithRequestBuilder(id: id, apiConfiguration: apiConfiguration).execute().body
}
/**
Polls the wired provider for its current decision and records it, ATTRIBUTED to the provider — the internal PULL reconcile.
- POST /v1/compliance/verifications/{id}/refresh
- Polls the wired provider for its current decision and records it, ATTRIBUTED to the provider — the internal PULL reconcile. For the Manual provider the check stays pending; for a hosted provider it reflects the provider's settled status. A poll error is a 502, never a verification.
- Bearer Token:
- type: http
- name: bearer
- parameter id: (path) ID is the verification to act on, from the path.
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<CheckView>
*/
open class func postComplianceVerificationsByIdRefreshWithRequestBuilder(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<CheckView> {
var localVariablePath = "/v1/compliance/verifications/{id}/refresh"
let idPreEscape = "\(APIHelper.mapValueToPathItem(id))"
let idPostEscape = idPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
localVariablePath = localVariablePath.replacingOccurrences(of: "{id}", with: idPostEscape, options: .literal, range: nil)
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<CheckView>.Type = apiConfiguration.requestBuilderFactory.getBuilder()
return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
/**
Provider push that settles a verification, authenticated by HMAC signature
- parameter apiConfiguration: The configuration for the http request.
- returns: Void
*/
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open class func postComplianceVerificationsWebhook(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) {
return try await postComplianceVerificationsWebhookWithRequestBuilder(apiConfiguration: apiConfiguration).execute().body
}
/**
Provider push that settles a verification, authenticated by HMAC signature
- POST /v1/compliance/verifications/webhook
- The external PUSH reconcile: a verification provider (or a Hanzo relay) signals that a check settled, and the reconciled check comes back. It authenticates by an HMAC SIGNATURE over the RAW body bytes rather than by a principal — an external caller has no validated org — and the org is then resolved FROM the record the signed provider reference matches, so a call can only ever touch the one tenant that owns that reference. The body carries NO trusted decision. A valid signature cannot force a status: the reference only says WHICH check to re-read, and the status is then pulled from the wired provider, which stays the source of truth. With no real provider configured a check stays pending, and the only route to a passing status is the role-gated, attributed reviewer decision. An unknown reference is a benign 200 `{\"ignored\": ...}` no-op, not an error, so a provider replaying stale events neither retry-storms nor learns whether a reference exists in some other tenant. Fails closed otherwise: 501 unless a webhook secret is configured, 401 on a signature that does not verify, 400 with no provider reference, 413 over 1 MiB, and 502 if the secret or the provider is unreachable.
- Bearer Token:
- type: http
- name: bearer
- parameter apiConfiguration: The configuration for the http request.
- returns: RequestBuilder<Void>
*/
open class func postComplianceVerificationsWebhookWithRequestBuilder(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Void> {
let localVariablePath = "/v1/compliance/verifications/webhook"
let localVariableURLString = apiConfiguration.basePath + localVariablePath
let localVariableParameters: [String: any Sendable]? = nil
let localVariableUrlComponents = URLComponents(string: localVariableURLString)
let localVariableNillableHeaders: [String: (any Sendable)?] = [
:
]
let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)
let localVariableRequestBuilder: RequestBuilder<Void>.Type = apiConfiguration.requestBuilderFactory.getNonDecodableBuilder()
return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
}
}