KycServiceError

public enum KycServiceError : Error, Sendable

Errors that can occur when interacting with SEP-0012 KYC service endpoints. These errors represent various failure conditions during KYC operations including service initialization, authentication, request validation, and data processing.

Show on GitHub

  • The provided domain is not a valid URL format. Occurs when constructing KycService from an invalid domain string.

    Declaration

    Swift

    case invalidDomain
    Show on GitHub

  • The stellar.toml file at the domain could not be parsed or is malformed. Occurs when the TOML structure is invalid.

    Declaration

    Swift

    case invalidToml
    Show on GitHub

  • The stellar.toml file does not contain a KYC_SERVER or TRANSFER_SERVER entry. Occurs when the anchor has not configured KYC endpoints.

    Declaration

    Swift

    case noKycOrTransferServerSet
    Show on GitHub

  • Failed to parse the JSON response from the KYC server. Occurs when the server returns an unexpected response format.

    Declaration

    Swift

    case parsingResponseFailed(message: String)
    Show on GitHub

  • HTTP 400 Bad Request. Occurs when the request contains invalid field values, missing required fields, or unrecognized parameters.

    Declaration

    Swift

    case badRequest(error: String)
    Show on GitHub

  • HTTP 404 Not Found. Occurs when the customer ID does not exist or was created by a different account.

    Declaration

    Swift

    case notFound(error: String)
    Show on GitHub

  • HTTP 401 Unauthorized. Occurs when the JWT authentication token is invalid, expired, or missing.

    Declaration

    Swift

    case unauthorized(message: String)
    Show on GitHub

  • HTTP 413 Payload Too Large. Occurs when an uploaded file exceeds the server’s size limit (typically 10MB).

    Declaration

    Swift

    case payloadTooLarge(error: String?)
    Show on GitHub

  • Network or server error from the underlying HTTP request. Occurs when there are connection issues or unexpected server responses.

    Declaration

    Swift

    case horizonError(error: HorizonRequestError)
    Show on GitHub