الانتقال إلى المحتوى الرئيسي
الحصول على العمليةGET

استرداد عملية موجودة بواسطة معرّفها. وفقاً لتعاقد API، يتم بالفعل إرجاع النتيجة بشكل متزامن عند إنشاء العملية — استخدم نقطة النهاية هذه لإعادة الاستعلام والتدقيق والدعم.

MarkdownChatGPTClaude
تحذير

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

نقطة النهاية​

البيئةالرابط
الإنتاجGET https://api.id.unico.app/processes/v1/{processId}
SandboxGET 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

التعاقد فريد — يحمل الحقل idCloud.result الحكم الموحّد للإمكانيات المستخدمة.

توحّد Unico نتائج الإمكانيات المنفّذة في idCloud.result واحد، جاهز لتحديد الخطوة التالية في تدفقك — دون الحاجة إلى تنسيق النتائج الفردية.

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "idCloud": {
    "result": "approved"
  }
}
الحقلالنوعالوصف
idstring (UUID)معرّف العملية.
statusinteger1 (قيد المعالجة)، 2 (تباين)، 3 (انتهت بنجاح)، 4 (ملغاة)، 5 (خطأ).
قيم النتيجة المحتملة
idCloud.resultالمعنىالإجراء الموصى به
approvedشخص حقيقي وهوية تم التحقق منها.تابع التدفق.
deniedلم يتم التحقق من الهوية، فشل فحص لايفنس، أو تم تحديد مخاطر شديدة.أنهِ التدفق أو أعد التوجيه إلى تدفق بديل.
critical-riskتم تحديد مستوى مخاطر حرج.أنهِ التدفق أو وجّهه إلى مراجعة يدوية.
high-riskتم تحديد مستوى مخاطر مرتفع.وجّه إلى مراجعة يدوية أو تدفق بديل.
retryالتقاط أو درجة غير كافية للتقييم.اطلب من المستخدم التقاطاً جديداً.
inconclusiveلا يوجد دليل كافٍ لإصدار حكم.وجّه إلى مراجعة يدوية أو تدفق بديل.

تعتمد القيم المُرجعة على الوصفة المكوّنة في APIKey الخاص بك. انظر التدفقات لمعرفة قيم النتيجة التي يمكن أن ترجعها كل وصفة.

Brazilقد يتلقى العملاء في البرازيل الاستجابة حسب الإمكانية

يظل الهيكل العام للاستجابة كما هو — النتيجة الواحدة هي الافتراضية.

قد تتلقى عمليات التكامل في البرازيل النتائج المفتوحة لكل إمكانية على حدة. تضيف كل إمكانية مفعّلة في APIKey كتلتها الخاصة إلى الاستجابة — يتم حذف الحقول الخاصة بالإمكانيات غير المفعّلة.

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "yes"
  },
  "riskLevel": {
    "result": "inconclusive"
  },
  "idFace": {
    "personId": "a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890",
    "result": "FOUND"
  },
  "identityFraudsters": {
    "result": "inconclusive"
  },
  "government": {
    "serpro": 87
  },
  "liveness": 1,
  "idAge": {
    "result": "yes"
  },
  "cardholderVerification": {
    "result": "approved"
  }
}
الحقلالنوعالوصف
unicoId.resultstringyes، no، inconclusive — انظر التحقق من الهوية.
riskLevel.resultstringnot_approved، critical_risk، high_risk، inconclusive — انظر تصنيف مخاطر الاحتيال.
idFace.resultstringFOUND — انظر معرّف الوجه.
idFace.personIdstringمعرّف مستقر وغير شفاف للوجه، يُعاد جنبًا إلى جنب مع idFace.result = FOUND. عندما يتعذّر التعرف على أي وجه في الصورة، تُعيد العملية الخطأ 20532 بدلاً من كتلة idFace.
identityFraudsters.resultstringمهجور. استخدم riskLevel بدلاً منه. يمكن للعملاء الذين لديهم عمليات تكامل جارية الاستمرار في استخدامه أثناء تنسيق الترحيل مع فريق مشروعهم.
government.serprointegerدرجة تشابه Serpro (0–100، ‎-1‎، ‎-2‎). متاح في البرازيل فقط. انظر عائد تشابه Serpro.
livenessinteger1 (نجح)، 2 (فشل) — انظر لايفنس.
idAge.resultstringyes، no، inconclusive — انظر التحقق من العمر. متاح في البرازيل فقط.
scoreintegerدرجة مخاطر احتمالية. موجودة عندما تكون unicoId.result = inconclusive وتنسيق درجة المخاطر نشط. القيم الموجبة تشير إلى احتمالية أعلى لكون الشخص هو صاحب الحساب؛ القيم السالبة تشير إلى مخاطر أعلى. متاح في البرازيل فقط.
cardholderVerification.resultstringapproved، unsure — انظر Cardholder Verification. غائب أثناء عدم بلوغ status قيمة 3 (منتهية) بعد. متاح في البرازيل فقط.
Mexicoقد يتلقى العملاء في المكسيك كتلة التحقق من RENAPO

تحتفظ الاستجابة بالهيكل نفسه وتضيف كتلة idGov.

تتلقى عمليات التكامل في المكسيك التي فُعّل فيها التحقق من RENAPO كتلة idGov إضافية تتضمن السجل الذي تحتفظ به RENAPO لـ CURP الخاص بالمستخدم. وهي إجابة منفصلة عن نتيجة الهوية.

{
  "id": "11111111-2222-3333-4444-555555555555",
  "status": 3,
  "idCloud": { "result": "approved" },
  "idGov": {
    "government_valid": true,
    "curp": "PUEA880304MDFRJN04",
    "government_name": "ANA PRUEBA EJEMPLO",
    "date_of_birth": "1988-03-04",
    "age": 38,
    "gender": "F",
    "deceased": false,
    "is_mexican": true,
    "citizenship": "MEXICO",
    "state_of_birth": "Ciudad de México",
    "state_iso": "MX-CMX",
    "issuing_entity_code": "DF",
    "municipality_registration": ""
  }
}
الحقلالنوعالوصف
idGovobjectسجل RENAPO لـ CURP. غائب عندما لا تكون القدرة مفعّلة. {} عندما لا تستجيب RENAPO. المكسيك فقط. انظر التحقق من RENAPO.

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

تعاقد 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.معامل رمز التكامل مفقود من ترويسة الطلب.

التدفقات​

الوصفة هي مجموعة الإمكانيات (لايفنس، التحقق من الهوية، إشارات المخاطر، المستندات...) المكوّنة في APIKey الخاص بمشروعك. تحدد ما تنفذه Unico في كل عملية وكيف يتم توحيد النتائج في result واحد — لا تحتاج إلى تنسيق أي شيء من جانبك.

تحتفظ Unico بكتالوج من الوصفات المُعدّة مسبقاً، المسماة والمرقمة بالإصدار (مثلاً byunico-idlive-idunico-oneresponse-std). بعضها حصري للبرازيل، مثل تلك التي تتضمن Score أو Serpro أو التحقق من العمر.

ما هي الإمكانيات التي تُشغّل عمليتك؟

مجموعة الإمكانيات — تدفق مشروعك — مُحددة في إعدادات APIKey الخاص بك. راجع الوصفات المُعدّة مسبقاً أو تواصل مع مسؤول مشروع Unico لتخصيصها.

آخر تحديث في