GetCustomerInfoRequest

public struct GetCustomerInfoRequest : Sendable

Request parameters for retrieving customer information via SEP-0012.

This struct encapsulates all the parameters needed to check the status of a customer’s KYC information or to fetch the fields required by the anchor for customer registration. The endpoint allows clients to either fetch requirements for a new customer or check the status of an existing customer’s KYC process.

See also:

Show on GitHub
  • jwt

    JWT previously received from the anchor via the SEP-10 authentication flow.

    Declaration

    Swift

    public var jwt: String
    Show on GitHub
  • id

    The ID of the customer as returned in the response of a previous PUT request. If the customer has not been registered, they do not yet have an id.

    Declaration

    Swift

    public var id: String?
    Show on GitHub

  • The server should infer the account from the sub value in the SEP-10 JWT to identify the customer. The account parameter is only used for backwards compatibility, and if explicitly provided in the request body it should match the sub value of the decoded SEP-10 JWT.

    Declaration

    Swift

    public var account: String?
    Show on GitHub

  • The client-generated memo that uniquely identifies the customer. If a memo is present in the decoded SEP-10 JWT’s sub value, it must match this parameter value. If a muxed account is used as the JWT’s sub value, memos sent in requests must match the 64-bit integer subaccount ID of the muxed account.

    Declaration

    Swift

    public var memo: String?
    Show on GitHub

  • Type of memo. One of text, id or hash. Deprecated because memos should always be of type id, although anchors should continue to support this parameter for outdated clients. If hash, memo should be base64-encoded. If a memo is present in the decoded SEP-10 JWT’s sub value, this parameter can be ignored.

    Declaration

    Swift

    public var memoType: String?
    Show on GitHub

  • The type of action the customer is being KYCd for. Different types of customers may have different KYC requirements. For example, a customer could have an ACCEPTED status for one type but require additional information for another type.

    Declaration

    Swift

    public var type: String?
    Show on GitHub

  • The transaction id with which the customer’s info is associated. This is used when information from the customer depends on the transaction, such as when more information is required for larger amounts.

    Declaration

    Swift

    public var transactionId: String?
    Show on GitHub

  • Language code specified using ISO 639-1. Defaults to en if not specified. Human readable descriptions, choices, and messages should be in this language.

    Declaration

    Swift

    public var lang: String?
    Show on GitHub

  • Creates a new customer information request.

    Declaration

    Swift

    public init(jwt: String)

    Parameters

    jwt

    JWT previously received from the anchor via SEP-10 authentication
    Show on GitHub