Documentation Index
Fetch the complete documentation index at: https://developer.prove.com/llms.txt
Use this file to discover all available pages before exploring further.
Use this guide when you already have an application and need Prove packages and Sandbox configuration in the repo. Complete server steps for any backend that calls Prove Platform APIs. Add one client tab (Web, Android, or iOS) only if your product runs possession (Prove Key, Mobile Auth, OTP, and so on) in that client. For a first bearer token and curl to Prove without an SDK, use Get started with Prove API authentication first.
Prerequisites
- Sandbox credentials — OAuth client ID and client secret from the Developer Portal for the project you are integrating.
- Tooling — Language runtime and package manager for your stack (for example Go modules, npm, Gradle/Maven, .NET CLI, CocoaPods).
Install the server-side SDK
Add the Prove server SDK for your language using your normal dependency workflow.# The Go library is hosted on GitHub so you can use this command to import it
# to your Go application.
go get github.com/prove-identity/prove-sdk-server-go
# Ensure you import the SDK in your code like this:
import (
provesdkservergo "github.com/prove-identity/prove-sdk-server-go"
"github.com/prove-identity/prove-sdk-server-go/models/components"
)
Configure Sandbox credentials in code
Initialize the SDK with your Sandbox client ID and client secret from environment variables or your secrets store (see Secure API credentials).clientID := os.Getenv("PROVE_CLIENT_ID")
clientSecret := os.Getenv("PROVE_CLIENT_SECRET")
proveEnv := "uat-us" // Use UAT in US region.
client := provesdkservergo.New(
provesdkservergo.WithServer(proveEnv),
provesdkservergo.WithSecurity(components.Security{
ClientID: provesdkservergo.String(clientID),
ClientSecret: provesdkservergo.String(clientSecret),
}),
)
Replace uat-us with uat-eu if you are testing outside North America.
(Optional) Install the client-side SDK
Add a client SDK only when your UX runs Prove possession in the browser or native app. Pick one tab below. Web SDK
Android SDK
iOS SDK
# Run this command to install the package (ensure you have the latest version).
npm install @prove-identity/prove-auth@3.4.2
If you’re including the file from jsDelivr and using Content Security Policy headers, ensure you add https://cdn.jsdelivr.net/npm/@prove-identity/ to script-src,
plus corresponding sha256-... or nonce-.... Prove hosts Android binaries in a Maven repository for Gradle.Update the dependencies block in build.gradle:dependencies {
// Existing dependencies are here.
// Add the Prove Link dependencies:
implementation 'com.prove.sdk:proveauth:6.10.7'
}
settings.gradle at the Prove Maven repository:dependencyResolutionManagement {
// Existing repository settings are here.
repositories {
// Existing repositories are here.
// Add the Prove Link Maven repository:
maven {
url = "https://prove.jfrog.io/artifactory/libs-public-maven/"
}
}
}
build.gradle so dependency libraries resolve:dependencies {
implementation fileTree('libs')
}
application@fullBackupContent, add this attribute on the opening <application> tag in AndroidManifest.xml:<application
...
tools:replace="android:fullBackupContent"
...>
</application>
Prove hosts iOS artifacts for CocoaPods integration.Run the following to register the Prove pod repo and install pods:# Run this command to install the cocoapods-art plugin (authored by Artifactory)
gem install cocoapods-art
# Run this command to add the Prove pod repository
pod repo-art add prove.jfrog.io https://prove.jfrog.io/artifactory/api/pods/libs-public-cocoapods
# In your Podfile, paste in the Prove pod repository as a source
plugin 'cocoapods-art', :sources => [
'prove.jfrog.io'
]
# In your Podfile, paste in the SDK pods
pod 'ProveAuth', '6.10.4'
# Run this command to install the SDK pods
pod install
Verify your setup
- Server — Project restores or builds with the new dependency; imports resolve with no version conflicts.
- Credentials — At runtime, the client ID and secret your code reads match the Sandbox credentials from the Developer Portal for the intended region (
uat-us vs uat-eu).
- Client (if installed) — Package or pods install completes; for native apps, open the project in Xcode or Android Studio and confirm the Prove modules are linked.
