GetCustomerInfoProvidedField

public struct GetCustomerInfoProvidedField : Decodable, Sendable

Describes a field that has been provided by the customer along with its validation status.

This structure defines fields that the customer has already submitted and their current validation status. It is required for customers whose information needs verification.

See SEP-12 Provided Fields

Show on GitHub

  • The data type of the field value. Can be “string”, “binary”, “number”, or “date”

    Declaration

    Swift

    public let type: String
    Show on GitHub

  • A human-readable description of this field, especially important if this is not a SEP-9 field.

    Declaration

    Swift

    public let description: String
    Show on GitHub

  • (optional) An array of valid values for this field.

    Declaration

    Swift

    public let choices: [String]?
    Show on GitHub

  • (optional) A boolean whether this field is required to proceed or not. Defaults to false.

    Declaration

    Swift

    public let optional: Bool?
    Show on GitHub

  • (optional) One of the values described in Provided Field Statuses (https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#provided-field-statuses). If the server does not wish to expose which field(s) were accepted or rejected, this property can be omitted.

    Declaration

    Swift

    public let status: String?
    Show on GitHub

  • (optional) The human readable description of why the field is REJECTED.

    Declaration

    Swift

    public let error: String?
    Show on GitHub

  • Initializer - creates a new instance by decoding from the given decoder.

    Declaration

    Swift

    public init(from decoder: Decoder) throws

    Parameters

    decoder

    The decoder containing the data
    Show on GitHub