• Overview
    • Endpoints
      • Companies
        • All companies
        • Get a company
        • Create company
        • Create payment
      • Pricing
        • Get pricing packages
      • Countries
        • All countries
        • Get a country
      • Forms
        • Get a form
      • Leads
        • All leads
        • Get a lead
        • Update status
      • Profile
        • Get profile
        • Update profile
      • Wallet
        • Get wallet balance
        • Create topup request
      • Support
        • All tickets
        • Get a ticket
        • Create a ticket
      • Notifications
        • All notifications
        • Mark as read
        • Pusher auth
      • Renewals
        • Search companies for renewal
        • Get dynamic form config for a jurisdiction
        • List renewal requests
        • Request a quote revision
        • Approve quote and confirm wallet payment
        • Initiate quote payment — send OTP
        • Get a renewal by ID
        • Submit a renewal request
      • Files
        • Get a one-time download URL for any file owned by the agent
      • Immigration
        • List immigration objectives
        • Submit an assessment and get matching programmes
        • Get application pre-fill
        • Create an application (draft or submitted)
        • List applications
        • Get an application
        • Update a draft (save again or submit)
        • Delete a draft
    • Schemas
      • QuoteConfig
      • CreatePaymentSuccessResponse
      • SuccessEnvelope
      • StandardSuccess
      • ErrorEnvelope
      • ErrorResponse
      • FieldValidation
      • DirectApplication
      • YesNo
      • FileAttachment
      • Company
      • QuoteBreakdown
      • Field
      • Objective
      • Quote
      • Section
      • AssessmentRequest
      • RenewalFormConfigBody
      • ProcessingStep
      • ProgrammeSummary
      • CreateCompanyRequest
      • ProgrammeMatch
      • RenewalFormConfig
      • CompletedDetails
      • ExternalCompany
      • ApplicationPrefill
      • Renewal
      • Applicant
      • FormConfigField
      • ApplicantFields
      • FormConfigSection
      • FamilyMember
      • FamilyMemberFields
      • FormConfig
      • Funds
      • DocumentMeta
      • Declarations
      • StoredDeclarations
      • ApplicationRequest
      • ApplicationStatus
      • Application
      • ApplicationDetail
      • CountryRef
      • CountryName
      • ApplicationListItem

    AssessmentRequest

    {
        "mode": "declared",
        "objectives": [
            "string"
        ],
        "answers": {
            "applicant_profile": {
                "full_name": "string",
                "date_of_birth": "1985-04-12",
                "age": 0,
                "citizenship": "string",
                "residence": "string",
                "marital_status": "single"
            },
            "family": {
                "include_spouse": "yes",
                "include_children": "yes",
                "children_ages": "5, 12, 18",
                "include_parents": "yes",
                "include_parents_in_law": "yes"
            },
            "destination_preferences": {
                "goals": [
                    "string"
                ],
                "preferred_countries": [
                    "string"
                ],
                "regions": [
                    "europe"
                ]
            },
            "additional_preferences": {
                "excluded_countries": [
                    "string"
                ],
                "other_requirements": "string"
            },
            "physical_presence": {
                "relocation_preference": "yes",
                "prefer_low_presence": "yes",
                "stay_tolerance": "0_30_days",
                "tax_residency_willing": "yes"
            },
            "citizenship_objective": {
                "importance": "essential",
                "pr_importance": "essential",
                "citizenship_timeline": "within_3_years",
                "pr_timeline": "within_3_years"
            },
            "lifestyle": {
                "lifestyle_priorities": [
                    "quality_of_life"
                ],
                "lifestyle_other": "string"
            },
            "investment_preference": {
                "budget": 0,
                "budget_currency": "USD",
                "annual_income": 0,
                "annual_income_currency": "string",
                "net_worth": 0,
                "net_worth_currency": "string",
                "deployment_types": [
                    "PROPERTY"
                ],
                "deployment_other": "string"
            },
            "professional_profile": {
                "qualification": "high_school",
                "profession": "string",
                "experience_years": 0,
                "has_job_offer": "yes",
                "is_business_owner": "yes",
                "establish_company_overseas": "yes"
            },
            "eligibility": {
                "clean_criminal_record": "yes",
                "funds_documented": "yes",
                "documents_available": "yes",
                "background_notes": "string"
            }
        }
    }
    Built with