Skip to main content
GET
Kimlik belge kayıtları listesi

Authorizations

Authorization
string
header
required

Kullanıcı adı apiUserId, parola secretKey. Authorization: Basic base64(apiUserId:secretKey)

Query Parameters

page
integer
default:1

Sayfa numarası (en az 1).

Required range: x >= 1
pageSize
integer
default:25

Sayfa başına kayıt (1-100).

Required range: 1 <= x <= 100
sort
string

Sıralama: alan:asc|desc. İzinli alanlar: createdAt, updatedAt, validityDate. Varsayılan createdAt:asc.

Pattern: ^(createdAt|updatedAt|validityDate)(:(asc|desc))?$
filter[idNo]
string

Belge sahibi TCKN/VKN tam eşleşme.

filter[type]
enum<string>

Belge türü.

Available options:
unknown,
front,
rear,
accord,
signature,
addressDoc,
activeDoc,
registryDoc,
taxDoc,
signDoc
filter[channel]
enum<string>

Yükleme kanalı.

Available options:
manual,
whatsapp,
idv,
accord
filter[idCheck]
boolean

NVİ kimlik doğrulaması geçti mi.

filter[isApproval]
boolean

idNo doğrulama durumu.

filter[isDisabled]
boolean

Geçersizlik durumu. Verilmezse yalnız geçerli kayıtlar döner.

filter[startDate]
string<date-time>

ISO-8601 tarih; createdAt >= startDate.

filter[endDate]
string<date-time>

ISO-8601 tarih; createdAt <= endDate.

filter[updatedSince]
string<date-time>

ISO-8601 tarih; yalnız bu tarihte veya sonra güncellenen kayıtlar döner (updatedAt >=).

Response

Başarılı liste yanıtı.

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required