• Realaml API
    • Basic Realaml workflow
    • Mock/Test Requests (Staging)
    • Security recommendations
    • iFrame Embed
    • iOS SDK
    • Android SDK
    • API Reference
      • Verifications
        • Create a verification
        • Get a verification
        • Delete a verification
        • Resend a verification
        • Reset a verification
        • Approve a verification check result
        • Approve Quick IDV result (deprecated)
        • Approve PEP result (deprecated)
        • Create and run a verification
        • Create and run a company verification
        • Approve FaceMatch result (deprecated)
      • Outsourced Verifications
        • Create an outsourced verification
        • Get an outsourced verification
        • Delete an outsourced verification
      • Risk Assessment
        • Create a risk rating
        • Get risk rating details
      • E-sign Templates
        • List e-sign templates
        • Fetch an e-sign template
      • E-sign Documents
        • Create an e-sign draft document
        • Fetch an e-sign document
        • List e-sign documents
        • Update an e-sign draft document
        • Delete an e-sign document
        • Duplicate an e-sign document
        • Create an e-sign iframe builder session
        • Send an e-sign document
        • Resend an e-sign document
        • Reinitiate an e-sign document
        • Void an e-sign document
      • Form Submissions
        • Create a form submission
        • Fetch a form submission
        • Delete a form submission
        • Resend a form submission
    • National IDs
      • Australia (AU)
      • Canada (CA)
      • China (CN)
      • Denmark (DK)
      • India (IN)
      • Mexico (MX)
      • New Zealand (NZ)
      • United States (US)
      • South Africa (ZA)
    • Changelog
    • Schemas
      • VerificationRequest
      • VerificationCompanyRequest
      • VerificationSimple
      • Verification
      • VerificationCompany
      • OutsourcedVerificationRequest
      • OutsourcedVerificationSimple
      • OutsourcedVerification
      • OutsourcedVerificationType
      • OutsourcedVerificationStatus
      • OutsourcedVerificationResult
      • OutsourcedVerificationIndividual
      • VerificationType
      • VerificationResultSource
      • Result
      • PepResult
      • PepType
      • PepHit
      • DocumentOCRData
      • FaceMatchVoiResult
      • NationalIdTypes
      • BadRequest
      • Metadata
      • PersonName
      • PersonBirthDate
      • ContactMethods
      • AddressFields
      • GeoCoordinates
      • NationalIdBundle
      • VerificationAlgorithmSelection
      • VerificationIdentityResponse
      • VerificationCoreResponse
      • VerificationAddressResponse
      • VerificationNationalIdsResponse
      • VerificationMetadataResponse
      • OtherCountries
      • OutsourcedContactMethods
      • OutsourcedOrgTracking
      • OutsourcedCore
      • CompanyContactMethods
      • CompanyCore
      • CompanyTracking
      • VerificationResendRequest
      • RiskLevel
      • RiskAnswer
      • RiskSection
      • RiskQuestion
      • RiskRatingAnswer
      • RiskRating
      • RiskRatingCreateRequest
      • FormSubmissionCreateRequest
      • FormSubmission
      • FormSubmissionUser
      • FormSubmissionForm
      • FormSubmissionVerification
      • FormSubmissionValue
      • ESignTwoFactorMethod
      • ESignEnvelopeStatus
      • ESignRecipientStatus
      • ESignFieldType
      • ESignFieldDefaultValueMode
      • ESignTemplateRecipientRole
      • ESignTemplate
      • ESignDocumentRecipientOverride
      • ESignDocumentCreateRequest
      • ESignRecipientCreateRequest
      • ESignRecipientUpdateRequest
      • ESignDocumentFile
      • ESignField
      • ESignFieldGroup
      • ESignRecipient
      • ESignActionRequiredRecipient
      • ESignActionRequired
      • ESignDocument
      • ESignFieldResponse
      • ESignCompletionCertificate
      • ESignDocumentDetail
      • ESignSendDocumentResponse
      • ESignReinitiateDocumentResponse
      • ESignDocumentUpdateRequest
      • ESignDocumentDuplicateRequest
      • ESignDocumentPage
      • ESignIframeSessionCreateRequest
      • ESignIframeSessionResponse
      • ESignResendDocumentRequest
      • ESignResendDocumentResponse
      • ESignVoidDocumentRequest
      • ESignVoidDocumentResponse

    iOS SDK

    The Realaml iOS SDK supports iOS 11+.
    For additional examples and updates, see the SDK repository:
    https://github.com/realaml/ios-sdk

    Installation#

    CocoaPods#

    Add the following to your Podfile:

    Carthage#

    Add the following to your Cartfile:
    github "realaml/ios-sdk"

    Swift Package Manager#

    Add the package using this URL:
    https://github.com/realaml/ios-sdk

    Manual#

    Add Realaml.xcframework under:
    Frameworks, Libraries, and Embedded Content

    Required permissions#

    Add the following key to your app’s Info.plist:
    Privacy - Camera Usage Description

    Getting started#

    UIKit (Swift)#

    Start a KYC session:
    Implement delegate callbacks:

    SwiftUI#

    Start a KYC session:

    UIKit (Objective-C)#

    Start a KYC session and handle callbacks:
    #import <Realaml/Realaml.h>
    
    @interface ViewController ()<KYCViewControllerDelegate>
    @end
    
    @implementation ViewController
    
    - (IBAction)startKYC:(id)sender {
        KYCViewController *controller = [[KYCViewController alloc] initWithEnvironment:RealamlEnvironmentStaging
                                                                          signatureKey:YOUR_SIGNATURE_KEY];
        controller.delegate = self;
        [self presentViewController:controller animated:YES completion:nil];
    }
    
    - (void)kycViewController:(KYCViewController *)controller didFinishWith:(nullable NSError *)error {
        [controller dismissViewControllerAnimated:YES completion:nil];
    }
    
    - (void)kycViewControllerDidCancelled:(KYCViewController *)controller {
        [controller dismissViewControllerAnimated:YES completion:nil];
    }
    
    @end

    Environment#

    Error codes#

    Previous
    iFrame Embed
    Next
    Android SDK
    Built with