stellar-sdk/com.soneso.stellar.sdk.sep.sep12

Package-level declarations

Types

Verifies callback signatures from SEP-12 anchor servers.

@Serializable

data class CustomerFileResponse(val fileId: String, val contentType: String, val size: Long, val customerId: String? = null, val expiresAt: String? = null)

Response from a POST /customer/files request or part of GET /customer/files response.

Status of the customer's KYC process in SEP-12.

Verification status of individual KYC fields in SEP-12.

@Serializable

Response from a GET /customer/files request containing information about uploaded files.

@Serializable

data class GetCustomerInfoField(val type: String, val description: String, val choices: List<String>? = null, val optional: Boolean? = null)

Represents a field that the anchor needs from the customer in SEP-12.

@Serializable

data class GetCustomerInfoProvidedField(val type: String, val description: String, val choices: List<String>? = null, val optional: Boolean? = null, val status: FieldStatus? = null, val error: String? = null)

Represents a field that the anchor has already received from the customer in SEP-12.

data class GetCustomerInfoRequest(val jwt: String, val id: String? = null, val account: String? = null, val memo: String? = null, val memoType: String? = null, val type: String? = null, val transactionId: String? = null, val lang: String? = null)

Request for retrieving customer KYC information and status from a SEP-12 anchor.

@Serializable

data class GetCustomerInfoResponse(val id: String? = null, val status: CustomerStatus, val fields: Map<String, GetCustomerInfoField>? = null, val providedFields: Map<String, GetCustomerInfoProvidedField>? = null, val message: String? = null)

Response from a GET /customer request containing customer KYC status and field requirements.

class KYCService(serviceAddress: String, httpClient: HttpClient? = null, httpRequestHeaders: Map<String, String>? = null)

SEP-12 KYC (Know Your Customer) API client.

data class PutCustomerCallbackRequest(val jwt: String, val url: String, val id: String? = null, val account: String? = null, val memo: String? = null)

Request for registering a callback URL to receive KYC status updates from a SEP-12 anchor.

data class PutCustomerInfoRequest(val jwt: String, val id: String? = null, val account: String? = null, val memo: String? = null, val memoType: String? = null, val type: String? = null, val transactionId: String? = null, val kycFields: StandardKYCFields? = null, val customFields: Map<String, String>? = null, val customFiles: Map<String, ByteArray>? = null, val verificationFields: Map<String, String>? = null, val fileReferences: Map<String, String>? = null)

Request for uploading or updating customer KYC information in SEP-12.

@Serializable

Response from a PUT /customer request after uploading or updating customer information.

data class ~~PutCustomerVerificationRequest~~(val jwt: String, val id: String, val verificationFields: Map<String, String>)

Request for verifying customer information fields using confirmation codes.