Sep31Sep12TypesInfo

data class Sep31Sep12TypesInfo(val senderTypes: Map<String, String>, val receiverTypes: Map<String, String>)

KYC type definitions for sender and receiver customers in a SEP-31 asset offering.

Captures the parsed sep12.sender.types and sep12.receiver.types sub-maps from the SEP-31 GET /info response. Each map associates a SEP-12 customer type identifier (the value passed as the type parameter to SEP-12 GET /customer) with a human-readable description supplied by the Receiving Anchor.

Usage

val info = sep31Service.info(jwt = jwt)
val usdc = info.receiveAssets["USDC"] ?: return
for ((typeId, description) in usdc.sep12Info.senderTypes) {
println("Sender type $typeId: $description")
}

Example JSON (excerpt from GET /info)

{
"sep12": {
"sender": {
"types": {
"sep31-sender": { "description": "U.S. citizens limited to sending payments of less than $10,000 in value" }
}
},
"receiver": {
"types": {
"sep31-receiver": { "description": "U.S. citizens receiving USD" }
}
}
}
}

See also

Constructors

Link copied to clipboard
constructor(senderTypes: Map<String, String>, receiverTypes: Map<String, String>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Map of SEP-12 receiver type identifier to human-readable description. Empty when the anchor omits sep12.receiver.types.

Link copied to clipboard

Map of SEP-12 sender type identifier to human-readable description. Empty when the anchor omits sep12.sender.types.