stellar-sdk/com.soneso.stellar.sdk.sep.sep06.exceptions/Sep06CustomerInformationNeededException

Sep06CustomerInformationNeededException

class Sep06CustomerInformationNeededException(val fields: List<String>) : Sep06Exception

Exception thrown when additional customer information is required (HTTP 403).

Indicates that the anchor requires additional KYC information before processing the request. The response type is "non_interactive_customer_info_needed" and includes a list of SEP-9 field names that must be collected and submitted via SEP-12 KYC API before retrying the request.

This error typically occurs when:

Initial deposit/withdrawal request is made without sufficient KYC
Anchor requires additional information for higher transaction limits
Regulatory requirements necessitate more customer data
Transaction type requires specific fields (e.g., bank account details)

Recovery actions:

Collect the required fields from the user
Submit the information via SEP-12 KYC API
Retry the original deposit/withdrawal request

Example - Handle customer information needed:

suspend fun initiateDeposit(
    sep06Service: Sep06Service,
    sep12Service: Sep12Service,
    assetCode: String,
    jwt: String
): Sep06DepositResponse? {
    try {
        return sep06Service.deposit(assetCode, jwt)
    } catch (e: Sep06CustomerInformationNeededException) {
        println("Additional information required:")
        e.fields.forEach { field ->
            println("  - $field")
        }

        // Collect and submit required fields via SEP-12
        val customerData = collectCustomerData(e.fields)
        sep12Service.putCustomer(customerData, jwt)

        // Retry the deposit
        return sep06Service.deposit(assetCode, jwt)
    }
}

Example - Display required fields to user:

fun handleKycRequired(e: Sep06CustomerInformationNeededException) {
    val fieldDescriptions = mapOf(
        "first_name" to "First Name",
        "last_name" to "Last Name",
        "email_address" to "Email Address",
        "bank_account_number" to "Bank Account Number",
        "bank_routing_number" to "Bank Routing Number"
    )

    println("Please provide the following information:")
    e.fields.forEach { field ->
        val description = fieldDescriptions[field] ?: field
        println("  - $description")
    }
}

Constructors

Sep06CustomerInformationNeededException

constructor(fields: List<String>)

Properties

cause

expect open val cause: Throwable?

fields

val fields: List<String>

List of SEP-9 field names that must be collected from the customer

message

expect open val message: String?

Functions

toString

open override fun toString(): String