تعيين وثيقة العمليةPOST
أنشئ عملية بدون وثيقة، ودع المستخدم يُكمل الالتقاط، ثم أرسل الوثيقة من الواجهة الخلفية (back-end) الخاصة بك. تُستأنف العملية بعد ذلك.
دورة الحياة
- الواجهة الخلفية (back-end) الخاصة بك تُنشئ العملية باستخدام إنشاء عملية، بدون
person.duiTypeوperson.duiValue. يجب أن يسمح التدفق بوثيقة اختيارية. تبدأ العملية بالحالةPROCESS_STATE_CREATED. - المستخدم يُجري الرحلة ويُنفّذ الالتقاط.
- Unico API تنقل العملية إلى
PROCESS_STATE_AWAITING_FOR_DOCUMENT، وهي الحالة التي تُعيدها الحصول على العملية بينما تنتظر العملية الوثيقة. يمكنك بالفعل قراءة النتائج الجزئية للإمكانيات التي لا تعتمد علىduiValue. - الواجهة الخلفية (back-end) الخاصة بك تستدعي هذه النقطة النهائية مع معرّف العملية في عنوان URL والوثيقة في متن الطلب. تعود العملية إلى
PROCESS_STATE_CREATEDوتُستأنف: تُنفَّذ الإمكانيات التي تعتمد على الوثيقة، وتنتقل العملية إلىPROCESS_STATE_FINISHEDعند اكتمالها.
الاستجابة لا تحمل النتيجة النهائية
اقرأ الحالة والنتيجة النهائيتين باستخدام الحصول على العملية، أو انتظر webhook.
النقطة النهائية
| البيئة | الرابط |
|---|---|
| الإنتاج | POST https://api.idcloud.unico.app/client/v1/process/{processId}/document |
| Sandbox | POST https://api.idcloud.uat.unico.app/client/v1/process/{processId}/document |
الطلب
Headers
| Header | القيمة |
|---|---|
Authorization | Bearer <access_token> (راجع المصادقة) |
Content-Type | application/json |
تحتاج بيانات الاعتماد إلى الصلاحية نفسها المستخدَمة لاستدعاء إنشاء عملية.
معاملات المسار
| المعامل | النوع | مطلوب | الوصف |
|---|---|---|---|
processId | string (UUID) | نعم | معرّف العملية الذي أعادته إنشاء عملية. |
معاملات المتن
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
duiType | enum | نعم | نوع الوثيقة. تُرفض القيمة DUI_TYPE_UNSPECIFIED. راجع قيم duiType أدناه. |
duiValue | string | نعم | رقم الوثيقة، بدون تنسيق. حتى 320 حرفًا. |
قيم duiType
| الدولة | القيمة | الوصف |
|---|---|---|
| AR | DUI_TYPE_AR_PASSPORT | جواز سفر أرجنتيني |
| AR | DUI_TYPE_AR_DNI | DNI الأرجنتيني |
| AR | DUI_TYPE_AR_LNC | رخصة القيادة الأرجنتينية (Licencia Nacional de Conducir) |
| AT | DUI_TYPE_AT_STNR | الرقم الضريبي النمساوي (STNR) |
| BE | DUI_TYPE_BE_NN | الرقم الوطني البلجيكي (NN) |
| BR | DUI_TYPE_BR_CPF | CPF البرازيلي |
| BR | DUI_TYPE_BR_PASSPORT | جواز سفر برازيلي |
| BR | DUI_TYPE_BR_CNPJ | CNPJ البرازيلي |
| CA | DUI_TYPE_CA_SIN | SIN الكندي |
| CH | DUI_TYPE_CH_AHV | رقم AHV/AVS السويسري |
| CL | DUI_TYPE_CL_RUN | RUN التشيلي |
| CL | DUI_TYPE_CL_PASSPORT | جواز سفر تشيلي |
| CL | DUI_TYPE_CL_LICENCIA_CONDUCIR | رخصة القيادة التشيلية (Licencia de Conducir) |
| CO | DUI_TYPE_CO_NIT | NIT الكولومبي |
| CO | DUI_TYPE_CO_PASSPORT | جواز سفر كولومبي |
| CO | DUI_TYPE_CO_LICENCIA_CONDUCCION | رخصة القيادة الكولومبية (Licencia de Conducción) |
| CO | DUI_TYPE_CO_CC | بطاقة المواطنة الكولومبية (Cédula de Ciudadanía) |
| DE | DUI_TYPE_DE_IDNR | رقم التعريف الضريبي الألماني (IdNr) |
| DK | DUI_TYPE_DK_CPR | CPR الدنماركي |
| EC | DUI_TYPE_EC_NI | NI الإكوادوري |
| ES | DUI_TYPE_ES_NIE | رقم هوية الأجانب الإسباني (NIE) |
| ES | DUI_TYPE_ES_DNI | وثيقة الهوية الوطنية الإسبانية (DNI) |
| FI | DUI_TYPE_FI_HETU | رمز الهوية الشخصية الفنلندي (HETU) |
| FR | DUI_TYPE_FR_SPI | الرقم الضريبي المرجعي الفرنسي (SPI) |
| GB | DUI_TYPE_GB_NINO | رقم التأمين الوطني البريطاني (NINO) |
| GT | DUI_TYPE_GT_CUI | CUI الغواتيمالي |
| ID | DUI_TYPE_ID_NIK | NIK الإندونيسي |
| IE | DUI_TYPE_IE_PPSN | رقم الخدمة العامة الشخصي الأيرلندي (PPSN) |
| IT | DUI_TYPE_IT_CF | Codice Fiscale الإيطالي (CF) |
| LK | DUI_TYPE_LK_NIC | NIC سريلانكي |
| LU | DUI_TYPE_LU_MATRICULE | رقم الهوية الوطني اللوكسمبورغي (Matricule) |
| MX | DUI_TYPE_MX_CURP | CURP المكسيكي |
| MX | DUI_TYPE_MX_RFC_PERSONA_FISICA | RFC المكسيكي (شخص طبيعي) |
| MX | DUI_TYPE_MX_LICENCIA_CONDUCIR | رخصة القيادة المكسيكية (Licencia de Conducir) |
| NG | DUI_TYPE_NG_NIN | NIN النيجيري |
| NG | DUI_TYPE_NG_BVN | رقم التحقق المصرفي النيجيري (BVN) |
| NG | DUI_TYPE_NG_BVN_TOKEN | رمز BVN النيجيري (مُجزّأ) |
| NG | DUI_TYPE_NG_NIN_TOKEN | رمز NIN النيجيري (مُجزّأ) |
| NL | DUI_TYPE_NL_BSN | رقم خدمة المواطن الهولندي (BSN) |
| NO | DUI_TYPE_NO_FNR | رقم الهوية الوطني النرويجي (Fødselsnummer) |
| PE | DUI_TYPE_PE_RUC | RUC البيروفي |
| PE | DUI_TYPE_PE_DNI | DNI البيروفي |
| PE | DUI_TYPE_PE_PASSPORT | جواز سفر بيروفي |
| PL | DUI_TYPE_PL_PESEL | PESEL البولندي |
| PT | DUI_TYPE_PT_NIF | رقم التعريف الضريبي البرتغالي (NIF) |
| SE | DUI_TYPE_SE_PNR | الرقم الشخصي السويدي (PNR) |
| SE | DUI_TYPE_SE_SAMORDNINGSNUMMER | الرقم التنسيقي السويدي (Samordningsnummer) |
| TR | DUI_TYPE_TR_TCKN | رقم الهوية التركي (TCKN) |
| US | DUI_TYPE_US_SSN | SSN الأمريكي |
| US | DUI_TYPE_US_PASSPORT | جواز سفر أمريكي |
| US | DUI_TYPE_US_DRIVER_LICENSE | رخصة قيادة أمريكية |
| US | DUI_TYPE_US_PASSPORT_CARD | بطاقة جواز سفر أمريكية |
| US | DUI_TYPE_US_POLYCARBONATE_PASSPORT | جواز سفر أمريكي مصنوع من البولي كاربونات |
| US | DUI_TYPE_US_ID_CARD | بطاقة هوية أمريكية |
| UY | DUI_TYPE_UY_CI | CI الأوروغوياني |
| ZZ | DUI_TYPE_ZZ_EMAIL | عنوان البريد الإلكتروني |
| ZZ | DUI_TYPE_ZZ_PHONE_NUMBER | رقم الهاتف |
متى يُقبل الاستدعاء
- العملية في الحالة
PROCESS_STATE_AWAITING_FOR_DOCUMENT: أكمل المستخدم الالتقاط بالفعل.