Get programme details
get_programReturns one programme of the index in detail. Residency programmes: minimum amount and investment options, physical presence, time to permanent residency and to citizenship, dual citizenship, settlement area, tax system of the country, steps and excerpts of the GoodbyeMatrix programme texts (overview, qualification, costs, benefits, citizenship timeline, legal basis). Citizenship by investment programmes: routes with starting amounts, visa-free destinations, status (cost calculator, on request, coming soon or closed) and official links. Includes the programme page in German and English, the date of the source and consultationNote. Read-only: it only retrieves and computes from the GoodbyeMatrix data set, stores nothing, sends nothing and calls no external services.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Programme id from search_programs or get_country_overview, or a programme name (word order and country codes are tolerated). | |
| language | No | Response language: "en" (English, default) or "de" (German). | en |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| tool | No | ||
| stand | Yes | Date of the source data (YYYY-MM-DD). | |
| notice | Yes | General information, not legal, tax or immigration advice. | |
| schema | No | ||
| program | Yes | The programme; null when the name matches several programmes (see candidates). | |
| language | Yes | ||
| candidates | No | Only when the name matches several programmes: up to 5 matching programmes with their ids. | |
| cbiQuoteNote | No | Only for the 9 programmes with a cost calculator: get_cbi_quote calculates the costs for a specific family. | |
| consultationNote | Yes |