iOS SDK Reference

<key>WKAppBoundDomains</key>
<array>
  <string>https://auth.magic.link</string>
</array>

import MagicSDK
import UIKit

@UIApplicationMain
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // assign the newly created Magic instance to shared property
    // Test key defaults to "goerli", live key defaults to "mainnet"
    Magic.shared = Magic(apiKey: "PUBLISHABLE_API_KEY")
    // Construct with an API key and options:
    Magic.shared = Magic(apiKey: "PUBLISHABLE_API_KEY", ethNetwork: .goerli)
    // Construct with an API key and custom node options:
    let customNode = CustomNodeConfiguration(rpcUrl: "https://polgyon-rpc.com", chainId: 137)
    Magic.shared = Magic(apiKey: "PUBLISHABLE_API_KEY", customNode: customNode)
    // Construct with an API key and custom locale
    Magic.shared = Magic(apiKey: "PUBLISHABLE_API_KEY", locale: "es")

    return true
}

import MagicSDK

class LoginViewController: UIViewController {
    @IBOutlet weak var phoneNumberInput: UITextField!
    let magic = Magic.shared

    @IBAction func login() {
        guard let magic = magic else { return }
        guard let phoneNumber = self.phoneNumberInput.text else { return }

        let configuration = LoginWithSMSConfiguration(phoneNumber: phoneNumber, showUI: true)

        magic.auth.loginWithSMS(configuration, response: { response in
            guard let token = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", token)
        })
    }
}

import MagicSDK

class LoginViewController: UIViewController {
    @IBOutlet weak var phoneNumberInput: UITextField!
    let magic = Magic.shared

    @IBAction func login() {
        guard let magic = magic else { return }

        let configuration = LoginWithSMSConfiguration(phoneNumber: phoneNumber)

        magic.auth.loginWithSMS(configuration).done({ result in
            print(result) // DIDToken
        }).catch({
            print(error) // handle Error
        })
    }
}

import MagicSDK

class LoginViewController: UIViewController {
    @IBOutlet weak var emailInput: UITextField!
    let magic = Magic.shared

    @IBAction func login() {
        guard let magic = magic else { return }
        guard let email = self.emailInput.text else { return }

        let configuration = LoginWithEmailOTPConfiguration(email: email)

        magic.auth.loginWithEmailOTP(configuration, response: { response in
            guard let token = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", token)
        })
    }
}

import MagicSDK

class LoginViewController: UIViewController {
    @IBOutlet weak var emailInput: UITextField!
    let magic = Magic.shared

    @IBAction func login() {
        guard let magic = magic else { return }

        let configuration = LoginWithEmailOTPConfiguration(email: self.emailInput.text!)

        magic.auth.loginWithEmailOTP(configuration).done({ result in
            print(result) // DIDToken
        }).catch({
            print(error) // handle Error
        })
    }
}

import MagicSDK

class LoginViewController: UIViewController {
    @IBOutlet weak var emailInput: UITextField!
    let magic = Magic.shared

    private var emailOTPHandle: MagicEventPromise<String>?

    @IBAction func loginHeadless() {
        guard let magic = magic, let email = emailInput.text else { return }

        let configuration = LoginWithEmailOTPConfiguration(email: email, showUI: false)

        emailOTPHandle = magic.auth.loginWithEmailOTP(configuration, eventLog: true)

            // — Email OTP —
            .on(eventName: AuthModule.LoginWithEmailOTPEventOnReceived.emailOTPSent.rawValue) { [weak self] in
                // Prompt the user for the OTP they received by email, then:
                let otp = "123456" // value collected from your own UI
                self?.emailOTPHandle?.emit(eventType: AuthModule.LoginWithEmailOTPEventEmit.verifyEmailOTP.rawValue, arg: otp)
            }
            .onPersistent(eventName: AuthModule.LoginWithEmailOTPEventOnReceived.invalidEmailOTP.rawValue) { [weak self] in
                // Invalid OTP — re-prompt; fires on each wrong attempt
                let otp = "123456"
                self?.emailOTPHandle?.emit(eventType: AuthModule.LoginWithEmailOTPEventEmit.verifyEmailOTP.rawValue, arg: otp)
            }
            .on(eventName: AuthModule.LoginWithEmailOTPEventOnReceived.expiredEmailOTP.rawValue) { [weak self] in
                // OTP expired — restart the login flow
            }
            .on(eventName: AuthModule.LoginWithEmailOTPEventOnReceived.loginThrottled.rawValue) { [weak self] in
                // Too many attempts — ask the user to wait before retrying
            }
            .on(eventName: AuthModule.LoginWithEmailOTPEventOnReceived.maxAttemptsReached.rawValue) { [weak self] in
                // No retries left — end the flow
            }

            // — MFA —
            .on(eventName: AuthModule.MFAEventOnReceived.mfaSentHandle.rawValue) { [weak self] in
                // User has MFA enabled — prompt for their authenticator code, then:
                let code = "123456" // value collected from your own UI
                self?.emailOTPHandle?.emit(eventType: AuthModule.MFAEventEmit.verifyMFACode.rawValue, arg: code)
            }
            .onPersistent(eventName: AuthModule.MFAEventOnReceived.invalidMfaOTP.rawValue) { [weak self] in
                // Invalid MFA code — re-prompt or switch to recovery:
                self?.emailOTPHandle?.emit(eventType: AuthModule.MFAEventEmit.lostDevice.rawValue)
            }
            .on(eventName: AuthModule.MFAEventOnReceived.recoveryCodeSentHandle.rawValue) { [weak self] in
                // Prompt for MFA recovery code, then:
                let code = "RECOVERY-CODE" // value collected from your own UI
                self?.emailOTPHandle?.emit(eventType: AuthModule.MFAEventEmit.verifyRecoveryCode.rawValue, arg: code)
            }
            .onPersistent(eventName: AuthModule.MFAEventOnReceived.invalidRecoveryCode.rawValue) { [weak self] in
                // Invalid recovery code — re-prompt or cancel
                self?.emailOTPHandle?.emit(eventType: AuthModule.MFAEventEmit.cancel.rawValue)
            }
            .on(eventName: AuthModule.MFAEventOnReceived.recoveryCodeSuccess.rawValue) { [weak self] in
                // Recovery code accepted — login will complete via .done
            }

            // — Device verification —
            .on(eventName: AuthModule.DeviceVerificationEventOnReceived.deviceNeedsApproval.rawValue) { [weak self] in
                // New device — ask the user to check their inbox to approve
            }
            .on(eventName: AuthModule.DeviceVerificationEventOnReceived.deviceVerificationEmailSent.rawValue) { [weak self] in
                // Device approval email sent — waiting for the user to click it
            }
            .on(eventName: AuthModule.DeviceVerificationEventOnReceived.deviceApproved.rawValue) { [weak self] in
                // Device approved — login will continue automatically
            }
            .on(eventName: AuthModule.DeviceVerificationEventOnReceived.deviceVerificationLinkExpired.rawValue) { [weak self] in
                // Approval link expired — retry
                self?.emailOTPHandle?.emit(eventType: AuthModule.DeviceVerificationEventEmit.deviceRetry.rawValue)
            }

        emailOTPHandle?
            .onError { error in
                print("Error:", error.localizedDescription)
            }
            .done { didToken in
                print("Result", didToken) // DIDToken — login complete
            }
            .catch { error in
                print(error)
            }
    }
}

import MagicSDK

class MagicViewController: UIViewController {
    let magic = Magic.shared

    func logout() {
        guard let magic = magic else { return }

        // Assuming user is logged in
        magic.wallet.connectWithUI(response: { response in
            guard let result = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", result)
        })
    }
}

import MagicSDK

class MagicViewController: UIViewController {
    let magic = Magic.shared

    func logout() {
        guard let magic = magic else { return }

        // Assuming user is logged in
        magic.wallet.showUI(response: { response in
            guard let result = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", result)
        })
    }
}

import MagicSDK

class MagicViewController: UIViewController {

    let magic = Magic.shared

    // Initiates the flow to update a user's current email to a new one.
    func updateEmail() {

        guard let magic = magic else { return }

        // Assuming user is logged in
        let configuration = UpdateEmailConfiguration(email: "[email protected]", showUI: true)
        magic.user.updateEmail(configuration, response: { response in
            guard let result = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", result)
        })
    }

}

import MagicSDK

class MagicViewController: UIViewController {

    let magic = Magic.shared

    func getIdToken() {
        guard let magic = magic else { return }

        // Assuming user is logged in
        let configuration = GetIdTokenConfiguration(lifespan: 900)

        magic.user.getIdToken(configuration, response: { response in
            guard let token = response.result
                else { return print(response.error.debugDescription) }
            print(token)
        })
    }

}

import MagicSDK

class MagicViewController: UIViewController {
    let magic = Magic.shared

    func generateIdToken() {
        guard let magic = magic else { return }

        // Assuming user is logged in
        let configuration = GenerateIdTokenConfiguration(lifespan: 900, attachment: "none")

        magic.user.generateIdToken(configuration, response: { response in
            guard let token = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", token)
        })
    }
}

import MagicSDK

class MagicViewController: UIViewController {
    let magic = Magic.shared

    func getInfo() {
        guard let magic = magic else { return }

        // Assuming user is logged in
        magic.user.getInfo(response: { response in
            guard let metadata = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", metadata)
        })
    }
}

import MagicSDK

class MagicViewController: UIViewController {
    let magic = Magic.shared

    func isLoggedIn() {
        guard let magic = magic else { return }

        magic.user.isLoggedIn(response: { response in
            guard let result = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", result)
        })
    }
}

import MagicSDK

class MagicViewController: UIViewController {
    let magic = Magic.shared

    func logout() {
        guard let magic = magic else { return }

        // Assuming user is logged in
        magic.user.logout(response: { response in
            guard let result = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", result)
        })
    }
}

import MagicSDK

class MagicViewController: UIViewController {
    let magic = Magic.shared

    func logout() {
        guard let magic = magic else { return }

        // Assuming user is logged in
        magic.user.showSettings(response: { response in
            guard let result = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", result)
        })
    }
}

import MagicSDK

class MagicViewController: UIViewController {
    let magic = Magic.shared

    func logout() {
        guard let magic = magic else { return }

        // Assuming user is logged in
        let configuration = (phoneNumber: phoneNumber)
        magic.user.updatePhoneNumber(configuration, response: { response in
            guard let result = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", result)
        })
    }
}

import MagicSDK

class MagicViewController: UIViewController {
    let magic = Magic.shared

    func logout() {
        guard let magic = magic else { return }

        // Assuming user is logged in
        let configuration = RecoverAccountConfiguration(email: "[email protected]")
        magic.user.recoverAccount(configuration, response: { response in
            guard let result = response.result
                else { return print("Error:", response.error.debugDescription) }
            print("Result", result)
        })
    }
}

public enum ProviderError: Swift.Error {
  // The provider is not configured with an authDelegate
  case encodingFailed(Swift.Error?)
  // Decoding the JSON-RPC request failed
  case decodingFailed(json: String)
  // Convert string failed
  case invalidJsonResponse(json: String)
  // Missing callback
  case missingPayloadCallback(json: String)
}

public enum Error: Swift.Error {
  /// The response did not include expected results
  case unexpectedResponse(Swift.Error?)
  /// The server returned an unexpected response code
  case invalidResponseCode
}

enum Error: Swift.Error{
  case eventCallbackMissing
}