# Videx Diplo — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.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 for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/videx-diplo/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## 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.beta.paywithlocus.com/api/wrapped/credits/videx-diplo/get-validation-rules \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/videx-diplo/get-value-lists \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"language":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.