SVOYAGER ID Photo API
حوّل أي صورة إلى صورة متوافقة مع متطلبات بطاقة الهوية / جواز السفر / التأشيرة.
نظرة عامة
ما الذي يفعله
تعمل SVOYAGER ID Photo API على تحويل صورة شخصية عادية إلى صورة وثائقية متوافقة مع المعايير. ID Photo هو منتج واحد: حيث يتم تمثيل جواز السفر والتأشيرة وتصريح الإقامة والهوية الوطنية كمواصفات وثائقية، وليست منتجات منفصلة. يمكنك تحميل صورة، وإنشاء معاينة بعلامة مائية وفقًا لمواصفات معينة، ثم إتمام العملية للحصول على النتيجة الخالية من العلامة المائية.
معاينة → سير العمل النهائي
- 1قم بتحميل صورة. قم بإنشاء وجهة تحميل وأرسل بايتات الصورة إليها.
- 2إنشاء جلسة عمل. اعرض معاينة بعلامة مائية وفقًا للمواصفات. راجع المشكلات التي تم الإبلاغ عنها.
- 3الإنهاء. حوّل الجلسة التي تمت مراجعتها إلى طلب واحصل على النسخة النهائية الخالية من العلامة المائية.
البدء السريع
يتم توثيق كل طلب باستخدام مفتاح سري من نوع Bearer. ابدأ في وضع الاختبار:
# 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"عنوان URL الأساسي والبيئات
يتم تقديم جميع نقاط النهاية عبر عنوان URL أساسي واحد:
https://partner.svoyager.com/v1لا يوجد مسار أو معلمة للبيئة. ويتم تحديد ما إذا كان الطلب يعمل في بيئة الاختبار أم البيئة الحية بشكل كامل من خلال بادئة مفتاح API الخاص بك (svoy_sk_test_… مقابل svoy_sk_live_…). وتكرر الاستجابات ذلك على أنه livemode.
المصادقة
مفاتيح API
قم بالمصادقة على كل طلب باستخدام رأس «Authorization» الذي يحمل مفتاحك السري. يتم إنشاء المفاتيح وتبديلها في «Partner Center».
Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxxتحدد البادئة البيئة: svoy_sk_test_… للاختبار، و svoy_sk_live_… للإنتاج. لا يمكن لمفتاح الاختبار أبدًا العمل على بيانات الإنتاج (والعكس صحيح) — وتؤدي حالات عدم التطابق إلى إرجاع الرمز 401 wrong_environment.
النطاقات
تحمل المفاتيح نطاقات صريحة ذات أقل الامتيازات. أي طلب يفتقد النطاق المطلوب يُرجع الرمز 403 insufficient_scope.
| النطاق | المنح |
|---|---|
| photo.specs.read | List and retrieve photo specifications. |
| photo.sessions.read | Retrieve sessions and their previews. |
| photo.sessions.write | Create uploads and photo sessions (previews). |
| photo.finalize.write | Finalize a session into a no-watermark order. |
| photo.orders.read | Retrieve orders and download finals. |
الحفاظ على أمان المفاتيح
المفاتيح السرية مخصصة للاستخدام بين الخوادم فقط. لا تقم أبدًا بتضمين مفتاح سري في كود المتصفح أو الجوال، أو في مستودع عام، أو في حزمة من جانب العميل. إذا تم الكشف عن مفتاح ما، فقم بتغييره على الفور في «مركز الشركاء».
نقاط النهاية
يتم تمييز الحقول الإلزامية بعلامة *. تستخدم الأمثلة بيانات اعتماد مؤقتة — ولا تستخدم أبدًا مفاتيح حقيقية.
/v1/uploadsUpload 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.
photo.sessions.write| الحقل | النوع | الوصف |
|---|---|---|
| content_type* | string | MIME type of the image.image/jpegimage/pngimage/webpimage/heic |
- `upload_url` is single-use and expires; upload promptly and do not modify the URL.
# 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{
"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"
}| الحالة | الكود | عندما |
|---|---|---|
| 400 | missing_content_type | `content_type` was not provided. |
| 415 | unsupported_format | The content type is not an accepted image format. |
| 503 | temporarily_unavailable | Uploads are temporarily unavailable. |
| 502 | upload_init_failed | The upload could not be initialised — retry shortly. |
بالإضافة إلى أخطاء المصادقة والأذونات وحدود المعدل القياسية — انظر الأخطاء وإعادة المحاولة.
/v1/photo-sessionsCreate a photo session
Generate a watermarked preview from an upload against a specification. Spends one `preview` unit of your plan. Review `issues` before finalizing.
photo.sessions.write مطلوب Idempotency-Key| الحقل | النوع | الوصف |
|---|---|---|
| upload_ref* | string | The `upload_ref` from Upload a photo. |
| spec_id* | string | The `photo_specification` id (`spc_…`) to render against. |
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"}'{
"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"
}| الحالة | الكود | عندما |
|---|---|---|
| 400 | missing_idempotency_key | The `Idempotency-Key` header is missing. |
| 400 | missing_upload_ref | `upload_ref` is missing. |
| 400 | missing_spec_id | `spec_id` is missing. |
| 400 | invalid_upload_ref | The referenced upload could not be read. |
| 413 | file_too_large | The uploaded file exceeds 10 MB. |
| 415 | unsupported_format | The uploaded file is not an accepted image format. |
| 404 | spec_not_found | No active specification matches `spec_id`. |
| 402 | no_active_plan | No active plan is assigned for this environment. |
| 402 | quota_exceeded | Included preview quota for the period is exhausted. |
| 402 | plan_inactive | The plan is not active for this environment. |
| 409 | idempotency_key_reuse | The key was reused with a different body. |
| 409 | request_in_progress | A request with this key is still processing. |
| 422 | unprocessable_image | The image could not be processed. |
| 502 | provider_error | The preview could not be generated upstream — retry shortly. |
| 503 | provider_busy | The processing service is busy — retry shortly. |
بالإضافة إلى أخطاء المصادقة والأذونات وحدود المعدل القياسية — انظر الأخطاء وإعادة المحاولة.
/v1/photo-sessions/{id}Retrieve a photo session
Fetch a session by id, including its current status, `preview_url`, and any `issues`.
photo.sessions.read| الحقل | النوع | الوصف |
|---|---|---|
| id* | string | Session id. |
curl "https://partner.svoyager.com/v1/photo-sessions/3f9c1e77-2b8a-4a1e-9d2c-6b5a4c3d2e10" \
-H "Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxx"{
"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"
}| الحالة | الكود | عندما |
|---|---|---|
| 404 | session_not_found | No session matches the id for this account/environment. |
بالإضافة إلى أخطاء المصادقة والأذونات وحدود المعدل القياسية — انظر الأخطاء وإعادة المحاولة.
/v1/photo-sessions/{id}/previewDownload 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.
photo.sessions.readتُرجع بايتات الصورة| الحقل | النوع | الوصف |
|---|---|---|
| id* | string | Session id. |
- Returns raw `image/*` bytes on success (not JSON).
curl "https://partner.svoyager.com/v1/photo-sessions/3f9c1e77-2b8a-4a1e-9d2c-6b5a4c3d2e10/preview" \
-H "Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxx" \
--output preview.jpgفي حالة النجاح، تقوم نقطة النهاية ببث بايتات الصورة الخام (وليس JSON). احفظ نص الاستجابة في ملف.
| الحالة | الكود | عندما |
|---|---|---|
| 404 | preview_not_found | The session or its preview does not exist. |
بالإضافة إلى أخطاء المصادقة والأذونات وحدود المعدل القياسية — انظر الأخطاء وإعادة المحاولة.
/v1/photo-sessions/{id}/finalizeFinalize 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.
photo.finalize.write مطلوب Idempotency-Key| الحقل | النوع | الوصف |
|---|---|---|
| id* | string | Session id to finalize. |
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"{
"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"
}| الحالة | الكود | عندما |
|---|---|---|
| 400 | missing_idempotency_key | The `Idempotency-Key` header is missing. |
| 404 | session_not_found | No session matches the id for this account/environment. |
| 422 | session_not_finalizable | The session is not in a finalizable state. |
| 402 | no_active_plan | No active plan is assigned for this environment. |
| 402 | quota_exceeded | Included final quota for the period is exhausted. |
| 402 | plan_inactive | The plan is not active for this environment. |
| 409 | idempotency_key_reuse | The key was reused with a different request. |
| 409 | request_in_progress | A request with this key is still processing. |
| 502 | provider_error | The final could not be produced upstream — retry shortly. |
| 503 | provider_busy | The processing service is busy — retry shortly. |
بالإضافة إلى أخطاء المصادقة والأذونات وحدود المعدل القياسية — انظر الأخطاء وإعادة المحاولة.
/v1/orders/{id}Retrieve an order
Fetch a finalized order by id, including its status and `final_url` once ready.
photo.orders.read| الحقل | النوع | الوصف |
|---|---|---|
| id* | string | Order id. |
curl "https://partner.svoyager.com/v1/orders/8a2d5b40-71c6-4f0e-b3a9-1e7c9d05f284" \
-H "Authorization: Bearer svoy_sk_live_A8m4Qz1YOURKEYHERExxxxxxx"{
"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"
}| الحالة | الكود | عندما |
|---|---|---|
| 404 | order_not_found | No order matches the id for this account/environment. |
بالإضافة إلى أخطاء المصادقة والأذونات وحدود المعدل القياسية — انظر الأخطاء وإعادة المحاولة.
/v1/orders/{id}/finalDownload 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.
photo.orders.readتُرجع بايتات الصورة| الحقل | النوع | الوصف |
|---|---|---|
| id* | string | Order id. |
- Returns raw `image/*` bytes on success (not JSON).
curl "https://partner.svoyager.com/v1/orders/8a2d5b40-71c6-4f0e-b3a9-1e7c9d05f284/final" \
-H "Authorization: Bearer svoy_sk_live_A8m4Qz1YOURKEYHERExxxxxxx" \
--output final.jpgفي حالة النجاح، تقوم نقطة النهاية ببث بايتات الصورة الخام (وليس JSON). احفظ نص الاستجابة في ملف.
| الحالة | الكود | عندما |
|---|---|---|
| 404 | final_not_found | The order or its final does not exist. |
بالإضافة إلى أخطاء المصادقة والأذونات وحدود المعدل القياسية — انظر الأخطاء وإعادة المحاولة.
/v1/photo-specificationsList photo specifications
Return a cursor-paginated list of available photo specifications. Filter by country or document type to find the `spec_id` you need.
photo.specs.read| الحقل | النوع | الوصف |
|---|---|---|
| limit | integer | Page size, 1–100 (default 20). |
| starting_after | string | A specification id (`spc_…`) to page after. |
| country | string | ISO-3166 alpha-2 filter, e.g. `US`. |
| document_type | string | Filter by document type, e.g. `passport`. |
curl -G "https://partner.svoyager.com/v1/photo-specifications" \
-H "Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxx" \
--data-urlencode "country=US" \
--data-urlencode "limit=20"{
"object": "list",
"data": [
{
"object": "photo_specification",
"id": "spc_9wTv2c1Kd8Qe",
"name": "United States Passport"
}
],
"has_more": false,
"next_cursor": null
}تُرجع نقطة النهاية هذه الأخطاء القياسية التالية فقط.
بالإضافة إلى أخطاء المصادقة والأذونات وحدود المعدل القياسية — انظر الأخطاء وإعادة المحاولة.
/v1/photo-specifications/{id}Retrieve a photo specification
Fetch a single specification by its stable `spec_id`, including its full requirements.
photo.specs.read| الحقل | النوع | الوصف |
|---|---|---|
| id* | string | Specification id (`spc_…`). |
curl "https://partner.svoyager.com/v1/photo-specifications/spc_9wTv2c1Kd8Qe" \
-H "Authorization: Bearer svoy_sk_test_R2p9Kx7YOURKEYHERExxxxxxx"{
"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"
}| الحالة | الكود | عندما |
|---|---|---|
| 404 | spec_not_found | No active specification matches the id. |
بالإضافة إلى أخطاء المصادقة والأذونات وحدود المعدل القياسية — انظر الأخطاء وإعادة المحاولة.
أرسل رأس Idempotency-Key (قيمة فريدة، مثل UUID) حتى لا يتم فرض رسوم مزدوجة أو معالجة مزدوجة على الطلب الذي تمت إعادة محاولته. وهو مطلوب في:
POST /v1/photo-sessionsPOST /v1/photo-sessions/{id}/finalize
- • نفس المفتاح + نفس النص الأساسي → يتم إعادة عرض النتيجة الأصلية (بدون رسوم إضافية، وبدون عرض ثانٍ).
- • نفس المفتاح + نص مختلف → 409 idempotency_key_reuse.
- • يتيح لك الفشل القابل لإعادة المحاولة إعادة المحاولة باستخدام نفس المفتاح والنص الأساسي وupload_ref.
- • لا يمكن أبدًا لطلبات الإنهاء المتزامنة لجلسة واحدة إنشاء طلبين أو فرض رسوم عليهما.
تمر الجلسة عبر حالات المعاينة؛ بينما يمر الطلب عبر حالات الإنهاء.
preview_ready— تم إنشاء معاينة، ولا توجد مشكلات.preview_has_issues— معاينة تم إنشاؤها مع وجود مشكلات.preview_failed— تعذر إنشاء المعاينة.finalized— تم إنهاء الجلسة.
final_ready— النسخة النهائية متاحة.processing— يجري إعداد النسخة النهائية.failed— فشل إتمام العملية.
يتم تحديد البيئة من خلال بادئة المفتاح الخاصة بك — ولا يمكن للعملاء تجاوزها أبدًا. يعمل وضع الاختبار على عرض معاينة حقيقية تحمل علامة مائية حتى تتمكن من تجربة التدفق الفعلي، ولكنه يحاكي النسخة النهائية بحيث لا يتم استخدام الحصة الحية أو العرض النهائي.
| الجانب | اختبار | مباشر |
|---|---|---|
| livemode | false | true |
| معاينة | حقيقي، مع علامة مائية | حقيقي، مع علامة مائية |
| نهائي | محاكاة بيئة الاختبار من النسخة التجريبية | حقيقي، بدون علامة مائية |
| sandbox_emulated | true | false |
| watermarked | true | false |
| الحصة المستهلكة | حصة الاختبار فقط | الحصة المباشرة فقط |
تتضمن خطتك عددًا من «المعاينات» و«النسخ النهائية» لكل فترة، ويتم احتسابها بشكل منفصل. يستهلك إنشاء جلسة واحدة من «المعاينات»؛ بينما يستهلك إنهاء الجلسة واحدة من «النسخ النهائية». يتم حجز الحصة بشكل فوري قبل المعالجة.
- عند استنفاد الحصة المضمنة في النسخة التجريبية أو النهائية، يُرجع الطلب الرمز 402 quota_exceeded.
- الرمز 402 يمثل توقفًا تامًا — ولن تنجح إعادة المحاولة حتى الفترة التالية أو تغيير الخطة.
- الحصص الخاصة بالاختبار والحصص الحية مستقلة تمامًا عن بعضها البعض.
يستخدم كل خطأ مغلفًا واحدًا. يظهر request_id أيضًا في رأس استجابة X-Request-Id — قم بتضمينه في طلبات الدعم.
{
"error": {
"type": "invalid_request_error",
"code": "quota_exceeded",
"message": "Your included final quota for this period is exhausted.",
"request_id": "req_9wTv2c1Kd8QeR7"
}
}الأخطاء القياسية (جميع نقاط النهاية)
| الحالة | الكود | عندما |
|---|---|---|
| 401 | invalid_api_key | Missing, malformed, or unknown API key. |
| 401 | revoked_api_key | The key was revoked. |
| 401 | expired_api_key | The key passed its rotation grace period. |
| 401 | wrong_environment | A test key was used on live traffic (or vice versa). |
| 403 | client_disabled | The API client is disabled. |
| 403 | api_access_revoked | API access for the account is not active. |
| 403 | insufficient_scope | The key lacks the required scope for this endpoint. |
| 429 | rate_limited | Per-key rate limit exceeded. Honour `Retry-After`. |
يتم إرجاع الرمز 422 فقط في حالة وجود مشكلة مؤكدة في الصورة. الرمز 402 يعني استنفاد الحصة المخصصة. الرمز 409 يشير إلى تعارض في الموارد أو تكرار العمليات.
429 تعني أنك وصلت إلى الحد الأقصى لمعدل الاستخدام لكل مفتاح — التزم برأس Retry-After. بالنسبة لـ 502/503 ورموز 5xx الأخرى، أعد المحاولة مع التراجع (backoff) ونفس Idempotency-Key.
قد تعرض المعاينة صفرًا أو أكثر من المشكلات، كل منها عبارة عن رمز ثابت + رسالة. اعرض هذه المشكلات للمستخدم النهائي حتى يتمكن من إعادة التقاط الصورة. تتحول الإشارة غير المعترف بها من المصدر إلى «other».
| الكود | الرسالة |
|---|---|
| face_not_found | No face was detected in the photo. |
| uneven_lighting | Lighting on the face is uneven. |
| poor_brightness | Face brightness is too dark, too bright, or the photo is low quality. |
| low_sharpness | The photo is blurry or not sharp enough. |
| eyeglasses_not_allowed | Eyeglasses are not allowed. |
| sunglasses_not_allowed | Sunglasses are not allowed. |
| headwear_not_allowed | Hats or head coverings are not allowed. |
| face_mask_not_allowed | A face mask is not allowed. |
| face_covering_found | A face covering was detected. |
| expression_not_neutral | The expression is not neutral. |
| crop_bottom | Not enough space is visible below the shoulders. |
| crop_left | Not enough of the left shoulder is visible. |
| crop_right | Not enough of the right shoulder is visible. |
| head_turned | The head is turned too far to the side. |
| head_tilted | The head is tilted too far up or down. |
| not_in_color | The photo must be in color. |
| other | The photo did not meet a requirement. |
- • يتم تقديم النسخ المسبقة والنسخ النهائية فقط من عناوين URL المصادق عليها والمستضافة على SVOYAGER. يتطلب الوصول مفتاح API الخاص بك والنطاق الصحيح — ولا يتم الكشف عن التخزين الأساسي للجمهور أبدًا.
- • الصور التي تم تحميلها خاصة ومقتصرة على حسابك وبيئتك؛ وأهداف التحميل قصيرة الأمد وذات استخدام واحد.
- • تتم معالجة صور المستندات لإنتاج النتيجة الخاصة بك ولا يتم مشاركتها عبر الحسابات.
انظر شروط معالجة البيانات والاحتفاظ بها وحذفها الخاصة بـ SVOYAGER:سياسة الخصوصية ·اتفاقية الشراكة والشروط