OctetVerdict

The outcome of a predicate call. Returned by isWithin, isOutside, contains on OctetSdk.loc.

Shape

public struct OctetVerdict: Sendable {
    public let result: Result
    public let reason: ReasonCode
    public let message: String
    public let proof: LocationProof?
    public let validity: Interval?
    public let queriedAt: Date
    public let confidence: ConfidenceSummary
    public let achievableLevel: ProofLevel?   // non-nil only when reason == .insufficientPrecision

    public enum Result: Sendable, Hashable {
        case yes, no, indeterminate
    }

    public enum ReasonCode: Sendable, Hashable {
        case ok
        case noFix
        case futureTime
        case staleFix
        case noProofAtResolution
        case insufficientPrecision
        case attestationFailed
        case mockLocationDetected
        case sdkNotRunning
        case notYetReleased
        case invalidSessionNonce
        case invalidDecisionRef
        case invalidDecisionTime
        case spoofingDetected
        case tampering
        case regionUnresolved
        case permissionRequired
        case invalidCallerContent
        case callerContentNotEnabled
        case licenseInactive
    }
}

data class OctetVerdict(
    val result: Result,
    val reason: ReasonCode,
    val message: String,
    val proof: LocationProof?,
    val validity: Interval?,
    val queriedAt: Instant,
    val confidence: ConfidenceSummary,
    val achievableLevel: ProofLevel? = null,  // non-null only when reason == INSUFFICIENT_PRECISION
) {
    enum class Result { YES, NO, INDETERMINATE }

    enum class ReasonCode {
        OK, NO_FIX, FUTURE_TIME, STALE_FIX, NO_PROOF_AT_RESOLUTION,
        INSUFFICIENT_PRECISION, ATTESTATION_FAILED, MOCK_LOCATION_DETECTED,
        SDK_NOT_RUNNING, NOT_YET_RELEASED, INVALID_SESSION_NONCE,
        INVALID_DECISION_REF, INVALID_DECISION_TIME, SPOOFING_DETECTED, TAMPERING, REGION_UNRESOLVED,
        PERMISSION_REQUIRED, INVALID_CALLER_CONTENT, CALLER_CONTENT_NOT_ENABLED, LICENSE_INACTIVE,
    }
}

Field invariants

• proof is nil/null iff result == .indeterminate/INDETERMINATE. Enforced as a precondition / require at construction. A YES or NO always carries a proof. An INDETERMINATE never does.
• validity is non-nil exactly when proof is non-nil. Both move together.
• queriedAt is the atTime that was passed in. Echoed back so callers do not have to thread it themselves.
• confidence is always populated, even for INDETERMINATE (with an empty summary in that case). Since 3.1 it holds neutral values. See confidence.
• achievableLevel is non-nil only when reason == .insufficientPrecision. It names the best proof level the SDK could reach for this query right now. New in 1.1. The SDK never falls back to this level automatically.

Near a border between two subdivisions, a device whose accuracy area crosses that border can only be proven at the country level. A subdivision query returns insufficientPrecision with achievableLevel country, and a policy that accepts only one of the two subdivisions sees the device as unknown, not as inside or outside. See Regions.

result

Never collapse .indeterminate to .no silently. See Verdicts for the rationale.

reason

Adversarial and benign reasons

Added in 2.0, the measurement-related INDETERMINATE reasons split into two classes so a policy layer can treat them differently. The remaining reasons come from the calling code or the SDK build:

• Adversarial (a detected forgery or compromise): spoofingDetected, mockLocationDetected, tampering, attestationFailed. A policy layer should deny these.
• Benign (the SDK could not measure): regionUnresolved, insufficientPrecision, noFix, staleFix, futureTime, noProofAtResolution. A policy layer can permit these with a step-up. noProofAtResolution means the proof on hand is too coarse for the question: ask again, or ask at the level the proof covers.
• Caller or availability (fix the call, not the device): sdkNotRunning, notYetReleased, invalidSessionNonce, invalidDecisionRef, invalidDecisionTime, invalidCallerContent, callerContentNotEnabled. None of these is adversarial. Fix the calling code rather than stepping up the user.
• Permission and license: permissionRequired means your app must ask for the permission. licenseInactive points to your license, not to the user or the device.

Both classes carry no proof. The distinction is in the reason, not the result.

message

message is a free-form string for log lines and debug UI. Its wording can change between SDK versions. Use reason for control flow, not message.

proof

LocationProof is the signed protobuf that a verifier checks against Octet's public keys. Its full shape is part of the protocol, not the SDK's public surface. See Serialization for the v1 alpha caveat about how LocationProof is currently rendered through .toJson().

For most integrators the proof is opaque. Forward it to your verifier as-is.

The assurance tier

LocationProof.spoofingVerdict is the proof's assurance tier. Since 3.1 it is UNSPECIFIED, and the answer is result. If your license includes the tier, it reads VERIFIED (independent evidence supports the fix) or PLAUSIBLE (the fix is consistent with your query but not independently corroborated), also as spoofing_verdict in the proof JSON. A disc query (contains(...) or a disc isWithin(...)) applies its tier rule either way. See Predicates.

validity

The interval over which the underlying proof answers the predicate as stated. It does not predict how long the verdict will stay true. See Time Semantics.

public struct Interval: Sendable, Hashable {
    public let from: Date
    public let to: Date
}

data class Interval(val from: Instant, val to: Instant)

Inclusive-inclusive, from <= to.

confidence

ConfidenceSummary is always present. Since 3.1 it holds neutral values (a score of 0 and empty lists), and .toStr() prints no conf=. Act on result and reason, with no threshold to pick. overallScore, spoofingRiskScore, sensorContributions and flags are deprecated and are removed in 4.0.

If you need more device intelligence or your own scoring logic, Octet offers it as a custom feature or license.

See also

• Verdicts. Why the trichotomy matters.
• Time Semantics. How validity and queriedAt interact.
• Serialization. .toStr() / .toJson() / .toJsonl() on verdicts.