Update a draft (save again or submit)

Saves a draft again, or submits it with status: submitted (same rules as create).
Only drafts can be updated.

This replaces the whole application, it does not merge. Send every section again:
applicant, family or funds that are left out are saved as empty.

Documents: list every document to keep in document_meta. For one already uploaded,
send its file id as file_id (the documents[].file._id from GET /immigration/applications/{id}).
For a new or replaced one, upload the file under its key. Any earlier document missing from
document_meta is deleted, file included.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/jsonRequired

Example

{
    "status": "submitted",
    "applicant": {
        "full_name": "John Smith",
        "date_of_birth": "1985-04-12",
        "place_of_birth": "Mumbai",
        "citizenship": "65a0c1d2e3f4a5b6c7d8e9f0",
        "residence": "65a0c1d2e3f4a5b6c7d8e9f1",
        "marital_status": "married",
        "passport_number": "X1234567",
        "passport_issue_date": "2020-01-15",
        "passport_expiry_date": "2030-01-14",
        "email": "john@example.com",
        "phone": "+971500000001",
        "residential_address": "Dubai Marina, Dubai",
        "occupation": "Engineer",
        "qualification": "masters",
        "experience_years": 15,
        "is_business_owner": "yes",
        "employer_name": null
    },
    "family": [
        {
            "relation": "spouse",
            "position": 1,
            "full_name": "Jane Smith",
            "date_of_birth": "1987-06-02",
            "passport_number": "Y7654321",
            "nationality": "65a0c1d2e3f4a5b6c7d8e9f0"
        },
        {
            "relation": "child",
            "position": 1,
            "full_name": "Sam Smith",
            "date_of_birth": "2021-03-10",
            "passport_number": "Z1112223",
            "nationality": null
        }
    ],
    "funds": {
        "planned_investment": 500000,
        "planned_investment_currency": "USD",
        "budget": 750000,
        "budget_currency": "USD",
        "annual_income": 100000,
        "annual_income_currency": "USD",
        "net_worth": 3000000,
        "net_worth_currency": "USD",
        "source_of_funds": [
            "salary_savings",
            "sale_of_property"
        ]
    },
    "document_meta": [
        {
            "key": "passport_copy",
            "label": "Passport Copy",
            "owner": "applicant",
            "member": null,
            "file_id": "6703a1b2c3d4e5f6a7b8c9d3"
        }
    ],
    "declarations": {
        "accurate": true,
        "verified": true,
        "consent_understood": true,
        "terms": true
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://demoapi.base93.com/api/v1/user/external/agent//immigration/applications/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": "submitted",
    "applicant": {
        "full_name": "John Smith",
        "date_of_birth": "1985-04-12",
        "place_of_birth": "Mumbai",
        "citizenship": "65a0c1d2e3f4a5b6c7d8e9f0",
        "residence": "65a0c1d2e3f4a5b6c7d8e9f1",
        "marital_status": "married",
        "passport_number": "X1234567",
        "passport_issue_date": "2020-01-15",
        "passport_expiry_date": "2030-01-14",
        "email": "john@example.com",
        "phone": "+971500000001",
        "residential_address": "Dubai Marina, Dubai",
        "occupation": "Engineer",
        "qualification": "masters",
        "experience_years": 15,
        "is_business_owner": "yes",
        "employer_name": null
    },
    "family": [
        {
            "relation": "spouse",
            "position": 1,
            "full_name": "Jane Smith",
            "date_of_birth": "1987-06-02",
            "passport_number": "Y7654321",
            "nationality": "65a0c1d2e3f4a5b6c7d8e9f0"
        },
        {
            "relation": "child",
            "position": 1,
            "full_name": "Sam Smith",
            "date_of_birth": "2021-03-10",
            "passport_number": "Z1112223",
            "nationality": null
        }
    ],
    "funds": {
        "planned_investment": 500000,
        "planned_investment_currency": "USD",
        "budget": 750000,
        "budget_currency": "USD",
        "annual_income": 100000,
        "annual_income_currency": "USD",
        "net_worth": 3000000,
        "net_worth_currency": "USD",
        "source_of_funds": [
            "salary_savings",
            "sale_of_property"
        ]
    },
    "document_meta": [
        {
            "key": "passport_copy",
            "label": "Passport Copy",
            "owner": "applicant",
            "member": null,
            "file_id": "6703a1b2c3d4e5f6a7b8c9d3"
        }
    ],
    "declarations": {
        "accurate": true,
        "verified": true,
        "consent_understood": true,
        "terms": true
    }
}'

Responses

🟢200

application/json

Application updated

Bodyapplication/json

Example

{
    "status": true,
    "response_code": 200,
    "message": "Application created successfully",
    "data": {
        "application": {
            "_id": "6703a1b2c3d4e5f6a7b8c9d0",
            "application_id": "10042",
            "status": "submitted",
            "submitted_at": "2026-10-08T11:00:00.000Z"
        }
    }
}

🟠400

🟠401Unauthorized

🟠403Forbidden

🟠404ApplicationNotFound