--- title: الحصول على العملية description: استرجاع الحالة والنتيجة الحاليتين لعملية تحقق. canonical: https://developer.unico.io/ar/developers/api-reference/get-process locale: ar generated_by: markdown-export --- - [/ar/](/ar/) - مرجع API - الحصول على العملية **في هذه الصفحةالحصول على العمليةGETاسترجاع عملية موجودة بواسطة معرّفها. وفقًا لعقد API، تُعاد النتيجة بشكل متزامن عند إنشاء العملية — استخدم هذه النقطة النهائية لإعادة الاستعلام والتدقيق والدعم. تحذيرقبل استرجاع العملية، راجع تهيئة webhook واستراتيجيات fallback الخاصة بنا — [اضغط هنا](/ar/developers/webhooks-and-events/setup). ### النقطة النهائية​ البيئةالرابط**الإنتاج**`GET https://api.idcloud.unico.app/client/v1/process/{processId}`**Sandbox**`GET https://api.idcloud.uat.unico.app/client/v1/process/{processId}` ### الطلب​ Headers Headerالقيمة`Authorization``Bearer ` معاملات المسار المعاملالنوعمطلوبالوصف`processId`string (UUID)نعممعرّف العملية الذي أعادته [إنشاء عملية](/ar/developers/api-reference/post-processes). ### مثال​ cURLNode.js``` curl -X GET https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID \ -H "Authorization: Bearer $TOKEN" ``` ``` import fetch from 'node-fetch';const res = await fetch( `https://api.idcloud.unico.app/client/v1/process/${processId}`, { headers: { Authorization: `Bearer ${accessToken}` } });const { process: proc } = await res.json(); ``` ### الاستجابات​ 200 OK ``` { "process": { "id": "226fd950-4b80-4da6-a476-ba9d397ddc91", "flow": "id_r2", "callbackUri": "/", "userRedirectUrl": "https://cadastro.uat.unico.app/flow?collect-data=true&dynamic-wrapper=true&id=226fd950-4b80-4da6-a476-ba9d397ddc91", "state": "PROCESS_STATE_FINISHED", "result": "PROCESS_RESULT_APPROVED", "createdAt": "2026-08-06T01:42:21.693615Z", "finishedAt": "2026-08-06T01:43:03.080508Z", "person": { "duiType": "DUI_TYPE_BR_CPF", "duiValue": "40*******50", "friendlyName": "teste", "email": "", "phone": "5511999999999", "notifications": [ { "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP" } ], "phoneCountryCodeAlpha3": "" }, "purpose": "personAuthentication", "services": [], "authenticationInfo": { "authenticationId": "55cba227-9828-49df-a16f-bcdaa7bdaa4d" }, "capacities": ["PROCESS_CAPACITY_IDCLOUDONE"], "expiresAt": "2026-08-13T01:42:21.536500Z", "token": "", "companyData": { "branchId": "", "countryCode": "BRA" }, "simulated": false }} ``` حقول العملية الحقلالمعنى`id`UUID الخاص بالعملية؛ المفتاح المستخدم للاستعلام عن التدفق وتتبعه.`flow`نوع الرحلة التي تم تنفيذها (مثل `id_r2`، `idlivetrust_r2`، `idtrust_r2`، ...).`callbackUri`عنوان URL لإعادة الاتصال الذي يُعاد توجيه تطبيق العميل إليه في نهاية التدفق.`userRedirectUrl`عنوان URL الكامل لصفحة CbU التي يفتحها المستخدم لتنفيذ الرحلة (يحمل `id` وأعلام السلوك).`state`حالة دورة حياة العملية. قيم `PROCESS_STATE_*` (مثل `CREATED`، `FAILED`، `FINISHED`، `AWAITING_FOR_DOCUMENT`، `UNSPECIFIED`).`result`القرار النهائي للتقييم. قيم `PROCESS_RESULT_*` (مثل `APPROVED`، `AUTHENTICATED`، `NOT_APPROVED`، ...). حاسم فقط عندما تكون `state = PROCESS_STATE_FINISHED`.`createdAt`الطابع الزمني لإنشاء العملية (UTC).`finishedAt`الطابع الزمني لاكتمال العملية (UTC).`person`كائن فرعي يحتوي على بيانات الشخص الذي يجري التحقق منه.`purpose`الغرض من العملية (مثل `personAuthentication`، تسجيل شخص).`services`قائمة الخدمات الإضافية المرتبطة بالعملية؛ فارغة عند عدم وجودها.`authenticationInfo.​authenticationId`معرّف حدث مصادقة الهوية الذي تم إنشاؤه بواسطة التدفق.`capacities`الإمكانيات/المنتجات المستخدَمة. قيم `PROCESS_CAPACITY_*` (مثل `IDCLOUDONE`).`expiresAt`الطابع الزمني لانتهاء صلاحية العملية/الرابط (UTC).`token`رمز الجلسة/الوصول المرتبط بالعملية (قد يكون فارغًا).`companyData`كائن فرعي يحتوي على بيانات الشركة/المستأجر الذي يملك العملية.`simulated`قيمة منطقية؛ تحدد إذا كانت هذه عملية محاكاة/sandbox (`true`) أو عملية حقيقية (`false`). حقول الشخص الحقلالمعنى`duiType`نوع وثيقة التعريف الفريدة. قيم `DUI_TYPE_*` (مثل `BR_CPF`).`duiValue`قيمة الوثيقة (مثل رقم CPF).`friendlyName`اسم ودّي/لقب للشخص (نص حر، غير مُتحقَّق منه).`email`البريد الإلكتروني للشخص؛ قد يكون فارغًا.`phone`رقم الهاتف بصيغة E.164 (رمز الدولة + رمز المنطقة + الرقم).`notifications`قائمة قنوات الإشعارات. يحمل كل عنصر `notificationChannel` بقيم `NOTIFICATION_CHANNEL_*` (مثل `WHATSAPP`، `SMS`، `EMAIL`).`phoneCountryCodeAlpha3`رمز الدولة ISO alpha-3 لرقم الهاتف (مثل `BRA`)؛ قد يكون فارغًا. حقول بيانات الشركة الحقلالمعنى`branchId`معرّف فرع المستأجر؛ فارغ عندما لا يكون التقسيم بحسب الفرع.`countryCode`دولة الشركة بصيغة ISO alpha-3 (مثل `BRA`). أنواع الوثائق وحقول OCR يتم الإبلاغ عن أنواع الوثائق التي تستخدم المخطط الموحّد — `unified_schema` في [مرجع الحقول](/ar/assets/files/document-content-fields-0e4663f2ade946e901bbc7523c21f032.json) — كمعرّف النوع بحروف كبيرة الذي تم تحديده خلال الالتقاط: `IDCARD`، `DRIVERLICENSE`، `PASSPORT` أو `VOTERID`. تحافظ جوازات السفر الأمريكية على نوعها الفرعي بدلاً من دمجها في `PASSPORT`، لذا تُعاد أيضًا قيم مثل `POLYCARBONATEPASSPORT`، `PASSPORTCARD` و`PAPERPASSPORT`. على سبيل المثال، يتم الإبلاغ عن `unico.moja.dictionary.ar.generic.v1.IdCard` و`unico.moja.dictionary.us.generic.v1.PolycarbonatePassport` كـ `IDCARD` و`POLYCARBONATEPASSPORT`. يُبلّغ `process.services[].documents[].doc.code` عن نوع الوثيقة كرمز مختصر بحروف كبيرة. يصبح `unico.moja.dictionary.br.cnh.v2.Cnh` هو `CNH`. لا يحمل الرمز الدولة أو إصدار المخطط؛ يُعاد الإصدار بشكل منفصل في `doc.version`. المخططات الخاصة يتم عرض أنواع الوثائق التي تستخدم مخطط حقول خاص بها — والمدرجة تحت `specific_document_schemas` في [مرجع الحقول](/ar/assets/files/document-content-fields-0e4663f2ade946e901bbc7523c21f032.json) — في الجدول أدناه. استخدم نوع القاموس للبحث عن كل مخطط في ذلك الملف. الدولة`doc.code`نوع القاموسالوثيقةBR`RG``unico.​moja.​dictionary.​br.​rg.​v2.​Rg`RGBR`CNH``unico.​moja.​dictionary.​br.​cnh.​v2.​Cnh`CNH (رخصة القيادة)BR`CIN``unico.​moja.​dictionary.​br.​cin.​v1.​Cin`CINBR`PASSAPORTE``unico.​moja.​dictionary.​br.​passaporte.​v1.​Passaporte`جواز السفرMX`INE``unico.​moja.​dictionary.​mx.​ine.​v1.​Ine`بطاقة ناخب INEMX`LPC``unico.​moja.​dictionary.​mx.​lpc.​v1.​Lpc`Licencia para conducir (رخصة القيادة)MX`PASAPORTE``unico.​moja.​dictionary.​mx.​pasaporte.​v1.​Pasaporte`جواز السفر—`UNKNOWN``unico.​moja.​dictionary.​other.​unknown.​v1.​Unknown`تعذّر تحديد النوع — `doc.data` فارغ `PASSAPORTE` و`PASAPORTE` وثيقتان مختلفتانجواز السفر البرازيلي هو `PASSAPORTE` (بحرفي S) والمكسيكي هو `PASAPORTE` (بحرف S واحد)، ويعكس كل منهما تهجئة القاموس الخاص به. هذا ليس خطأً مطبعيًا — لا تعامل القيمتين كمتكافئتين. لا يتم إجراء أي استخراج OCR ولا يُبلَّغ عن أي حقل في `doc.data` عندما يكون `doc.code` هو `UNKNOWN`. قد يستلم العملاء في البرازيل حمولة العملية الكاملةيبقى الهيكل العام للاستجابة كما هو — النتيجة الواحدة هي الإعداد الافتراضي.قد تستلم عمليات التكامل في البرازيل كائن العملية الكامل أدناه، مع نتائج لكل إمكانية في authenticationInfo.``` { "process": { "id": "53060f52-f146-4c12-a234-5bb5031f6f5b", "flow": "iddocs_r2", "callbackUri": "https://example.com/callback", "userRedirectUrl": "https://example.com/redirect", "state": "PROCESS_STATE_FINISHED", "result": "PROCESS_RESULT_OK", "createdAt": "2024-01-01T10:00:00Z", "finishedAt": "2024-01-01T10:15:00Z", "expiresAt": "2024-01-08T10:00:00Z", "purpose": "VERIFICATION", "clientReference": "client-ref-abc", "useCase": "USE_CASE_LOGIN", "capacities": ["liveness", "face_match"], "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "person": { "duiType": "DUI_TYPE_BR_CPF", "duiValue": "12345678909", "friendlyName": "Luke Skywalker", "notifications": [ { "notificationChannel": "email" } ] }, "authenticationInfo": { "authenticationId": "auth-123", "livenessResult": "LIVENESS_RESULT_LIVE", "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE", "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED", "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED", "smartRevalidationResult": "SMART_REVALIDATION_RESULT_UNSPECIFIED", "idAgeResult": "ID_AGE_RESULT_UNSPECIFIED", "scoreEngineResult": { "scoreEnabled": "SCORE_ENABLED_TRUE", "score": 85.5 } }, "companyData": { "branchId": "branch-123", "countryCode": "BR" }, "bioTokenData": { "referenceProcessId": "ref-proc-123", "authenticationId": "auth-ref-123" }, "services": [ { "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47", "documentIds": ["doc-abc-123"], "consent_granted": true, "documents": [ { "doc_id": "doc-abc-123", "typified": true, "cpf_match": true, "face_match": true, "validate_doc": true, "reused_doc": false, "signed_url": "https://example.com/doc?token=xyz", "doc": { "version": 1, "code": "CNH", "data": { "numero": "044589731564", "cpfNumero": "12345678909", "nomeCivil": "Luke Skywalker", "dataNascimento": "1990-05-12T00:00:00Z", "dataExpiracao": "2027-12-07T00:00:00Z", "categoria": "B" } } } ] } ] }} ``` الحقول ذات المستوى الأعلىالحقلالنوعالوصف`process.id`string (UUID)معرّف العملية.`process.flow`stringمعرّف التدفق المرسَل عند الإنشاء.`process.callbackUri`stringعنوان URL لإعادة الاتصال المهيّأ لأحداث العملية.`process.​userRedirectUrl`stringعنوان URL لإعادة توجيه المستخدم بعد اكتمال الرحلة.`process.state`enumحالة العملية الحالية. راجع القيم أدناه.`process.result`enumنتيجة التحقق. موجودة فقط عندما تكون `state = PROCESS_STATE_FINISHED`.`process.createdAt`string (datetime)طابع زمني بصيغة ISO 8601 لوقت إنشاء العملية.`process.finishedAt`string (datetime)طابع زمني بصيغة ISO 8601 لوقت اكتمال العملية. موجود فقط عندما تكون `state = PROCESS_STATE_FINISHED`.`process.expiresAt`string (datetime)طابع زمني بصيغة ISO 8601 لوقت انتهاء صلاحية العملية.`process.purpose`stringالغرض من العملية كما تم تهيئته في التدفق.`process.​clientReference`stringمرجع اختياري من جانب العميل للفهرسة في البوابة.`process.useCase`stringمعرّف السيناريو المرتبط بالتدفق.`process.capacities`array of stringsقائمة الإمكانيات المفعّلة في هذه العملية.`process.token`stringJWT موقّع لتكامل SDK.`process.person`objectبيانات التعريف المقدَّمة عند الإنشاء.`process.​person.​notifications`arrayقنوات الإشعارات المهيّأة للرحلة (مثل `email`).`process.​authenticationInfo`objectالنتائج لكل إمكانية. راجع أدناه.`process.companyData`objectسياق الشركة والفرع.`process.​companyData.​branchId`stringمعرّف الفرع.`process.​companyData.​countryCode`stringرمز الدولة ISO 3166-1 alpha-2.`process.​bioTokenData`objectمعلومات العملية المرجعية — موجودة فقط في تدفقات التحقق 1:1 وإعادة التحقق الذكية.`process.services`arrayالمغلّفات الموقَّعة، الوثائق المُلتقَطة، ومخرجات الخدمة الأخرى. راجع أدناه.قيم process.stateالقيمةالمعنى`PROCESS_STATE_CREATED`تم إنشاء العملية؛ لم يكمل المستخدم الرحلة بعد.`AWAITING_FOR_DOCUMENT`تم إنشاء العملية بدون وثيقة تعريف. موجودة فقط عندما يسمح Custom Flow بوثيقة اختيارية. أرسل الوثيقة باستخدام [تعيين وثيقة العملية](/ar/developers/api-reference/set-process-document).`PROCESS_STATE_FINISHED`اكتملت الرحلة. تحقق من `result` و`authenticationInfo`.`PROCESS_STATE_FAILED`خطأ في المعالجة.عدم اتساق في تسمية الحالةلا تتبع `AWAITING_FOR_DOCUMENT` اصطلاح البادئة `PROCESS_STATE_*` المستخدَم في الحالات الأخرى. هذا عدم اتساق معروف في تسمية API الحالية.قيم process.resultالقيمةالمعنى`PROCESS_RESULT_OK`أعادت جميع الإمكانيات نتائج إيجابية.`PROCESS_RESULT_INVALID_IDENTITY`أعادت إمكانية واحدة على الأقل نتيجة سلبية حاسمة (مثل فشل لايفنس، أو عدم تطابق الهوية).`PROCESS_RESULT_ERROR`خطأ خلال معالجة النتيجة.`PROCESS_RESULT_EXPIRED`انتهت صلاحية العملية قبل اكتمال الرحلة.`PROCESS_RESULT_UNSPECIFIED`لم تنتهِ العملية بعد.نتائج الإمكانيات في authenticationInfoيتم إعادة جميع الحقول دائمًا بغض النظر عن التدفق. تُعيد الحقول الخاصة بالإمكانيات غير المستخدَمة في التدفق القيمة `*_UNSPECIFIED`.قيم تعداد مختصرةالقيم المختصرة (مثل `livenessResult = LIVE`، `authenticationResult = INCONCLUSIVE`) تُطابق مباشرة القيم الكاملة للتعداد الموثّقة هنا (`LIVENESS_RESULT_LIVE`، `AUTHENTICATION_RESULT_INCONCLUSIVE`، إلخ) — تم حذف البادئة لأجل الاختصار.الحقلالإمكانيةالقيم الممكنة`authenticationId`—معرّف فريد لمحاولة المصادقة هذه.`livenessResult`[لايفنس](/ar/capabilities/liveness)`LIVENESS_RESULT_LIVE`، `LIVENESS_RESULT_NOT_LIVE`، `LIVENESS_RESULT_UNSPECIFIED``authenticationResult`[التحقق من الهوية](/ar/capabilities/identity-verification)`AUTHENTICATION_RESULT_POSITIVE`، `AUTHENTICATION_RESULT_NEGATIVE`، `AUTHENTICATION_RESULT_INCONCLUSIVE`، `AUTHENTICATION_RESULT_UNSPECIFIED``identityFraudstersResult`[تصنيف مخاطر الاحتيال](/ar/capabilities/fraud-risk-classification)`TRUST_RESULT_YES`، `TRUST_RESULT_INCONCLUSIVE`، `TRUST_RESULT_UNSPECIFIED``bioTokenEngineResult`[التحقق 1:1](/ar/capabilities/1-1-validation)`BIO_TOKEN_ENGINE_RESULT_POSITIVE`، `BIO_TOKEN_ENGINE_RESULT_NEGATIVE`، `BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED``smartRevalidationResult`[إعادة التحقق الذكية](/ar/capabilities/smart-revalidation)`SMART_REVALIDATION_RESULT_POSITIVE`، `SMART_REVALIDATION_RESULT_NEGATIVE`، `SMART_REVALIDATION_RESULT_UNSPECIFIED``idAgeResult`[التحقق من العمر](/ar/capabilities/age-verification)`ID_AGE_RESULT_POSITIVE`، `ID_AGE_RESULT_NEGATIVE`، `ID_AGE_RESULT_INCONCLUSIVE`، `ID_AGE_RESULT_UNSPECIFIED``scoreEngineResult.​scoreEnabled`[درجة المخاطر](/ar/capabilities/risk-score)`SCORE_ENABLED_TRUE`، `SCORE_ENABLED_FALSE`، `SCORE_ENABLED_UNSPECIFIED``scoreEngineResult.​score`[درجة المخاطر](/ar/capabilities/risk-score)رقم من -100 إلى +100. موجود عندما تكون `authenticationResult = AUTHENTICATION_RESULT_INCONCLUSIVE` ودرجة المخاطر مفعّلة.`serproResult.score`[تشابه Serpro](/ar/capabilities/serpro-similarity-return)`0`–`100` (التشابه)؛ `-1` (لا وجه مسجَّل لهذا CPF)؛ `-2` (خطأ في التكامل).حقول process.servicesاصطلاحات تسمية مختلطة في `services`تستخدم مصفوفة `services` camelCase للحقول على مستوى المغلّف (`envelopeId`، `documentIds`) وsnake_case للحقول على مستوى الوثيقة (`doc_id`، `consent_granted`، `face_match`، إلخ). هذا يعكس استجابة API الفعلية — كلا الاصطلاحين مقصودان ولا يُعدّان خطأً في التوثيق.الحقلالنوعالوصف`envelopeId`string (UUID)معرّف المغلّف الموقّع.`documentIds`array of stringsمعرّفات الوثائق المُلتقَطة في هذه الخدمة.`consent_granted`booleanما إذا وافق المستخدم على مشاركة البيانات.`documents`arrayالوثائق المُلتقَطة مع بيانات OCR ونتائج التحقق.`documents[].doc_id`stringمعرّف الوثيقة.`documents[].​typified`booleanما إذا تم تحديد نوع الوثيقة بنجاح.`documents[].​cpf_match`booleanما إذا كان رقم CPF في الوثيقة يطابق CPF المقدَّم (البرازيل فقط).`documents[].​face_match`booleanما إذا كانت الصورة الشخصية تطابق الصورة في الوثيقة.`documents[].​validate_doc`booleanما إذا نجحت الوثيقة في التحقق من أصالتها.`documents[].​reused_doc`booleanما إذا تمت إعادة استخدام هذه الوثيقة من عملية سابقة.`documents[].​signed_url`stringعنوان URL موقَّع مسبقًا لتنزيل ملف PDF للوثيقة (صالح لمدة 5 دقائق — أعد الجلب لتجديده).`documents[].​doc.​version`integerإصدار مخطط OCR.`documents[].​doc.​code`stringرمز مختصر لنوع الوثيقة (مثل `CNH`). راجع [أنواع الوثائق وحقول OCR](#document-type-values) لجميع القيم وكيفية استخلاص الرمز.`documents[].​doc.​data`objectحقول OCR المُستخرَجة. يختلف المحتوى بحسب نوع الوثيقة — راجع [مرجع الحقول الكامل](/ar/assets/files/document-content-fields-0e4663f2ade946e901bbc7523c21f032.json) للحصول على الكتالوج الكامل. أسماء الحقول داخل `doc.data` (مثل `nomeCivil`، `dataNascimento`) تُعاد بالبرتغالية — هذه هي القيم الفعلية التي يُنتجها محرك OCR. ### رموز الأخطاء​ 400 Bad Request401 Unauthorized404 Not Found429 Too Many Requests500 Internal Server Errorالرمزالرسالةالوصف`3`process id is invalidعندما يكون معرّف العملية غير صالح.الرمزالرسالةالوصف—Jwt header is an invalid JSONعندما يحتوي رمز الوصول المستخدَم على أحرف غير صحيحة.—Jwt is expiredعندما تنتهي صلاحية رمز الوصول المستخدَم.الرمزالرسالةالوصف`5`error getting process: rpc error: code = NotFound desc = process not foundعندما لا يتم العثور على معرّف العملية.تم الوصول إلى حد المعدل. عندما يتلقى نظامك خطأ HTTP 429، يجب عليك تطبيق آليات لمنع حالات الفشل المتتالية وتجنب تفاقم القيود. **أفضل الممارسات:** **فترة التهدئة (backoff):** أوقف أو قلل الطلبات اللاحقة من نظامك فورًا. لا تعد محاولة الطلبات الفاشلة باستمرار في حلقة متكررة سريعة. **الطابور والتحكم بمعدل الإرسال (Queueing & throttling):** قم بتخزين الطلبات الصادرة مؤقتًا أو وضعها في طابور من جانبك للتحكم في تدفق حركة المرور قبل إعادة إرسالها. **التراجع الأسي مع التذبذب العشوائي (Exponential backoff with jitter):** عند إعادة المحاولة، قم بزيادة وقت الانتظار بشكل أسي بين المحاولات (مثال: 1 ثانية، 2 ثانية، 4 ثوانٍ، 8 ثوانٍ) وأضف تأخيرًا عشوائيًا صغيرًا ("jitter") لمنع تأثير القطيع حيث تعيد جميع الطلبات المنتظرة المحاولة في نفس الميلي ثانية بالضبط. تحذيرالاستمرار في إرسال الطلبات إلى نقطة نهاية محدودة المعدل دون تراجع يمكن أن **يُطيل فترة التقييد** ويؤثر بشكل كبير على معدل النقل التشغيلي لنظامك. التحكم السليم في معدل الطلبات من جانبك يضمن تكاملاً أكثر سلاسة ومرونة. للاطلاع على الحدود الافتراضية وزيادة الطلبات والتفاصيل الإضافية، راجع [حدود المعدل](/ar/developers/start/rate-limits).الرمزالرسالةالوصف`99999`Internal failure! Try again laterعندما يحدث خطأ داخلي. ### الاستقصاء (Polling) مقابل webhook​ يمكنك استقصاء (poll) هذه النقطة النهائية للتحقق من التقدّم، ولكن النمط الموصى به هو **الاشتراك في webhook** واستخدام هذه النقطة النهائية فقط كخطة احتياطية. راجع [Webhooks and Events](/ar/developers/webhooks-and-events). ### الخطوات التالية​ للحصول على الصورة الشخصية المُلتقَطة، راجع [الحصول على الصورة الشخصية](/ar/developers/api-reference/get-selfie). للحصول على حزمة تدقيق الأدلة، راجع [الحصول على مجموعة الأدلة](/ar/developers/api-reference/get-evidence-set). آخر تحديث في 8 أكتوبر 2026**