API Reference — Face Enrollment

Endpoint untuk mengelola data Face Enrollment, NIK, custom field, alias, dan pencarian massal.

← Kembali ke Face Enrollment

Panduan operator: tambah, edit, hapus, batch import, custom field.

Otentikasi

Cara memperoleh dan menggunakan Bearer token JWT.

Semua endpoint memerlukan header Authorization: Bearer <token>. Basis URL mengikuti variabel lingkungan VITE_API_URL yang dikonfigurasi pada instalasi Lenz. Jika Anda belum punya token, lihat halaman Otentikasi.

CRUD Enrollment

Endpoint utama untuk membuat, membaca, memperbarui, dan menghapus data enrollment satu per satu.

Daftar Enrollment

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

page?integer

Nomor halaman, dimulai dari 1

Default1

limit?integer

Jumlah data per halaman

Default10

search?string

Pencarian berdasarkan nama atau nomor identitas

filter[status]?string

Filter berdasarkan status enrollment

filter[face_id]?string

Filter berdasarkan face_id tertentu

filter[custom_fields.<key>]?string

Filter berdasarkan nilai custom field tertentu

sortBy?string

Kolom untuk pengurutan

Default"id"

descending?boolean

Urutan menurun jika true

Defaulttrue

Response Body

`application/json`

curl -X GET "https://lenz.example.com/api/enrollment"

{  "ok": true,  "message": "succesfully get enrolled person",  "results": {    "limit": 20,    "current_page": 1,    "total_data": 1,    "total_page": 1,    "enrollments": [      {        "id": 1,        "name": "Budi Santoso",        "identity_number": "3201xxxxxxxxxxxx",        "gender": "male",        "birth_place": "Jakarta",        "birth_date": "1990-05-20",        "status": "whitelist",        "face_id": "abc123def456",        "alias_names": [          "Budi"        ],        "faces": [          {            "id": 1,            "enrolled_face_id": 1,            "variation": "1234567890",            "created_at": "2024-01-01T00:00:00Z"          }        ],        "custom_field": {},        "created_at": "2024-01-01T00:00:00Z",        "updated_at": "2024-01-01T00:00:00Z",        "deleted_at": null      }    ]  }}

Tambah Enrollment

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Nama lengkap

identity_number*string

NIK atau nomor identitas unik

images*array<>

Satu atau lebih foto wajah JPEG; setiap file dikirim sebagai field images terpisah

birth_date?string

Tanggal lahir, format YYYY-MM-DD

Formatdate

birth_place?string

Tempat lahir

gender?string

Jenis kelamin

Value in"male" | "female"

face_id?string

ID custom; digenerate otomatis jika tidak diisi

status?string

Status enrollment (contoh: whitelist, blacklist)

keyspace?string

Keyspace target enrollment

Default"default"

alias_names?string

Daftar alias dalam format JSON, contoh: ["Budi","B.S."]

custom_field?string

Atribut custom field non-file dalam format JSON object

custom_field_<key>?array<>

Custom field bertipe file atau image; gunakan nama key sebagai suffix field name

Response Body

`application/json`

curl -X POST "https://lenz.example.com/api/enrollment" \  -F name="string" \  -F identity_number="string" \  -F images="[    \"string\"  ]"

{  "ok": true,  "message": "Successfully enroll new person",  "enrollment": {    "id": 42,    "name": "Budi Santoso",    "identity_number": "3201xxxxxxxxxxxx",    "face_id": "abc123def456",    "keyspace": "default",    "created_at": "2024-06-01T08:00:00Z",    "updated_at": "2024-06-01T08:00:00Z",    "deleted_at": null,    "faces": [      {        "id": 10,        "variation": "9876543210",        "image": "<base64>"      }    ]  }}

Detail Enrollment

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*integer

ID numerik enrollment

Response Body

`application/json`

curl -X GET "https://lenz.example.com/api/enrollment/0"

{  "ok": true,  "message": "Succesfully get detail enrolled faces",  "enrollment": {    "id": 42,    "name": "Budi Santoso",    "identity_number": "3201xxxxxxxxxxxx",    "gender": "male",    "birth_place": "Jakarta",    "birth_date": "1990-05-20",    "status": "whitelist",    "face_id": "abc123def456",    "alias_names": [      "Budi"    ],    "faces": [      {        "id": 10,        "enrolled_face_id": 42,        "variation": "9876543210",        "created_at": "2024-06-01T08:00:00Z"      }    ],    "custom_field": {      "departemen": "IT"    },    "created_at": "2024-06-01T08:00:00Z",    "updated_at": "2024-06-01T08:00:00Z",    "deleted_at": null  }}

Update Enrollment

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*integer

ID numerik enrollment

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Nama lengkap

identity_number*string

NIK atau nomor identitas

images?array<>

Foto baru yang ditambahkan (opsional)

deleted_variations?array<string>

ID variation foto yang ingin dihapus; kirim sebagai field terpisah untuk setiap variation

birth_date?string

Tanggal lahir, format YYYY-MM-DD

Formatdate

birth_place?string

Tempat lahir

gender?string

male atau female

Value in"male" | "female"

status?string

Status enrollment

keyspace?string

Keyspace target

alias_names?string

Daftar alias dalam format JSON

custom_field?string

Custom field non-file dalam format JSON object

custom_field_<key>?array<>

Custom field bertipe file atau image

Response Body

curl -X PUT "https://lenz.example.com/api/enrollment/0" \  -F name="string" \  -F identity_number="string"

Empty

Hapus Enrollment

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*integer

ID numerik enrollment

Response Body

`application/json`

curl -X DELETE "https://lenz.example.com/api/enrollment/0"

{  "ok": true,  "message": "succesfully enrolled person"}

Statistik & Status

Endpoint ringan untuk widget dashboard, filter status di toolbar, dan monitoring jumlah enrollment.

Total Count

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

instance?string

ID instance tertentu pada mode federation (opsional)

Response Body

`application/json`

curl -X GET "https://lenz.example.com/api/enrollment/total"

{  "ok": true,  "message": "success",  "total": 1250}

Status Enrollment

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://lenz.example.com/api/enrolled-faces/statuses"

{  "ok": true,  "message": "success",  "results": {    "total": 1250,    "statuses": [      {        "status": "whitelist",        "total": 800      },      {        "status": "blacklist",        "total": 150      },      {        "status": "normal",        "total": 300      }    ]  }}

Bulk Lookup

Endpoint untuk mengambil banyak enrollment sekaligus, biasanya dipakai pada halaman event atau hasil pencarian saat me-resolve face_id ke detail orang.

Bulk Lookup by Face ID

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

face_ids*string

Daftar face_id dipisahkan koma

Response Body

`application/json`

curl -X GET "https://lenz.example.com/api/enrolled-faces/get-by-face-ids?face_ids=string"

{  "ok": true,  "message": "success",  "results": [    {      "id": 42,      "name": "Budi Santoso",      "identity_number": "3201xxxxxxxxxxxx",      "face_id": "abc123",      "status": "whitelist",      "faces": []    }  ]}

API Reference — Face Enrollment

← Kembali ke Face Enrollment

Otentikasi

200application/json

200application/json

200application/json

200

200application/json

200application/json

200application/json

200application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`