• 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

    ApplicationRequest

    {
        "status": "draft",
        "applicant": {
            "full_name": "string",
            "date_of_birth": "1985-04-12",
            "place_of_birth": "string",
            "marital_status": "single",
            "passport_number": "string",
            "passport_issue_date": "string",
            "passport_expiry_date": "string",
            "email": "string",
            "phone": "string",
            "residential_address": "string",
            "occupation": "string",
            "qualification": "high_school",
            "experience_years": 0,
            "is_business_owner": "yes",
            "employer_name": "string",
            "citizenship": "string",
            "residence": "string"
        },
        "family": [
            {
                "relation": "spouse",
                "position": 1,
                "full_name": "string",
                "date_of_birth": "string",
                "passport_number": "string",
                "nationality": "string"
            }
        ],
        "funds": {
            "planned_investment": 0,
            "planned_investment_currency": "USD",
            "budget": 0,
            "budget_currency": "string",
            "annual_income": 0,
            "annual_income_currency": "string",
            "net_worth": 0,
            "net_worth_currency": "string",
            "source_of_funds": [
                "business_income"
            ]
        },
        "document_meta": [
            {
                "key": "string",
                "label": "string",
                "owner": "applicant",
                "member": "string",
                "file_id": "string"
            }
        ],
        "declarations": {
            "accurate": true,
            "verified": true,
            "consent_understood": true,
            "terms": true
        }
    }
    Built with