Push notifications

Register a device for push notifications

Subscribe an APNs / FCM device token to receive push notifications when visa policies change. Idempotent on device_token.

post/api/v1/visa/devices

Request

Base URL
https://visa.orizn.app
Auth
- API key in header x-api-key
- or API key in query parameter api_key
TypeScript
https://skmtc.dev/orizn/apis/orizn-visa-api/docs/api/v1/visa/devices/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

device_tokenstring required

passport_iso3string required

ISO 3166-1 alpha-3 country code.

platformstring

bundle_idstring

wishlist_iso3ISO3[]

localestring

tzstring

premiumboolean

Example request

{
  "device_token": "8a3f...e2b1",
  "passport_iso3": "FRA",
  "platform": "ios",
  "bundle_id": "com.orizn-visa",
  "wishlist_iso3": [
    "FRA"
  ],
  "locale": "en",
  "tz": "Europe/Paris"
}

Response

Device registered or updated.

device_idinteger required

Example response

{
  "device_id": 42
}

Changes

No operation changes recorded.