ID PhotoREST · JSONOpenAPI 3.1

SVOYAGER ID Photo API

Zmień dowolne zdjęcie w zdjęcie zgodne z wymogami do dowodu osobistego, paszportu lub wizy.

Przegląd

Jak to działa

SVOYAGER ID Photo API przekształca zwykły portret w zdjęcie dokumentowe zgodne z wymogami. ID Photo to pojedynczy produkt: paszport, wiza, zezwolenie na pobyt i dowód osobisty są przedstawiane jako specyfikacje dokumentów, a nie jako oddzielne produkty. Należy przesłać zdjęcie, wygenerować podgląd z znakiem wodnym zgodnie ze specyfikacją, a następnie sfinalizować proces, aby uzyskać wynik bez znaku wodnego.

Podgląd → ostateczny przebieg procesu

  1. 1Prześlij zdjęcie. Utwórz miejsce docelowe przesyłania i wyślij do niego bajty obrazu.
  2. 2Utwórz sesję. Wygeneruj podgląd z znakiem wodnym zgodnie ze specyfikacją. Przejrzyj zgłoszone problemy.
  3. 3Sfinalizuj. Przekształć sprawdzoną sesję w zamówienie i otrzymaj wersję końcową bez znaku wodnego.

Szybki start

Każde żądanie jest uwierzytelniane za pomocą tajnego klucza Bearer. Rozpocznij w trybie testowym:

curl
# List specifications to find a spec_id
curl -G "https://partner.svoyager.com/v1/photo-specifications" \
  -H "Authorization: Bearer svoy_sk_test_YOUR_KEY" \
  --data-urlencode "country=US"

Adres URL bazowy i środowiska

Wszystkie punkty końcowe są obsługiwane pod jednym podstawowym adresem URL:

Base URL
https://partner.svoyager.com/v1

Nie ma ścieżki ani parametru środowiska. To, czy żądanie jest realizowane w środowisku testowym, czy produkcyjnym, zależy wyłącznie od prefiksu klucza API (svoy_sk_test_… vs svoy_sk_live_…). Odpowiedzi odzwierciedlają to jako livemode.

Uwierzytelnianie

Klucze API

Każde żądanie należy uwierzytelnić za pomocą nagłówka „Authorization” zawierającego Twój tajny klucz. Klucze są tworzone i rotowane w Centrum partnerów.

Header
Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxx

Prefiks określa środowisko: svoy_sk_test_… dla środowiska testowego, svoy_sk_live_… dla środowiska produkcyjnego. Klucz testowy nigdy nie może działać na danych produkcyjnych (i odwrotnie) — niezgodności zwracają kod 401 „wrong_environment”.

Zakresy

Klucze mają jawnie określone zakresy uprawnień oparte na zasadzie minimalnych uprawnień. Żądanie bez wymaganego zakresu zwraca kod 403 insufficient_scope.

ZakresUprawnienia
photo.specs.readList and retrieve photo specifications.
photo.sessions.readRetrieve sessions and their previews.
photo.sessions.writeCreate uploads and photo sessions (previews).
photo.finalize.writeFinalize a session into a no-watermark order.
photo.orders.readRetrieve orders and download finals.

Zabezpieczanie kluczy

Klucze tajne są przeznaczone wyłącznie do komunikacji między serwerami. Nigdy nie umieszczaj klucza tajnego w kodzie przeglądarki lub aplikacji mobilnej, w publicznym repozytorium ani w pakiecie po stronie klienta. Jeśli klucz zostanie ujawniony, natychmiast go wymień w Centrum partnerów.

Podstawowe API

Punkty końcowe

Pola obowiązkowe są oznaczone symbolem *. W przykładach wykorzystano dane uwierzytelniające zastępcze — nigdy nie należy używać prawdziwych kluczy.

POST/v1/uploads

Upload a photo

Create a short-lived presigned upload target, then PUT the raw image bytes straight to `upload_url`. This bypasses request-body size limits (product cap 10 MB). No quota is spent.

zakres photo.sessions.write
Żądanie
Treść (application/json)
PoleTypOpis
content_type*stringMIME type of the image.image/jpegimage/pngimage/webpimage/heic
  • `upload_url` is single-use and expires; upload promptly and do not modify the URL.
Przykładowe żądanie
curl
# 1) Create the upload target
curl -X POST "https://partner.svoyager.com/v1/uploads" \
  -H "Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"content_type":"image/jpeg"}'

# 2) PUT the bytes to the returned upload_url (exactly as returned)
curl -X PUT "$UPLOAD_URL" \
  -H "Content-Type: image/jpeg" \
  --data-binary @photo.jpg
Odpowiedź · 201
201 · application/json
{
  "object": "upload",
  "upload_url": "https://upload.svoyager.com/v1/EXAMPLE?signature=…",
  "upload_ref": "up_ref_tXk3W2b8Qe7Ra1Nc0",
  "max_bytes": 10485760,
  "expires_at": "2026-07-24T18: 20: 00Z"
}
Błędy
StatusKodGdy
400missing_content_type`content_type` was not provided.
415unsupported_formatThe content type is not an accepted image format.
503temporarily_unavailableUploads are temporarily unavailable.
502upload_init_failedThe upload could not be initialised — retry shortly.

Oprócz tego standardowe błędy uwierzytelniania, uprawnień i ograniczeń częstotliwości — zobacz Błędy i ponowne próby.

POST/v1/photo-sessions

Create a photo session

Generate a watermarked preview from an upload against a specification. Spends one `preview` unit of your plan. Review `issues` before finalizing.

zakres photo.sessions.write Wymagany klucz idempotencji
Żądanie
Treść (application/json)
PoleTypOpis
upload_ref*stringThe `upload_ref` from Upload a photo.
spec_id*stringThe `photo_specification` id (`spc_…`) to render against.
Przykładowe żądanie
curl
curl -X POST "https://partner.svoyager.com/v1/photo-sessions" \
  -H "Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxx" \
  -H "Idempotency-Key: a7f3c9e1-2b4d-4c8a-9f10-3e5d6b7a8c9d" \
  -H "Content-Type: application/json" \
  -d '{"upload_ref":"up_ref_tXk3W2b8Qe7Ra1Nc0","spec_id":"spc_9wTv2c1Kd8Qe"}'
Odpowiedź · 201
201 · application/json
{
  "object": "photo_session",
  "id": "3f9c1e77-2b8a-4a1e-9d2c-6b5a4c3d2e10",
  "livemode": false,
  "status": "preview_ready",
  "spec_id": "spc_9wTv2c1Kd8Qe",
  "preview_url": "https://partner.svoyager.com/v1/photo-sessions/3f9c1e77-2b8a-4a1e-9d2c-6b5a4c3d2e10/preview",
  "watermarked": true,
  "issues": [],
  "created_at": "2026-07-24T18: 30: 00Z"
}
Błędy
StatusKodGdy
400missing_idempotency_keyThe `Idempotency-Key` header is missing.
400missing_upload_ref`upload_ref` is missing.
400missing_spec_id`spec_id` is missing.
400invalid_upload_refThe referenced upload could not be read.
413file_too_largeThe uploaded file exceeds 10 MB.
415unsupported_formatThe uploaded file is not an accepted image format.
404spec_not_foundNo active specification matches `spec_id`.
402no_active_planNo active plan is assigned for this environment.
402quota_exceededIncluded preview quota for the period is exhausted.
402plan_inactiveThe plan is not active for this environment.
409idempotency_key_reuseThe key was reused with a different body.
409request_in_progressA request with this key is still processing.
422unprocessable_imageThe image could not be processed.
502provider_errorThe preview could not be generated upstream — retry shortly.
503provider_busyThe processing service is busy — retry shortly.

Oprócz tego standardowe błędy uwierzytelniania, uprawnień i ograniczeń częstotliwości — zobacz Błędy i ponowne próby.

GET/v1/photo-sessions/{id}

Retrieve a photo session

Fetch a session by id, including its current status, `preview_url`, and any `issues`.

zakres photo.sessions.read
Żądanie
Parametry ścieżki
PoleTypOpis
id*stringSession id.
Przykładowe żądanie
curl
curl "https://partner.svoyager.com/v1/photo-sessions/3f9c1e77-2b8a-4a1e-9d2c-6b5a4c3d2e10" \
  -H "Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxx"
Odpowiedź · 200
200 · application/json
{
  "object": "photo_session",
  "id": "3f9c1e77-2b8a-4a1e-9d2c-6b5a4c3d2e10",
  "livemode": false,
  "status": "preview_ready",
  "spec_id": "spc_9wTv2c1Kd8Qe",
  "preview_url": "https://partner.svoyager.com/v1/photo-sessions/3f9c1e77-2b8a-4a1e-9d2c-6b5a4c3d2e10/preview",
  "watermarked": true,
  "issues": [],
  "created_at": "2026-07-24T18: 30: 00Z"
}
Błędy
StatusKodGdy
404session_not_foundNo session matches the id for this account/environment.

Oprócz tego standardowe błędy uwierzytelniania, uprawnień i ograniczeń częstotliwości — zobacz Błędy i ponowne próby.

GET/v1/photo-sessions/{id}/preview

Download the preview image

Stream the watermarked preview image bytes for a session (SVOYAGER-hosted; the upstream URL is never exposed). This is the resource `preview_url` points to.

zakres photo.sessions.readZwraca bajty obrazu
Żądanie
Parametry ścieżki
PoleTypOpis
id*stringSession id.
  • Returns raw `image/*` bytes on success (not JSON).
Przykładowe żądanie
curl
curl "https://partner.svoyager.com/v1/photo-sessions/3f9c1e77-2b8a-4a1e-9d2c-6b5a4c3d2e10/preview" \
  -H "Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxx" \
  --output preview.jpg
Odpowiedź · 200

W przypadku powodzenia punkt końcowy przesyła strumieniowo surowe bajty obrazu (nie w formacie JSON). Zapisz treść odpowiedzi do pliku.

Błędy
StatusKodGdy
404preview_not_foundThe session or its preview does not exist.

Oprócz tego standardowe błędy uwierzytelniania, uprawnień i ograniczeń częstotliwości — zobacz Błędy i ponowne próby.

POST/v1/photo-sessions/{id}/finalize

Finalize a photo

Turn a reviewed session into a deliverable order. In live mode this produces the no-watermark final and spends one `final` unit; in test mode it emulates the final from the preview.

zakres photo.finalize.write Wymagany klucz idempotencji
Żądanie
Parametry ścieżki
PoleTypOpis
id*stringSession id to finalize.
Przykładowe żądanie
curl
curl -X POST "https://partner.svoyager.com/v1/photo-sessions/3f9c1e77-2b8a-4a1e-9d2c-6b5a4c3d2e10/finalize" \
  -H "Authorization: Bearer svoy_sk_live_A8m4Qz1YOURKEYHERExxxxxxx" \
  -H "Idempotency-Key: a7f3c9e1-2b4d-4c8a-9f10-3e5d6b7a8c9d"
Odpowiedź · 201Returns 200 with the existing order if the session was already finalized (never double-charged).
201 · application/json
{
  "object": "photo_order",
  "id": "8a2d5b40-71c6-4f0e-b3a9-1e7c9d05f284",
  "livemode": true,
  "sandbox_emulated": false,
  "status": "final_ready",
  "session_id": "3f9c1e77-2b8a-4a1e-9d2c-6b5a4c3d2e10",
  "spec_id": "spc_9wTv2c1Kd8Qe",
  "final_url": "https://partner.svoyager.com/v1/orders/8a2d5b40-71c6-4f0e-b3a9-1e7c9d05f284/final",
  "watermarked": false,
  "created_at": "2026-07-24T18: 31: 00Z"
}
Błędy
StatusKodGdy
400missing_idempotency_keyThe `Idempotency-Key` header is missing.
404session_not_foundNo session matches the id for this account/environment.
422session_not_finalizableThe session is not in a finalizable state.
402no_active_planNo active plan is assigned for this environment.
402quota_exceededIncluded final quota for the period is exhausted.
402plan_inactiveThe plan is not active for this environment.
409idempotency_key_reuseThe key was reused with a different request.
409request_in_progressA request with this key is still processing.
502provider_errorThe final could not be produced upstream — retry shortly.
503provider_busyThe processing service is busy — retry shortly.

Oprócz tego standardowe błędy uwierzytelniania, uprawnień i ograniczeń częstotliwości — zobacz Błędy i ponowne próby.

GET/v1/orders/{id}

Retrieve an order

Fetch a finalized order by id, including its status and `final_url` once ready.

zakres photo.orders.read
Żądanie
Parametry ścieżki
PoleTypOpis
id*stringOrder id.
Przykładowe żądanie
curl
curl "https://partner.svoyager.com/v1/orders/8a2d5b40-71c6-4f0e-b3a9-1e7c9d05f284" \
  -H "Authorization: Bearer svoy_sk_live_A8m4Qz1YOURKEYHERExxxxxxx"
Odpowiedź · 200
200 · application/json
{
  "object": "photo_order",
  "id": "8a2d5b40-71c6-4f0e-b3a9-1e7c9d05f284",
  "livemode": true,
  "sandbox_emulated": false,
  "status": "final_ready",
  "session_id": "3f9c1e77-2b8a-4a1e-9d2c-6b5a4c3d2e10",
  "spec_id": "spc_9wTv2c1Kd8Qe",
  "final_url": "https://partner.svoyager.com/v1/orders/8a2d5b40-71c6-4f0e-b3a9-1e7c9d05f284/final",
  "watermarked": false,
  "created_at": "2026-07-24T18: 31: 00Z"
}
Błędy
StatusKodGdy
404order_not_foundNo order matches the id for this account/environment.

Oprócz tego standardowe błędy uwierzytelniania, uprawnień i ograniczeń częstotliwości — zobacz Błędy i ponowne próby.

GET/v1/orders/{id}/final

Download the final image

Stream the final image bytes for an order (SVOYAGER-hosted). In live mode this is the no-watermark deliverable; in test mode it is the sandbox-emulated copy. This is the resource `final_url` points to.

zakres photo.orders.readZwraca bajty obrazu
Żądanie
Parametry ścieżki
PoleTypOpis
id*stringOrder id.
  • Returns raw `image/*` bytes on success (not JSON).
Przykładowe żądanie
curl
curl "https://partner.svoyager.com/v1/orders/8a2d5b40-71c6-4f0e-b3a9-1e7c9d05f284/final" \
  -H "Authorization: Bearer svoy_sk_live_A8m4Qz1YOURKEYHERExxxxxxx" \
  --output final.jpg
Odpowiedź · 200

W przypadku powodzenia punkt końcowy przesyła strumieniowo surowe bajty obrazu (nie w formacie JSON). Zapisz treść odpowiedzi do pliku.

Błędy
StatusKodGdy
404final_not_foundThe order or its final does not exist.

Oprócz tego standardowe błędy uwierzytelniania, uprawnień i ograniczeń częstotliwości — zobacz Błędy i ponowne próby.

GET/v1/photo-specifications

List photo specifications

Return a cursor-paginated list of available photo specifications. Filter by country or document type to find the `spec_id` you need.

zakres photo.specs.read
Żądanie
Parametry zapytania
PoleTypOpis
limitintegerPage size, 1–100 (default 20).
starting_afterstringA specification id (`spc_…`) to page after.
countrystringISO-3166 alpha-2 filter, e.g. `US`.
document_typestringFilter by document type, e.g. `passport`.
Przykładowe żądanie
curl
curl -G "https://partner.svoyager.com/v1/photo-specifications" \
  -H "Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxx" \
  --data-urlencode "country=US" \
  --data-urlencode "limit=20"
Odpowiedź · 200
200 · application/json
{
  "object": "list",
  "data": [
    {
      "object": "photo_specification",
      "id": "spc_9wTv2c1Kd8Qe",
      "name": "United States Passport"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
Błędy

Ten punkt końcowy zwraca wyłącznie poniższe standardowe błędy.

Oprócz tego standardowe błędy uwierzytelniania, uprawnień i ograniczeń częstotliwości — zobacz Błędy i ponowne próby.

GET/v1/photo-specifications/{id}

Retrieve a photo specification

Fetch a single specification by its stable `spec_id`, including its full requirements.

zakres photo.specs.read
Żądanie
Parametry ścieżki
PoleTypOpis
id*stringSpecification id (`spc_…`).
Przykładowe żądanie
curl
curl "https://partner.svoyager.com/v1/photo-specifications/spc_9wTv2c1Kd8Qe" \
  -H "Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxx"
Odpowiedź · 200
200 · application/json
{
  "object": "photo_specification",
  "id": "spc_9wTv2c1Kd8Qe",
  "name": "United States Passport",
  "country_code": "US",
  "document_type": "passport",
  "physical_size": {
    "width": 51,
    "height": 51,
    "unit": "mm"
  },
  "pixel_size": {
    "width": 600,
    "height": 600
  },
  "dpi": 300,
  "background": {
    "color": "#FFFFFF",
    "name": "white"
  },
  "requirements": {
    "head_height": "25–35 mm (1–1⅜ in)",
    "eye_to_bottom": "28–35 mm (1⅛–1⅜ in)",
    "recency_months": 6,
    "expression": "neutral",
    "color": true,
    "glasses": "not allowed",
    "eyes_and_ears": "both eyes open"
  },
  "updated_at": "2026-07-01T12: 00: 00Z"
}
Błędy
StatusKodGdy
404spec_not_foundNo active specification matches the id.

Oprócz tego standardowe błędy uwierzytelniania, uprawnień i ograniczeń częstotliwości — zobacz Błędy i ponowne próby.

Należy wysłać nagłówek Idempotency-Key (unikalną wartość, np. UUID), aby ponowione żądanie nigdy nie spowodowało podwójnego naliczenia opłat ani podwójnego przetworzenia. Jest to wymagane w przypadku:

  • POST /v1/photo-sessions
  • POST /v1/photo-sessions/{id}/finalize
  • Ten sam klucz + ta sama treść → odtwarzany jest pierwotny wynik (bez ponownego obciążenia, bez ponownego renderowania).
  • Ten sam klucz + inna treść → 409 idempotency_key_reuse.
  • Błąd umożliwiający ponowną próbę pozwala na ponowne wykonanie operacji przy użyciu tego samego klucza, treści i parametru upload_ref.
  • Równoczesne żądania finalizacji w ramach jednej sesji nigdy nie mogą spowodować utworzenia ani obciążenia dwóch zamówień.

Sesja przechodzi przez stany podglądu; zamówienie przechodzi przez stany finalizacji.

Stan sesji
  • preview_readyWygenerowano podgląd, brak problemów.
  • preview_has_issuespodgląd wygenerowany z uwagami.
  • preview_failedNie udało się wygenerować podglądu.
  • finalizedsesja została zakończona.
Status zamówienia
  • final_readyWersja ostateczna jest już dostępna.
  • processingWersja ostateczna jest w trakcie przygotowywania.
  • failedNie udało się sfinalizować operacji.

Środowisko jest określane przez prefiks klucza — klienci nigdy nie mogą go przekazać. Tryb testowy wyświetla rzeczywisty podgląd z znakiem wodnym, co pozwala przećwiczyć rzeczywisty przebieg operacji, ale emuluje wersję ostateczną, więc nie są wykorzystywane rzeczywiste limity ani renderowanie produkcyjne.

AspectTestNa żywo
livemodefalsetrue
PodglądPrawdziwe, z znakiem wodnymPrawdziwe, z znakiem wodnym
Ostateczna wersjaŚrodowisko testowe emulowane na podstawie wersji podgląduOryginalne, bez znaku wodnego
sandbox_emulatedtruefalse
watermarkedtruefalse
Wykorzystany limitTylko limit testowyDotyczy wyłącznie limitów w trybie na żywo

Twój plan obejmuje określoną liczbę wersji podglądowych i ostatecznych w danym okresie, liczonych oddzielnie. Utworzenie sesji zużywa jedną wersję podglądową; sfinalizowanie zużywa jedną wersję ostateczną. Limit jest rezerwowany atomowo przed rozpoczęciem przetwarzania.

  • Gdy wyczerpie się dołączony limit podglądu lub limit końcowy, żądanie zwraca kod 402 quota_exceeded.
  • Kod 402 oznacza całkowite zablokowanie — ponowne próby nie zakończą się powodzeniem aż do następnego okresu lub zmiany planu.
  • Limity testowe i produkcyjne są całkowicie niezależne.

Każdy błąd wykorzystuje jedną kopertę. Identyfikator request_id pojawia się również w nagłówku odpowiedzi X-Request-Id — należy go podać w zgłoszeniach do pomocy technicznej.

Error envelope
{
  "error": {
    "type": "invalid_request_error",
    "code": "quota_exceeded",
    "message": "Your included final quota for this period is exhausted.",
    "request_id": "req_9wTv2c1Kd8QeR7"
  }
}

Błędy standardowe (wszystkie punkty końcowe)

StatusKodGdy
401invalid_api_keyMissing, malformed, or unknown API key.
401revoked_api_keyThe key was revoked.
401expired_api_keyThe key passed its rotation grace period.
401wrong_environmentA test key was used on live traffic (or vice versa).
403client_disabledThe API client is disabled.
403api_access_revokedAPI access for the account is not active.
403insufficient_scopeThe key lacks the required scope for this endpoint.
429rate_limitedPer-key rate limit exceeded. Honour `Retry-After`.

Kod 422 jest zwracany wyłącznie w przypadku potwierdzonego problemu z obrazem. Kod 402 oznacza wyczerpanie limitu. Kod 409 oznacza konflikt idempotencji lub zasobów.

Kod 429 oznacza, że osiągnięto limit częstotliwości dla danego klucza — należy przestrzegać wartości nagłówka Retry-After. W przypadku kodów 502/503 i innych z serii 5xx należy ponowić próbę z zachowaniem odstępu czasowego i przy użyciu tego samego klucza idempotencji (Idempotency-Key).

Podgląd może zwrócić zero lub więcej problemów, z których każdy składa się ze stabilnego kodu i komunikatu. Należy je wyświetlić użytkownikowi końcowemu, aby mógł ponownie wykonać zdjęcie. Niezrozpoznany sygnał z źródła jest traktowany jako „inny”.

KodKomunikat
face_not_foundNo face was detected in the photo.
uneven_lightingLighting on the face is uneven.
poor_brightnessFace brightness is too dark, too bright, or the photo is low quality.
low_sharpnessThe photo is blurry or not sharp enough.
eyeglasses_not_allowedEyeglasses are not allowed.
sunglasses_not_allowedSunglasses are not allowed.
headwear_not_allowedHats or head coverings are not allowed.
face_mask_not_allowedA face mask is not allowed.
face_covering_foundA face covering was detected.
expression_not_neutralThe expression is not neutral.
crop_bottomNot enough space is visible below the shoulders.
crop_leftNot enough of the left shoulder is visible.
crop_rightNot enough of the right shoulder is visible.
head_turnedThe head is turned too far to the side.
head_tiltedThe head is tilted too far up or down.
not_in_colorThe photo must be in color.
otherThe photo did not meet a requirement.
  • Wersje podglądowe i ostateczne są udostępniane wyłącznie z uwierzytelnionych adresów URL hostowanych przez SVOYAGER. Dostęp wymaga klucza API i prawidłowego zakresu — podstawowa pamięć masowa nigdy nie jest publicznie udostępniana.
  • Przesłane obrazy są prywatne i ograniczone do Twojego konta oraz środowiska; miejsca docelowe przesyłania są krótkotrwałe i przeznaczone do jednorazowego użytku.
  • Zdjęcia z dokumentów są przetwarzane w celu uzyskania wyniku i nie są udostępniane między kontami.

Zobacz warunki przetwarzania, przechowywania i usuwania danych SVOYAGER:Polityka prywatności ·Umowa partnerska i warunki