Get application pre-fill

Everything needed to start an application for one matched programme: the client's details
and family taken from the assessment answers, and a short programme summary.

Use family to decide which family members the application needs. Children are numbered
in the order of children_ages (child_1, child_2, …), and that numbering is what
family[].position and the document member keys use when you create the application.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Pre-fill data

Bodyapplication/json

Example

{
    "status": true,
    "response_code": 200,
    "data": {
        "status": "pending",
        "client": {
            "full_name": "John Smith",
            "date_of_birth": "1985-04-12",
            "age": 41,
            "citizenship": "65a0c1d2e3f4a5b6c7d8e9f0",
            "residence": "65a0c1d2e3f4a5b6c7d8e9f1",
            "marital_status": "married",
            "budget": 750000,
            "budget_currency": "USD",
            "annual_income": 100000,
            "annual_income_currency": "USD",
            "net_worth": 3000000,
            "net_worth_currency": "USD",
            "stay_tolerance": "31_90_days",
            "occupation": "Engineer",
            "qualification": "masters",
            "experience_years": 15,
            "is_business_owner": "yes",
            "funds_documented": "yes"
        },
        "family": {
            "spouse": true,
            "children": true,
            "children_ages": [
                5,
                12
            ],
            "parents": false,
            "parents_in_law": false
        },
        "programme": {
            "_id": "66e0b1c2d3e4f5a6b7c8d9e0",
            "name": "Golden Visa — Real Estate",
            "country": {
                "name": "Greece",
                "logo": "https://…/gr.png"
            },
            "min_investment": 250000,
            "max_investment": 800000
        }
    }
}

🟠404

🟠400InvalidId

🟠401Unauthorized

🟠403Forbidden