Service
Read-only access to a traveler's Visit Japan Web account: passport profile and MFA status, registered trips with accommodation, the immigration and customs declarations filed for a trip, tax-free landing-permission status, and public Japanese postal-code address lookup.
100.00%30-day uptimeAvg response97ms
Selecting a row opens the reference for that API.
| Method | API | Path | Summary |
|---|---|---|---|
| POST | /v1/visit-japan-web/account | Returns the account holder's Visit Japan Web profile: passport details, nationality, gender, occupation, home city, address in Japan, tax-exemption enrollment, and whether MFA is configured. Use when an agent needs identity context for the traveler before reading trips or declarations. Do NOT use to change profile data; the provider is read-only. | |
| POST | /v1/visit-japan-web/address-lookup | Resolves a seven-digit Japanese postal code to its prefecture, municipality, and town names in Japanese and English using the public Visit Japan Web address table. No connection is required. Use when filling or validating a Japanese accommodation address. Do NOT use for non-Japanese postal codes; unknown codes return found=false rather than an error. | |
| POST | /v1/visit-japan-web/tax-exemption | Reads the account holder's tax-free shopping status: whether a landing-permission record exists, when it expires, and whether a face photo is registered. Use when a traveler asks if their Visit Japan Web tax-free QR is ready or still valid. Do NOT use to enroll in tax-free shopping or to render the QR code. | |
| POST | /v1/visit-japan-web/travel-declarations | Returns the immigration (ED card) and customs declarations the account holder filed for one registered trip, identified by travel_id from the travels operation. Includes purpose and length of stay, the three immigration questions, declared personal effects, and the customs questionnaire answers. Use when a traveler wants to review what was declared before arrival. Do NOT use to submit or amend declarations. | |
| POST | /v1/visit-japan-web/travels | Lists every trip registered on the Visit Japan Web account, newest arrival first, plus the trips the service currently flags as upcoming. Each trip carries the arrival date, airline and flight, point of embarkation, and the accommodation address in Japan. Use when the agent needs a travel_id for declarations or wants to summarize the traveler's planned entries. Do NOT use to register or edit trips. |
Scopes define which services and APIs a key may call.
Retry rules and backoff behaviour for idempotent calls.
Receive events such as reservation confirmations and delivery updates.