# Videx Diplo — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Retrieve validation rules and dropdown options from the German Federal Foreign Office's VIDEX short-term stay visa application form to understand field requirements and acceptable values. Use this data to build compliant visa application interfaces or validate user input against official form constraints.

**Category:** Government & Public Data | **Website:** [videx.diplo.de/videx/visum-erfassung/en/videx-kurzfristiger-aufenthalt](https://videx.diplo.de/videx/visum-erfassung/en/videx-kurzfristiger-aufenthalt) | **Docs:** [parse.bot/marketplace/ee115bd3-79d7-4aca-82e5-f7817766658e/videx-diplo-de-api](https://parse.bot/marketplace/ee115bd3-79d7-4aca-82e5-f7817766658e/videx-diplo-de-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-videx-diplo-de-api-ee115bd3/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_validation_rules

Returns validation metadata for all form fields of the VIDEX short-term stay (Schengen) visa application. Each field entry includes whether it is mandatory, minimum/maximum length constraints, minimum/maximum numeric value constraints, and a regex pattern (maskRegex) that valid input must match. Internal valueListID sub-fields are filtered out. The response is language-independent since validation rules do not vary by display language.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-videx-diplo-de-api-ee115bd3/get_validation_rules \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_value_lists

Returns all dropdown/select option lists used in the VIDEX short-term stay visa form. Each value list contains a name, version, and array of key-value items representing the selectable options. Lists include countries, Schengen member states, occupations, travel purposes, travel document types, means of transport, number of entries, civil status, sex, visa categories, and more. The language parameter controls the display language of option labels.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `language` | string | No | ISO 639-1 language code for option labels. Supported: de, en, ar, zh, fr, id, fa, pt, ru, es, tr, vi. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-videx-diplo-de-api-ee115bd3/get_value_lists \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"language":"<string>"}'
```
