Skip to main content
Cari hesaplar (müşteriler) SarrafPro’nun temel kaydıdır. Bu kaynak okuma uçlarının yanında müşteri tanı formatında oluşturma ucu da sunar.

GET /v1/customers — müşteri listesi

Şirkete ait cari hesapları sayfalı, filtreli ve sıralı listeler.

Sorgu parametreleri

Ortak parametreler (page, pageSize, sort, q) için Genel Bakış sayfasına bakın. Sıralama whitelist’i: createdDate, lastDate, updatedAt, nameSurname. Varsayılan createdDate:asc.

Cevap alanları (liste öğesi)

id, idNo, idType, idCardType, nameSurname, phone, email, nationality, countries, states, cities, labels, recordLevel, isVerify, isValid, isPhoto, saveType, createdDate, lastDate, updatedAt

GET /v1/customers/{id} — müşteri detayı

Tek cari hesabın geniş kaydını döner. Liste alanlarına ek olarak: name, surname, ownerName, birthplace, birthday, year, phone2, taxOffice, registryNo, cmpNo, activityName, naceCode, countriesCode, statesCode, address, motherName, fatherName, isAbroad, jobName, ibans, bankCodes, docTypes, customerRelation
Kimlik numarası (idNo) fatura/eşleştirme gereksinimleri nedeniyle tam ve maskesiz döner. PII alanları yalnızca detay ucunda yer alır.

POST /v1/customers — müşteri tanı formatında oluşturma

Yeni müşteri, müşteri tanı (KYC) formu olarak oluşturulur: kayıt onay bekleyen bir form olarak doğar (isApproval: false) ve onay akışı panel tarafında tamamlanır. API üzerinden doğrudan onaylı müşteri yaratılamaz.

İstek gövdesi

Salt okunur alanlar (isApproval, isSigned, isDeleted, masakStatus, companiesId, userId, approval* vb.) veya sözleşmede olmayan alanlar gönderilirse istek 400 VALIDATION_FAILED ile reddedilir.

Cevap — 201

Oluşan formun liste öğesi döner; durum takibi GET /v1/compliance/verifications/{id} ile yapılır:

Çift kayıt — 409 CONFLICT

Aynı idNo ile onay bekleyen (silinmemiş ve onaylanmamış) bir form zaten varsa istek reddedilir ve mevcut kaydın kimliği döner: