Lewati ke konten utama

Dapatkan Proses

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)yaPengidentifikasi 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": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "flow": "idunicosign",
    "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
      },
      "serproResult": {
        "score": 92
      }
    },
    "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"
              }
            }
          }
        ]
      }
    ]
  }
}
Kolom tingkat atas
KolomTipeDeskripsi
process.idstring (UUID)Pengidentifikasi proses.
process.flowstringPengidentifikasi alur yang dikirim saat pembuatan.
process.callbackUristringURL callback yang dikonfigurasi untuk peristiwa proses.
process.userRedirectUrlstringURL untuk mengarahkan pengguna setelah perjalanan selesai.
process.stateenumStatus proses saat ini. Lihat nilai di bawah.
process.resultenumHasil verifikasi. Tersedia hanya ketika state = PROCESS_STATE_FINISHED.
process.createdAtstring (datetime)Timestamp ISO 8601 saat proses dibuat.
process.finishedAtstring (datetime)Timestamp ISO 8601 saat proses selesai. Tersedia hanya ketika state = PROCESS_STATE_FINISHED.
process.expiresAtstring (datetime)Timestamp ISO 8601 saat proses kedaluwarsa.
process.purposestringTujuan proses sesuai konfigurasi alur.
process.clientReferencestringReferensi sisi klien opsional untuk pengindeksan di portal.
process.useCasestringPengidentifikasi kasus penggunaan yang terkait dengan alur.
process.capacitiesarray of stringsDaftar kapabilitas yang diaktifkan dalam proses ini.
process.tokenstringJWT bertanda tangan untuk integrasi SDK.
process.personobjectIdentifikasi yang diberikan saat pembuatan.
process.person.notificationsarraySaluran notifikasi yang dikonfigurasi untuk perjalanan (contoh: email).
process.authenticationInfoobjectHasil per kapabilitas. Lihat di bawah.
process.companyDataobjectKonteks perusahaan dan cabang.
process.companyData.branchIdstringPengidentifikasi cabang.
process.companyData.countryCodestringKode negara ISO 3166-1 alpha-2.
process.bioTokenDataobjectInformasi proses referensi — tersedia hanya pada alur validasi 1:1 dan Revalidasi Cerdas.
process.servicesarrayAmplop bertanda tangan, dokumen yang ditangkap, dan keluaran layanan lainnya. Lihat di bawah.
Nilai process.state
NilaiArti
PROCESS_STATE_CREATEDProses dibuat; pengguna belum menyelesaikan perjalanan.
AWAITING_FOR_DOCUMENTProses dibuat tanpa dokumen identifikasi; menunggu dokumen ditetapkan melalui Set Process Document. Hanya muncul ketika Custom Flow mengizinkan dokumen opsional.
PROCESS_STATE_FINISHEDPerjalanan selesai. Periksa result dan authenticationInfo.
PROCESS_STATE_FAILEDKesalahan pemrosesan.
Ketidakkonsistenan penamaan status

AWAITING_FOR_DOCUMENT tidak mengikuti konvensi awalan PROCESS_STATE_* yang digunakan oleh status lainnya. Ini adalah ketidakkonsistenan 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 (contoh: liveness gagal, identitas tidak cocok).
PROCESS_RESULT_ERRORKesalahan selama pemrosesan hasil.
PROCESS_RESULT_EXPIREDProses kedaluwarsa sebelum perjalanan selesai.
PROCESS_RESULT_UNSPECIFIEDProses belum selesai.
Hasil kapabilitas dalam authenticationInfo

Semua kolom selalu dikembalikan tanpa memandang alur. Kolom untuk kapabilitas yang tidak digunakan dalam alur mengembalikan *_UNSPECIFIED.

Nilai enum singkat

Nilai singkat (misalnya livenessResult = LIVE, authenticationResult = INCONCLUSIVE) berkorespondensi langsung dengan nilai enum lengkap yang didokumentasikan di sini (LIVENESS_RESULT_LIVE, AUTHENTICATION_RESULT_INCONCLUSIVE, dll.) — awalan dihilangkan demi keringkasan.

KolomKapabilitasNilai yang mungkin
authenticationId—Pengidentifikasi 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. Tersedia ketika authenticationResult = AUTHENTICATION_RESULT_INCONCLUSIVE dan Klasifikasi risiko penipuan diaktifkan.
serproResult.scoreHasil Kemiripan Serpro0–100 (kemiripan); -1 (tidak ada wajah dalam arsip untuk CPF ini); -2 (kesalahan integrasi).
Kolom process.services
KolomTipeDeskripsi
envelopeIdstring (UUID)Pengidentifikasi amplop bertanda tangan.
documentIdsarray of stringsID dokumen yang ditangkap dalam layanan ini.
consent_grantedbooleanApakah pengguna memberikan persetujuan berbagi data.
documentsarrayDokumen yang ditangkap beserta data OCR dan hasil validasi.
documents[].doc_idstringPengidentifikasi dokumen.
documents[].typifiedbooleanApakah jenis dokumen berhasil diidentifikasi.
documents[].cpf_matchbooleanApakah CPF pada dokumen cocok dengan CPF yang diberikan.
documents[].face_matchbooleanApakah selfie cocok dengan foto pada dokumen.
documents[].validate_docbooleanApakah dokumen lulus validasi keaslian.
documents[].reused_docbooleanApakah dokumen ini digunakan kembali dari proses sebelumnya.
documents[].signed_urlstringURL pre-signed untuk mengunduh PDF dokumen (berlaku selama 5 menit — ambil ulang untuk memperbarui).
documents[].doc.versionintegerVersi skema OCR.
documents[].doc.codestringKode jenis dokumen (contoh: CNH, RG).
documents[].doc.dataobjectKolom OCR yang diekstrak. Konten bervariasi berdasarkan jenis dokumen dan data yang tersedia.
400 Bad Request

Parameter path processId tidak ada atau tidak valid.

401 Unauthorized

Bearer token tidak ada, kedaluwarsa, atau tidak valid.

404 Not Found

processId tidak ada atau tidak termasuk dalam tenant yang terautentikasi.

429 Too Many Requests

Batas rate limit tercapai.

Kode Error​

KodePesanDeskripsi
3process id is invalidKetika ID proses tidak valid.

Polling vs webhook​

Anda dapat melakukan polling pada endpoint ini untuk memeriksa kemajuan, tetapi pola yang direkomendasikan adalah berlangganan webhook dan hanya memanggil endpoint ini sebagai fallback. Lihat Webhooks and Events.

Langkah selanjutnya​

Terakhir diperbarui pada