FrameSDK/com.framepayments.framesdk.configurations/ConfigurationResponses/GetFingerprintConfigurationResponse

GetFingerprintConfigurationResponse

data class GetFingerprintConfigurationResponse(val apiKey: String? = null, val region: String? = null, val environment: String? = null)

Holds the Fingerprint credentials returned by the configuration endpoint.

The three fields are one credential, not three settings. A key only works in the region it was minted for, and environment names the regime that key belongs to — so they are cached and read as a unit, never merged field by field against an older copy.

Constructors

constructor(apiKey: String? = null, region: String? = null, environment: String? = null)

Properties

apiKey

@SerializedName(value = "api_key")

val apiKey: String? = null

The Fingerprint public API key.

environment

@SerializedName(value = "environment")

val environment: String? = null

The Fingerprint environment the key belongs to ("sealed" or "legacy"). The API answers a capability it did not recognize with the legacy key and HTTP 200, so this stamp is the only way a client can tell which regime it was actually served.

hasEnvironmentStamp

val hasEnvironmentStamp: Boolean

Whether the response names the environment its key belongs to. A cached copy without one was written before this build began declaring a capability, so nothing about it says which regime its key is from.

isSealed

val isSealed: Boolean

Whether the served credentials belong to the sealed environment.

region

@SerializedName(value = "region")

val region: String? = null

The Fingerprint region associated with the API key (e.g. "us", "eu", "ap").