Lewati ke konten utama
Dapatkan ProsesGET

Mengambil proses yang sudah ada berdasarkan identifier-nya. Berdasarkan kontrak API, hasilnya sudah dikembalikan secara sinkron saat pembuatan proses — gunakan endpoint ini untuk kueri ulang, audit, dan dukungan.

Markdown
peringatan

Sebelum mengambil proses, tinjau konfigurasi webhook dan strategi fallback kami — klik di sini.

Endpoint​

LingkunganURL
ProduksiGET https://api.idcloud.unico.app/client/v1/process/{processId}
SandboxGET https://api.idcloud.uat.unico.app/client/v1/process/{processId}

Permintaan​

Headers
HeaderNilai
AuthorizationBearer <access_token>
Parameter path
ParameterTipeWajibDeskripsi
processIdstring (UUID)yaIdentifier proses yang dikembalikan oleh Buat Proses.

Contoh​

curl -X GET https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID \
-H "Authorization: Bearer $TOKEN"

Respons​

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
}
}
Field proses
FieldArti
idUUID proses; kunci yang digunakan untuk mengueri dan melacak flow.
flowJenis perjalanan yang dijalankan (misalnya id_r2, idlivetrust_r2, idtrust_r2, ...).
callbackUriCallback URI tempat aplikasi klien diarahkan pada akhir flow.
userRedirectUrlURL lengkap dari halaman CbU yang dibuka pengguna untuk menjalankan perjalanan (membawa id dan flag perilaku).
stateState siklus hidup proses (misalnya PROCESS_STATE_CREATED, PROCESS_STATE_FAILED, PROCESS_STATE_FINISHED, PROCESS_STATE_AWAITING_FOR_DOCUMENT, PROCESS_STATE_UNSPECIFIED).
resultVerdict akhir dari evaluasi. Nilai PROCESS_RESULT_* (misalnya APPROVED, AUTHENTICATED, NOT_APPROVED, ...). Hanya konklusif saat state = PROCESS_STATE_FINISHED.
createdAtTimestamp pembuatan proses (UTC).
finishedAtTimestamp penyelesaian proses (UTC).
personSub-objek dengan data orang yang diverifikasi.
purposeTujuan proses (misalnya personAuthentication, registrasi orang).
servicesDaftar layanan tambahan yang terlampir pada proses; kosong jika tidak ada.
authenticationInfo.​authenticationIdID dari event autentikasi identitas yang dihasilkan oleh flow.
capacitiesKapabilitas/produk yang digunakan. Nilai PROCESS_CAPACITY_* (misalnya IDCLOUDONE).
expiresAtTimestamp kedaluwarsa proses/link (UTC).
tokenToken sesi/akses yang terkait dengan proses (dapat kosong).
companyDataSub-objek dengan data perusahaan/tenant yang memiliki proses.
simulatedBoolean; apakah ini adalah proses simulasi/sandbox (true) atau proses sungguhan (false).
Field person
FieldArti
duiTypeTipe dokumen identifikasi unik. Nilai DUI_TYPE_* (misalnya BR_CPF).
duiValueNilai dokumen (misalnya nomor CPF).
friendlyNameNama panggilan/nickname untuk orang tersebut (teks bebas, tidak divalidasi).
emailEmail orang tersebut; dapat kosong.
phoneNomor telepon dalam format E.164 (kode negara + kode area + nomor).
notificationsDaftar kanal notifikasi. Setiap item membawa notificationChannel dengan nilai NOTIFICATION_CHANNEL_* (misalnya WHATSAPP, SMS, EMAIL).
phoneCountryCodeAlpha3Kode negara ISO alpha-3 dari nomor telepon (misalnya BRA); dapat kosong.
Field companyData
FieldArti
branchIdIdentifier cabang tenant; kosong jika tidak disegmentasi berdasarkan cabang.
countryCodeNegara perusahaan dalam ISO alpha-3 (misalnya BRA).
Tipe dokumen dan field OCR

process.services[].documents[].doc.code melaporkan tipe dokumen dalam salah satu dari dua bentuk. Dokumen yang diproses oleh modul dokumen Unico, termasuk dokumen yang digunakan kembali, membawa kode singkat huruf besar (CNH). Proses yang dibuat hanya melalui API biasanya membawa tipe dictionary lengkap (unico.moja.dictionary.br.cnh.v2.Cnh), tetapi juga dapat membawa kode singkat. Tangani kedua bentuk di setiap jalur integrasi. Kode singkat tersebut tidak membawa negara maupun versi skema; versinya dikembalikan secara terpisah di doc.version.

Dalam bentuk singkat, tipe dokumen yang menggunakan skema terpadu — unified_schema pada referensi field — dilaporkan sebagai tipe huruf besar yang diidentifikasi selama pengambilan gambar. Nilai yang paling umum adalah IDCARD, DRIVERLICENSE, PASSPORT, dan VOTERID, tetapi daftarnya terbuka: tipe lain yang diidentifikasi selama pengambilan gambar dikembalikan apa adanya, dalam huruf besar. Tangani nilai di luar daftar ini. Paspor A.S. mempertahankan variannya masing-masing dan tidak digabungkan menjadi PASSPORT: POLYCARBONATEPASSPORT, PASSPORTCARD, PAPERPASSPORT, CONSULARPASSPORT, ALIENPASSPORT, dan REFUGEEPASSPORT juga dikembalikan. Misalnya, unico.moja.dictionary.ar.generic.v1.IdCard dan unico.moja.dictionary.us.generic.v1.PolycarbonatePassport dilaporkan sebagai IDCARD dan POLYCARBONATEPASSPORT.

Skema khusus

Tipe dokumen yang menggunakan skema field sendiri — tercantum di bawah specific_document_schemas pada referensi field — ditunjukkan pada tabel di bawah ini. Gunakan tipe dictionary untuk mencari setiap skema pada file tersebut.

Negaradoc.codeTipe dictionaryDokumen
BRRGunico.​moja.​dictionary.​br.​rg.​v2.​RgRG
BRCNHunico.​moja.​dictionary.​br.​cnh.​v2.​CnhCNH (surat izin mengemudi)
BRCINunico.​moja.​dictionary.​br.​cin.​v1.​CinCIN
BRPASSAPORTEunico.​moja.​dictionary.​br.​passaporte.​v1.​PassaportePaspor
MXINEunico.​moja.​dictionary.​mx.​ine.​v1.​IneKredensial pemilih INE
MXLPCunico.​moja.​dictionary.​mx.​lpc.​v1.​LpcLicencia para conducir (surat izin mengemudi)
MXPASAPORTEunico.​moja.​dictionary.​mx.​pasaporte.​v1.​PasaportePaspor
—UNKNOWNunico.​moja.​dictionary.​other.​unknown.​v1.​UnknownTipe tidak dapat diidentifikasi, atau merupakan tipe Brasil atau Meksiko tanpa skema sendiri — doc.data kosong

Dokumen Brasil dan Meksiko hanya menggunakan skema khusus di atas. Dokumen Brasil atau Meksiko dengan tipe lain — misalnya, kartu penduduk tetap Meksiko — dilaporkan sebagai UNKNOWN, bukan dengan skema terpadu.

PASSAPORTE dan PASAPORTE adalah dokumen yang berbeda

Paspor Brasil adalah PASSAPORTE (S ganda) dan paspor Meksiko adalah PASAPORTE (S tunggal), masing-masing mencerminkan ejaan dictionary-nya sendiri. Ini bukan kesalahan penulisan — jangan menganggap kedua nilai tersebut setara.

Tidak ada ekstraksi OCR yang dilakukan dan tidak ada field yang dilaporkan di doc.data saat doc.code adalah UNKNOWN.

BrazilKlien di Brasil dapat menerima payload proses lengkap

Struktur respons secara keseluruhan tetap sama — hasil tunggal adalah default.

Integrasi di Brasil dapat menerima objek proses lengkap di bawah ini, dengan hasil per-kapabilitas di 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": "BRA"
},
"bioTokenData": {
"referenceProcessId": "ref-proc-123",
"authenticationId": "auth-ref-123"
},
"services": [
{
"consent_granted": true,
"documents": [
{
"doc_id": "doc-abc-123",
"share_id": "share-abc-123",
"typified": true,
"cpf_match": true,
"validate_doc": true,
"face_match": true,
"verified": true,
"reused_doc": false,
"signed_url": "https://example.com/doc?token=xyz",
"doc": {
"version": 2,
"code": "CNH",
"data": {
"numero": "044589731564",
"cpfNumero": "12345678909",
"nomeCivil": "Luke Skywalker",
"dataNascimento": "1990-05-12T00:00:00Z",
"dataExpiracao": "2027-12-07T00:00:00Z",
"categoria": "B"
}
}
}
]
}
]
}
}
Field tingkat atas
FieldTipeDeskripsi
process.idstring (UUID)Identifier proses.
process.flowstringIdentifier flow yang dikirim saat pembuatan.
process.callbackUristringCallback URL yang dikonfigurasi untuk event proses.
process.​userRedirectUrlstringURL untuk mengarahkan pengguna setelah perjalanan selesai.
process.stateenumState proses saat ini. Lihat nilai di bawah.
process.resultenumHasil verifikasi. Hanya ada saat state = PROCESS_STATE_FINISHED.
process.createdAtstring (datetime)Timestamp ISO 8601 saat proses dibuat.
process.finishedAtstring (datetime)Timestamp ISO 8601 saat proses selesai. Hanya ada saat state = PROCESS_STATE_FINISHED.
process.expiresAtstring (datetime)Timestamp ISO 8601 saat proses kedaluwarsa.
process.purposestringTujuan proses sebagaimana dikonfigurasi dalam flow.
process.​clientReferencestringReferensi opsional sisi klien untuk pengindeksan di portal.
process.useCasestringIdentifier skenario yang terkait dengan flow.
process.capacitiesarray of stringsDaftar kapabilitas yang diaktifkan dalam proses ini.
process.tokenstringJWT yang ditandatangani untuk integrasi SDK.
process.personobjectIdentifikasi yang disediakan saat pembuatan.
process.​person.​notificationsarrayKanal notifikasi yang dikonfigurasi untuk perjalanan (misalnya email).
process.​authenticationInfoobjectHasil per-kapabilitas. Lihat di bawah.
process.companyDataobjectKonteks perusahaan dan cabang.
process.​companyData.​branchIdstringIdentifier cabang.
process.​companyData.​countryCodestringKode negara ISO 3166-1 alpha-3 (misalnya BRA).
process.​bioTokenDataobjectInformasi proses referensi — hanya ada pada alur Validasi 1:1 dan Revalidasi Cerdas.
process.servicesarrayEnvelope yang ditandatangani, dokumen yang diambil, dan output layanan lainnya. Lihat di bawah.
Nilai process.state
ValueArti
PROCESS_STATE_CREATEDProses dibuat; pengguna belum menyelesaikan perjalanan.
PROCESS_STATE_AWAITING_FOR_DOCUMENTProses dibuat tanpa dokumen identifikasi. Hanya ada saat Custom Flow mengizinkan dokumen opsional. Kirim dokumen dengan Tetapkan Dokumen Proses.
PROCESS_STATE_FINISHEDPerjalanan selesai. Periksa result dan authenticationInfo.
PROCESS_STATE_FAILEDError pemrosesan.
Nilai process.result
ValueArti
PROCESS_RESULT_OKSemua kapabilitas mengembalikan hasil positif.
PROCESS_RESULT_INVALID_IDENTITYSetidaknya satu kapabilitas mengembalikan hasil negatif definitif (misalnya liveness gagal, identitas tidak cocok).
PROCESS_RESULT_ERRORError selama pemrosesan hasil.
PROCESS_RESULT_EXPIREDProses kedaluwarsa sebelum perjalanan selesai.
PROCESS_RESULT_UNSPECIFIEDProses belum selesai.
Hasil kapabilitas dalam authenticationInfo

Semua field selalu dikembalikan terlepas dari flow-nya. Field untuk kapabilitas yang tidak digunakan dalam flow mengembalikan *_UNSPECIFIED.

Nilai enum yang disingkat

Nilai singkat (misalnya livenessResult = LIVE, authenticationResult = INCONCLUSIVE) mengacu langsung ke nilai enum lengkap yang didokumentasikan di sini (LIVENESS_RESULT_LIVE, AUTHENTICATION_RESULT_INCONCLUSIVE, dst.) — prefiksnya dihilangkan demi keringkasan.

FieldKapabilitasNilai yang memungkinkan
authenticationId—Identifier unik untuk percobaan autentikasi ini.
livenessResultDeteksi KehidupanLIVENESS_RESULT_LIVE, LIVENESS_RESULT_NOT_LIVE, LIVENESS_RESULT_UNSPECIFIED
authenticationResultVerifikasi IdentitasAUTHENTICATION_RESULT_POSITIVE, AUTHENTICATION_RESULT_NEGATIVE, AUTHENTICATION_RESULT_INCONCLUSIVE, AUTHENTICATION_RESULT_UNSPECIFIED
identityFraudstersResultKlasifikasi Risiko PenipuanTRUST_RESULT_YES, TRUST_RESULT_INCONCLUSIVE, TRUST_RESULT_UNSPECIFIED
bioTokenEngineResultValidasi 1:1BIO_TOKEN_ENGINE_RESULT_POSITIVE, BIO_TOKEN_ENGINE_RESULT_NEGATIVE, BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED
smartRevalidationResultRevalidasi CerdasSMART_REVALIDATION_RESULT_POSITIVE, SMART_REVALIDATION_RESULT_NEGATIVE, SMART_REVALIDATION_RESULT_UNSPECIFIED
idAgeResultVerifikasi UsiaID_AGE_RESULT_POSITIVE, ID_AGE_RESULT_NEGATIVE, ID_AGE_RESULT_INCONCLUSIVE, ID_AGE_RESULT_UNSPECIFIED
scoreEngineResult.​scoreEnabledSkor RisikoSCORE_ENABLED_TRUE, SCORE_ENABLED_FALSE, SCORE_ENABLED_UNSPECIFIED
scoreEngineResult.​scoreSkor RisikoAngka dari -100 hingga +100. Ada saat authenticationResult = AUTHENTICATION_RESULT_INCONCLUSIVE dan Skor Risiko diaktifkan.
serproResult.scoreKemiripan Serpro0–100 (kemiripan); -1 (tidak ada wajah tersimpan untuk CPF ini); -2 (error integrasi).
deviceMetadataMetadata PerangkatObjek dengan status (found, not_found, unavailable) dan data perangkat. Tidak muncul jika kemampuan ini tidak diaktifkan dalam alur.
Field process.services
Satu item per modul

services berisi satu item per modul yang selesai dalam proses: eksekusi selesai terbaru dari setiap modul, dan hanya selama proses berstatus PROCESS_STATE_FINISHED atau PROCESS_STATE_AWAITING_FOR_DOCUMENT. Proses yang dibuat hanya melalui API membawa item dokumennya dalam status apa pun. Item pengambilan dokumen membawa documents dan consent_granted. Item tanda tangan elektronik membawa envelope_id dan document_ids. Item tidak memiliki field tipe dan urutannya tidak tetap: identifikasi setiap item berdasarkan key-nya, bukan posisinya, dan abaikan item yang tidak Anda kenali. Key menggunakan snake_case, kecuali key di dalam doc.data, yang mengikuti skema dokumen (misalnya nomeCivil).

FieldTipeDeskripsi
consent_grantedbooleanItem pengambilan dokumen. Apakah pengguna memberikan consent untuk membagikan dokumen kepada perusahaan Anda.
documentsarrayItem pengambilan dokumen. Dokumen yang diambil beserta data OCR dan hasil validasi.
documents[].doc_idstringIdentifier dokumen.
documents[].​share_idstringIdentifier pembagian yang diberikan pengguna kepada perusahaan Anda untuk proses ini.
documents[].​typifiedbooleanApakah tipe dokumen teridentifikasi.
documents[].​cpf_matchbooleanKhusus Brasil. Apakah CPF pada dokumen cocok dengan CPF yang dikirim saat pembuatan. Selalu ada untuk perusahaan yang negaranya ditetapkan sebagai Brasil; dihilangkan untuk negara lain dan untuk perusahaan tanpa negara yang ditetapkan.
documents[].​validate_docbooleanKhusus Brasil. Apakah dokumen lolos validasi dokumen Unico. Selalu ada untuk perusahaan yang negaranya ditetapkan sebagai Brasil (false ketika validasi tidak dijalankan); dihilangkan untuk negara lain dan untuk perusahaan tanpa negara yang ditetapkan.
documents[].​face_matchboolean or nullApakah selfie cocok dengan foto pada dokumen. null berarti pemeriksaan tidak dijalankan — ini bukan hasil negatif.
documents[].​verifiedboolean or nulltrue hanya ketika tipe dokumen diketahui, dokumen tidak dihapus, face_match bernilai true, dan dokumen lolos pemeriksaan kualitas. false jika tidak, termasuk ketika face_match tidak dijalankan. null ketika proses tidak melalui modul dokumen.
documents[].​reused_docbooleanApakah dokumen ini digunakan kembali dari proses sebelumnya.
documents[].​signed_urlstringURL bertanda tangan berumur pendek untuk mengunduh gambar dokumen. URL ini akan kedaluwarsa: jangan menyimpannya atau mengandalkan masa berlaku yang tetap, dan panggil endpoint ini lagi untuk mendapatkan URL baru.
documents[].​doc.​versionintegerVersi dictionary tipe dokumen (misalnya 2 untuk unico.moja.dictionary.br.cnh.v2.Cnh).
documents[].​doc.​codestringTipe dokumen, sebagai kode singkat (misalnya CNH) atau sebagai tipe dictionary lengkap (misalnya unico.moja.dictionary.br.cnh.v2.Cnh). Dokumen yang diproses oleh modul dokumen membawa kode singkat. Tangani keduanya. Lihat Tipe dokumen dan field OCR untuk semua nilai dan cara kode tersebut diperoleh.
documents[].​doc.​dataobjectField OCR yang diekstrak. Isinya bervariasi berdasarkan tipe dokumen — lihat referensi field lengkap untuk katalog lengkapnya. Nama field mengikuti skema dokumen: bahasa Portugis untuk dokumen Brasil (misalnya nomeCivil, dataNascimento), bahasa Spanyol untuk dokumen Meksiko, dan bahasa Inggris untuk skema terpadu.
envelope_idstring (UUID)Item tanda tangan elektronik. Identifier envelope yang ditandatangani.
document_idsarray of stringsItem tanda tangan elektronik. ID dokumen dalam envelope.
Proses yang dibuat hanya melalui API

Pada proses yang dibuat hanya melalui API, item dokumen berasal dari panggilan API, bukan dari modul dokumen Unico, dan beberapa nilai berbeda dari tabel di atas:

  • consent_granted selalu false: perusahaan Anda yang mengumpulkan consent, dan Unico tidak melacaknya.
  • share_id dan signed_url kosong.
  • face_match selalu true atau false, tidak pernah null.
  • verified selalu null.
  • doc.version adalah 0.
  • doc.code biasanya membawa tipe dictionary lengkap (misalnya unico.moja.dictionary.br.cnh.v2.Cnh), tetapi dapat membawa kode singkat.
  • doc.data bernilai null ketika data OCR tidak dapat dibaca.

Kode Error​

CodeMessageDescription
3process id is invalidKetika ID proses tidak valid.

Polling vs webhook​

Anda dapat melakukan polling pada endpoint ini untuk memeriksa progres, tetapi pola yang direkomendasikan adalah berlangganan webhook dan hanya memanggil endpoint ini sebagai fallback. Lihat Webhook dan Event.

Selanjutnya​