• 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

    Mock/Test Requests (Staging)

    Mock requests are supported only on the staging server. Use the Servers selector to switch environments.
    Most verification flows require real user data to produce meaningful results. To make testing easier, staging supports mock mode, where outcomes are driven by specific input values (not the images you capture).
    When running mock checks:
    You can capture any image during ID capture and selfie/liveness steps.
    Results are determined by the mock values you submit (e.g., name fields and birth date), not the captured images.

    Enable mock mode#

    For all mock requests:
    first_name = "MOCK"

    QuickID outcomes#

    Set birth_date = "1900-01-01" and use the following last_name:
    Desired resultlast_namebirth_date
    PASSPASS1900-01-01
    PARTIAL PASSPARTIAL1900-01-01
    FAILFAIL1900-01-01

    PEP outcomes#

    Set birth_date to:
    Desired resultbirth_date
    NO MATCH1900-01-01
    MATCH1900-01-02
    POTENTIAL MATCH1900-01-03
    NOT AVAILABLE1900-01-04

    PEP_COMPANY outcomes#

    Set company_name = "MOCK" and use the following company_number:
    Desired resultlast_name
    NO MATCHNO_MATCH
    MATCHMATCH
    POTENTIAL MATCHPOTENTIAL

    FaceMatch outcomes#

    Set middle_name to:
    Scenariomiddle_name
    PASSFM1
    Face Comparison FAILFM2
    Passive Liveness Check FAILFM3
    Data Comparison PARTIAL PASSFM4
    Data Comparison FAILFM5
    Document Check FAILFM6
    Anti-Tamper Check REVIEWFM7
    Not Expired REVIEWFM8

    VOI outcomes#

    Set middle_name to:
    Scenariomiddle_name
    PASSVOI1
    identity_document_result FAILVOI2
    data_result REVIEWVOI3
    data_result FAILVOI4
    photo_liveliness_result FAILVOI5
    face_comparison_result FAILVOI6
    id_doc_liveliness_result REVIEWVOI7
    Previous
    Basic Realaml workflow
    Next
    Security recommendations
    Built with