Skip to content
You are reading the Ratify Protocol v2 beta documentation. Protocol v1 remains available at the site root.

SDK reference (v2)

The v2 SDKs implement the same specification with names that follow each language’s conventions. Inputs, outputs, error classes, ordering, and results are identical across them.

SDK Package Registry
Go github.com/identities-ai/ratify-protocol/v2 Go module proxy
TypeScript @identities-ai/ratify-protocol (import from /v2) npm, dist-tag next
Python ratify-protocol 2.x with the protocol-v2 extra (pulls in the native backend ratify-protocol-native-v2), import ratify_protocol.v2 PyPI
Rust crate ratify-protocol (module ratify_protocol::v2) crates.io
C ratify-c 2.x ABI (ratify.h, functions prefixed ratify_v2_) GitHub release archive, or a source build from the release tag
Swift RatifyProtocol for iOS 17+ and macOS 14+ SwiftPM from the tagged repository; checksummed XCFramework on GitHub Releases
Kotlin com.ratifyprotocol:ratify-protocol for Android API 28+ Maven Central; ratify-protocol-testing is a separate test dependency

Main entry points in the original five SDKs

Section titled “Main entry points in the original five SDKs”
Step Go TypeScript Python Rust C
Key ID KeyIDV2 keyIDV2 key_id_v2 key_id_v2 ratify_v2_key_id
Issue a challenge IssueChallengeV2 issueChallengeV2 issue_challenge_v2 issue_challenge_v2 ratify_v2_issue_challenge
Verify (commit) VerifyProofBundleV2 verifyProofBundleV2 verify_proof_bundle_v2 verify_proof_bundle_v2 ratify_v2_verify_proof_bundle
Release ReleaseV2Decision releaseV2Decision release_v2_decision release_v2_decision ratify_v2_release_decision
Action check Allowed allowed allowed allowed ratify_v2_released_allowed

Generated API documentation for each package is linked from its page. The Swift and Kotlin pages explain their typed APIs, package products, and production store requirements.