Lewati ke konten utama
Dapatkan ProsesGET

Ambil proses yang sudah ada berdasarkan identifier-nya. Sesuai kontrak API, hasil sudah dikembalikan secara sinkron saat proses dibuat — gunakan endpoint ini untuk kueri ulang, audit, dan dukungan.

peringatan

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

Endpoint​

LingkunganURL
ProductionGET 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 Create Process.

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; identifier yang digunakan untuk mencari dan melacak flow.
flowJenis journey yang dijalankan (misalnya id_r2, idlivetrust_r2, idtrust_r2, ...).
callbackUriURI callback tempat aplikasi klien diarahkan ulang pada akhir flow.
userRedirectUrlURL lengkap halaman CbU yang dibuka pengguna untuk menjalankan journey (membawa id dan flag perilaku).
stateStatus siklus hidup proses. Nilai PROCESS_STATE_* (misalnya CREATED, FAILED, FINISHED, AWAITING_FOR_DOCUMENT, UNSPECIFIED).
resultKeputusan akhir dari evaluasi. Nilai PROCESS_RESULT_* (misalnya APPROVED, AUTHENTICATED, NOT_APPROVED, ...). Hanya bersifat final ketika 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 terkait dengan proses; kosong jika tidak ada.
authenticationInfo.authenticationIdID 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 pemilik proses.
simulatedBoolean; menunjukkan apakah proses ini bersifat simulasi/sandbox (true) atau nyata (false).
Field person
FieldArti
duiTypeJenis dokumen identifikasi unik. Nilai DUI_TYPE_* (misalnya BR_CPF).
duiValueNilai dokumen (misalnya nomor CPF).
friendlyNameNama ramah/panggilan untuk orang tersebut (teks bebas, tidak divalidasi).
emailEmail orang tersebut; dapat kosong.
phoneNomor telepon dalam format E.164 (kode negara + kode area + nomor).
notificationsDaftar saluran 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 data perusahaan
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 sebagai kode singkat dalam huruf kapital. unico.moja.dictionary.br.cnh.v2.Cnh menjadi CNH. Kode ini tidak memuat negara maupun versi skema; versinya dikembalikan secara terpisah pada doc.version.

Tipe dokumen yang menggunakan skema terpadu — unified_schema dalam referensi field — dilaporkan sebagai tipe yang teridentifikasi saat pengambilan, dalam huruf kapital: IDCARD, DRIVERLICENSE, PASSPORT, atau VOTERID. Paspor Amerika Serikat mempertahankan variannya alih-alih digabungkan menjadi PASSPORT, sehingga nilai seperti POLYCARBONATEPASSPORT, PASSPORTCARD, dan PAPERPASSPORT juga dikembalikan. Sebagai contoh, unico.moja.dictionary.ar.generic.v1.IdCard dan unico.moja.dictionary.us.generic.v1.PolycarbonatePassport dilaporkan sebagai IDCARD dan POLYCARBONATEPASSPORT.

Skema spesifik

Tipe dokumen yang menggunakan skema field-nya sendiri — terdaftar di bawah specific_document_schemas dalam referensi field — ditampilkan 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 — doc.data kosong
PASSAPORTE dan PASAPORTE adalah dokumen yang berbeda

Paspor Brasil adalah PASSAPORTE (dua S) dan paspor Meksiko adalah PASAPORTE (satu S), masing-masing mengikuti ejaan pada dictionary-nya sendiri. Ini bukan salah ketik — jangan perlakukan kedua nilai tersebut sebagai setara.

Tidak ada ekstraksi OCR yang dilakukan dan tidak ada field yang dilaporkan pada doc.data ketika doc.code bernilai UNKNOWN.

BrazilKlien di Brasil dapat menerima payload proses lengkap

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

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": "idchecktrust",
    "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": "smart_revalidation",
    "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_INCONCLUSIVE",
      "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"
              }
            }
          }
        ]
      }
    ]
  }
}
Field tingkat atas
FieldTipeDeskripsi
process.idstring (UUID)Identifier proses.
process.flowstringIdentifier flow yang dikirim saat pembuatan.
process.callbackUristringURL callback yang dikonfigurasi untuk event proses.
process.userRedirectUrlstringURL untuk mengarahkan pengguna setelah journey selesai.
process.stateenumStatus proses saat ini. Lihat nilai di bawah.
process.resultenumHasil verifikasi. Muncul hanya ketika state = PROCESS_STATE_FINISHED.
process.createdAtstring (datetime)Timestamp ISO 8601 ketika proses dibuat.
process.finishedAtstring (datetime)Timestamp ISO 8601 ketika proses selesai. Muncul hanya ketika state = PROCESS_STATE_FINISHED.
process.expiresAtstring (datetime)Timestamp ISO 8601 ketika proses kedaluwarsa.
process.purposestringTujuan proses seperti yang dikonfigurasi dalam flow.
process.clientReferencestringReferensi sisi klien opsional 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 diberikan saat pembuatan.
process.person.notificationsarraySaluran notifikasi yang dikonfigurasi untuk journey (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-2.
process.bioTokenDataobjectInfo proses referensi — muncul hanya dalam alur Validasi 1:1 dan Revalidasi Cerdas.
process.servicesarrayEnvelope yang ditandatangani, dokumen yang ditangkap, dan output layanan lainnya. Lihat di bawah.
Nilai process.state
NilaiArti
PROCESS_STATE_CREATEDProses dibuat; pengguna belum menyelesaikan journey.
AWAITING_FOR_DOCUMENTProses dibuat tanpa dokumen identifikasi; menunggu untuk diatur melalui Set Process Document. Hanya muncul ketika Custom Flow mengizinkan dokumen opsional.
PROCESS_STATE_FINISHEDJourney selesai. Periksa result dan authenticationInfo.
PROCESS_STATE_FAILEDError pemrosesan.
Inkonsistensi penamaan state

AWAITING_FOR_DOCUMENT tidak mengikuti konvensi prefiks PROCESS_STATE_* yang digunakan oleh state lainnya. Ini adalah inkonsistensi penamaan yang diketahui dalam API saat ini.

Nilai process.result
NilaiArti
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 journey selesai.
PROCESS_RESULT_UNSPECIFIEDProses belum selesai.
Hasil kapabilitas dalam authenticationInfo

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

Nilai enum yang disingkat

Nilai singkat (misalnya livenessResult = LIVE, authenticationResult = INCONCLUSIVE) dipetakan langsung ke nilai enum lengkap yang didokumentasikan di sini (LIVENESS_RESULT_LIVE, AUTHENTICATION_RESULT_INCONCLUSIVE, dll.) — prefiks dihilangkan untuk singkatnya.

FieldKapabilitasNilai yang mungkin
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 sampai +100. Muncul ketika authenticationResult = AUTHENTICATION_RESULT_INCONCLUSIVE dan Skor Risiko diaktifkan.
serproResult.scoreHasil Kemiripan Serpro0–100 (kemiripan); -1 (tidak ada wajah yang terdaftar untuk CPF ini); -2 (error integrasi).
Field process.services
Konvensi penamaan campuran dalam services

Array services menggunakan camelCase untuk field tingkat envelope (envelopeId, documentIds) dan snake_case untuk field tingkat dokumen (doc_id, consent_granted, face_match, dll.). Ini mencerminkan respons API yang sebenarnya — kedua konvensi disengaja dan bukan merupakan kesalahan dokumentasi.

FieldTipeDeskripsi
envelopeIdstring (UUID)Identifier envelope yang ditandatangani.
documentIdsarray of stringsID dokumen yang ditangkap dalam layanan ini.
consent_grantedbooleanApakah pengguna memberikan persetujuan berbagi data.
documentsarrayDokumen yang ditangkap dengan data OCR dan hasil validasi.
documents[].doc_idstringIdentifier dokumen.
documents[].typifiedbooleanApakah tipe dokumen berhasil diidentifikasi.
documents[].cpf_matchbooleanApakah CPF pada dokumen cocok dengan CPF yang diberikan (khusus Brasil).
documents[].face_matchbooleanApakah selfie cocok dengan foto di dokumen.
documents[].validate_docbooleanApakah dokumen lolos validasi keaslian.
documents[].reused_docbooleanApakah dokumen ini digunakan kembali dari proses sebelumnya.
documents[].signed_urlstringURL yang telah ditandatangani untuk mengunduh PDF dokumen (berlaku selama 5 menit — ambil ulang untuk memperbarui).
documents[].doc.versionintegerVersi skema OCR.
documents[].doc.codestringKode tipe dokumen singkat (misalnya CNH). Lihat Tipe dokumen dan field OCR untuk semua nilai dan cara kode tersebut diturunkan.
documents[].doc.dataobjectField OCR yang diekstrak. Konten bervariasi berdasarkan tipe dokumen — lihat referensi field lengkap untuk katalog lengkapnya. Nama field dalam doc.data (misalnya nomeCivil, dataNascimento) dikembalikan dalam bahasa Portugis — ini adalah nilai aktual yang dihasilkan oleh mesin OCR.

Kode Error​

CodeMessageDeskripsi
3process id is invalidKetika process ID tidak valid.

Polling vs webhook​

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

Selanjutnya​

Terakhir diperbarui pada