Lewati ke konten utama
Tetapkan Dokumen ProsesPOST

Buat proses tanpa dokumen, biarkan pengguna menyelesaikan pengambilan gambar, lalu kirim dokumen dari back-end Anda. Setelah itu, proses selesai.

MarkdownChatGPTClaude

Siklus hidup​

  1. Back-end Anda membuat proses dengan Buat Proses, tanpa person.duiType dan person.duiValue. Flow harus mengizinkan dokumen opsional. Proses dimulai dengan state PROCESS_STATE_CREATED.
  2. Pengguna menjalankan perjalanan dan melakukan pengambilan gambar.
  3. Unico API memindahkan proses ke AWAITING_FOR_DOCUMENT, yaitu state yang dikembalikan oleh Dapatkan Proses selama proses menunggu dokumen. Anda sudah dapat membaca hasil parsial dari kapabilitas yang tidak bergantung pada duiValue.
  4. Back-end Anda memanggil endpoint ini dengan ID proses di URL dan dokumen di body. Unico API kemudian menyelesaikan proses, dan proses berpindah ke PROCESS_STATE_FINISHED.
Respons tidak memuat hasil akhir

Baca state akhir dan hasilnya dengan Dapatkan Proses, atau tunggu webhook.

Endpoint​

LingkunganURL
ProduksiPOST https://api.idcloud.unico.app/client/v1/process/{processId}/document
SandboxPOST https://api.idcloud.uat.unico.app/client/v1/process/{processId}/document

Permintaan​

Headers
HeaderNilai
AuthorizationBearer <access_token> (lihat Autentikasi)
Content-Typeapplication/json

Kredensial memerlukan izin yang sama dengan yang digunakan untuk memanggil Buat Proses.

Parameter path
ParameterTipeWajibDeskripsi
processIdstring (UUID)yaIdentifier proses yang dikembalikan oleh Buat Proses.
Parameter body
FieldTipeWajibDeskripsi
duiTypeenumyaTipe dokumen. DUI_TYPE_UNSPECIFIED ditolak. Lihat nilai duiType di bawah.
duiValuestringyaNomor dokumen, tanpa format. Maksimal 320 karakter.
Nilai duiType
NegaraNilaiDeskripsi
ARDUI_TYPE_AR_PASSPORTPaspor Argentina
ARDUI_TYPE_AR_DNIDNI Argentina
ARDUI_TYPE_AR_LNCSIM Argentina (Licencia Nacional de Conducir)
ATDUI_TYPE_AT_STNRNomor Pajak Austria (STNR)
BEDUI_TYPE_BE_NNNomor Nasional Belgia (NN)
BRDUI_TYPE_BR_CPFCPF Brasil
BRDUI_TYPE_BR_PASSPORTPaspor Brasil
BRDUI_TYPE_BR_CNPJCNPJ Brasil
CADUI_TYPE_CA_SINSIN Kanada
CHDUI_TYPE_CH_AHVNomor AHV/AVS Swiss
CLDUI_TYPE_CL_RUNRUN Chili
CLDUI_TYPE_CL_PASSPORTPaspor Chili
CLDUI_TYPE_CL_LICENCIA_CONDUCIRSIM Chili (Licencia de Conducir)
CODUI_TYPE_CO_NITNIT Kolombia
CODUI_TYPE_CO_PASSPORTPaspor Kolombia
CODUI_TYPE_CO_LICENCIA_CONDUCCIONSIM Kolombia (Licencia de Conducción)
CODUI_TYPE_CO_CCKartu Kewarganegaraan Kolombia (Cédula de Ciudadanía)
DEDUI_TYPE_DE_IDNRNomor Identifikasi Pajak Jerman (IdNr)
DKDUI_TYPE_DK_CPRCPR Denmark
ECDUI_TYPE_EC_NINI Ekuador
ESDUI_TYPE_ES_NIENomor Identitas Warga Asing Spanyol (NIE)
ESDUI_TYPE_ES_DNIDokumen Identitas Nasional Spanyol (DNI)
FIDUI_TYPE_FI_HETUKode Identitas Pribadi Finlandia (HETU)
FRDUI_TYPE_FR_SPINomor Referensi Pajak Prancis (SPI)
GBDUI_TYPE_GB_NINONomor Asuransi Nasional Inggris (NINO)
GTDUI_TYPE_GT_CUICUI Guatemala
IDDUI_TYPE_ID_NIKNIK Indonesia
IEDUI_TYPE_IE_PPSNNomor Layanan Publik Pribadi Irlandia (PPSN)
ITDUI_TYPE_IT_CFCodice Fiscale Italia (CF)
LKDUI_TYPE_LK_NICNIC Sri Lanka
LUDUI_TYPE_LU_MATRICULENomor Identifikasi Nasional Luksemburg (Matricule)
MXDUI_TYPE_MX_CURPCURP Meksiko
MXDUI_TYPE_MX_RFC_PERSONA_FISICARFC Meksiko (Perorangan)
MXDUI_TYPE_MX_LICENCIA_CONDUCIRSIM Meksiko (Licencia de Conducir)
NGDUI_TYPE_NG_NINNIN Nigeria
NGDUI_TYPE_NG_BVNNomor Verifikasi Bank Nigeria (BVN)
NGDUI_TYPE_NG_BVN_TOKENToken BVN Nigeria (hash)
NGDUI_TYPE_NG_NIN_TOKENToken NIN Nigeria (hash)
NLDUI_TYPE_NL_BSNNomor Layanan Warga Negara Belanda (BSN)
NODUI_TYPE_NO_FNRNomor Identitas Nasional Norwegia (Fødselsnummer)
PEDUI_TYPE_PE_RUCRUC Peru
PEDUI_TYPE_PE_DNIDNI Peru
PEDUI_TYPE_PE_PASSPORTPaspor Peru
PLDUI_TYPE_PL_PESELPESEL Polandia
PTDUI_TYPE_PT_NIFNomor Identifikasi Pajak Portugal (NIF)
SEDUI_TYPE_SE_PNRNomor Pribadi Swedia (PNR)
SEDUI_TYPE_SE_SAMORDNINGSNUMMERNomor Koordinasi Swedia (Samordningsnummer)
TRDUI_TYPE_TR_TCKNNomor Identifikasi Turki (TCKN)
USDUI_TYPE_US_SSNSSN Amerika Serikat
USDUI_TYPE_US_PASSPORTPaspor Amerika Serikat
USDUI_TYPE_US_DRIVER_LICENSESIM Amerika Serikat
USDUI_TYPE_US_PASSPORT_CARDKartu Paspor Amerika Serikat
USDUI_TYPE_US_POLYCARBONATE_PASSPORTPaspor Polikarbonat Amerika Serikat
USDUI_TYPE_US_ID_CARDKartu Identitas Amerika Serikat
UYDUI_TYPE_UY_CICI Uruguay
ZZDUI_TYPE_ZZ_EMAILAlamat email
ZZDUI_TYPE_ZZ_PHONE_NUMBERNomor telepon
Kapan panggilan diterima
  • Proses berada dalam state AWAITING_FOR_DOCUMENT: pengguna sudah menyelesaikan pengambilan gambar.
  • Proses belum kedaluwarsa.
  • Flow mengizinkan dokumen opsional.

Dokumen bersifat tidak dapat diubah. Panggilan kedua akan gagal, karena proses tidak lagi menunggu dokumen.

Contoh​

curl -X POST https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID/document \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678909"
}'

Respons​

200 OK
{
"processId": "3116552c-6a3e-4c1f-9d2b-8f0e7a5b4c21",
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678909"
}
FieldTipeDeskripsi
processIdstring (UUID)Identifier proses.
duiTypeenumTipe dokumen yang terdaftar untuk proses.
duiValuestringNomor dokumen yang terdaftar untuk proses.

Nilai pada contoh hanyalah placeholder.

Kode Error​

KodeDeskripsi
3processId tidak ada atau tidak valid, duiType tidak ditentukan, atau duiValue kosong atau lebih dari 320 karakter.
9Proses tidak sedang menunggu dokumen (termasuk jika dokumen sudah ditetapkan), sudah kedaluwarsa atau selesai, atau flow tidak mengizinkan dokumen opsional.
catatan

Dokumen didaftarkan ke layanan identitas sebelum disimpan. Jika pendaftaran tersebut gagal, panggilan akan mengembalikan status dari kegagalan tersebut.

Selanjutnya​