الانتقال إلى المحتوى الرئيسي

الحصول على العملية

تحذير

قبل استرداد العملية، راجع إعداد webhook والاستراتيجيات الاحتياطية — انقر هنا.

في عقد API، تُعدّ استجابة POST /processes/v1 بالفعل النتيجة النهائية. توجد هذه النقطة النهائية لإعادة الاستعلام — على سبيل المثال، عندما تحتاج إلى فحص عملية حفظتها مسبقاً، أو مراجعة معاملة سابقة.

نقطة النهاية

البيئةالرابط
الإنتاجGET https://api.id.unico.app/processes/v1/{processId}
بيئة الاختبارGET https://api.id.uat.unico.app/processes/v1/{processId}

الطلب

الترويسات
الترويسةالقيمة
AuthorizationBearer <access_token>
APIKEYمفتاح API المُخصص.
معاملات المسار
المعاملالنوعمطلوبالوصف
processIdstring (UUID)نعممعرّف العملية الذي يُعيده إنشاء عملية.

مثال

curl -X GET https://api.id.unico.app/processes/v1/$PROCESS_ID \
-H "Authorization: Bearer $TOKEN" \
-H "APIKEY: $API_KEY"

الاستجابات

200 OK
{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"unicoId": { "result": "yes" },
"identityFraudsters": { "result": "inconclusive" },
"government": { "serpro": 87 },
"liveness": 1
}
الحقلالنوعالوصف
idstring (UUID)معرّف العملية.
statusinteger1 (قيد المعالجة)، 2 (تباين)، 3 (اكتمل بنجاح)، 4 (ملغى)، 5 (خطأ).
unicoId.resultstringyes، no، inconclusive — راجع التحقق من الهوية.
identityFraudsters.resultstringyes، inconclusive — راجع تصنيف المخاطر.
government.serprointegerدرجة التشابه في Serpro (0–100، -1، -2). راجع تشابه Serpro.
livenessinteger1 (اجتاز)، 2 (فشل) — راجع Liveness.
scoreintegerدرجة المخاطرة الاحتمالية. موجود عندما unicoId.result = inconclusive وتكون تنسيق درجة المخاطرة نشطاً. القيم الإيجابية تشير إلى احتمالية أعلى لكونه الحامل الأصلي؛ القيم السلبية تشير إلى مخاطرة أعلى.
400 Bad Request

معامل المسار processId مفقود أو غير صحيح. انظر رموز الخطأ أدناه.

403 Forbidden

رمز Bearer أو APIKEY مفقود أو منتهي الصلاحية أو غير صالح.

404 Not Found

processId غير موجود أو لا ينتمي إلى المستأجر المصادَق عليه.

410 Gone

العملية موجودة لكنها انتهت بخطأ. تُعيد فقط id وstatus: 5.

429 Too Many Requests

تم الوصول إلى حد المعدل. انظر حدود المعدل.

500 Internal Server Error

خطأ غير متوقع في الخادم.

متى تستخدم هذه النقطة النهائية

يُعيد عقد API النتائج بشكل متزامن، لذا لا تحتاج معظم عمليات التكامل إلى هذه النقطة النهائية. استخدمها عندما:

  • حفظت processId فقط وتحتاج إلى استرداد النتيجة الكاملة لاحقاً (مراجعة، دعم).
  • تشتبه في أن الاستجابة الأصلية ضاعت أثناء الإرسال (خطأ في الشبكة بعد اكتمال المنصة للعمل).
  • تبني أداة مكتب خلفي تراجع العمليات التاريخية.

رموز الخطأ

الرمزالرسالةالوصف
20023O parâmetro processId não foi informado.معامل معرّف العملية مفقود.
20002O parâmetro APIKey não foi informado.معامل APIKEY مفقود من ترويسة الطلب.
20001O parâmetro authtoken não foi informado.معامل رمز التكامل مفقود من ترويسة الطلب.