> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sarraf.pro/llms.txt
> Use this file to discover all available pages before exploring further.

# Kimlik belge kayıtları listesi

> Şirkete ait kimlik belge kayıtlarını (doğrulama durumlarıyla) listeler. Geçersiz (isDisabled) kayıtlar varsayılan olarak dönmez; filter[isDisabled]=true ile sorgulanabilir. Bilinmeyen filter alanı 400 VALIDATION_FAILED döner.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/compliance/identity-documents
openapi: 3.0.3
info:
  title: Sarraf API v1
  version: 1.0.0
  description: >-
    Sarraf sürümlü dış API yüzeyi. Bu sürüm salt okunurdur; e-ticaret siteleri
    ve muhasebe programları için mevcut kayıtların okunmasını sağlar. Kimlik
    doğrulama mevcut dış API ile aynıdır: HTTP Basic,
    base64(apiUserId:secretKey). Tüm yanıtlar sabit zarf formatındadır: başarılı
    yanıtta success/data/meta, hatalı yanıtta
    success/error{code,message,details}/traceId. Her yanıtta x-request-id
    başlığı döner ve traceId ile aynıdır.
servers:
  - url: https://api.sarraf.pro
    description: Canlı ortam
security:
  - BasicAuth: []
tags:
  - name: Customers
    description: Cari hesaplar — listeleme, detay ve müşteri tanı formatında oluşturma
    x-group: Müşteriler
  - name: Bank accounts
    description: Banka hesapları, bakiyeler ve sorgu tetikleme
    x-group: Banka
  - name: Bank transactions
    description: Gelen/giden banka hareketleri — detayda gömülü MASAK özeti
    x-group: Banka
  - name: Invoices
    description: Sistem üzerinden kesilen faturalar ve kalem şablonları
    x-group: Faturalar
  - name: Expenses
    description: Gider pusulası kayıtları
    x-group: Giderler
  - name: Compliance
    description: >-
      Müşteri tanı formları, kimlik belgeleri, yaptırım sorguları, sicil,
      denetim ve IDV kayıtları
    x-group: Uyum (Compliance)
paths:
  /v1/compliance/identity-documents:
    get:
      tags:
        - Compliance
      summary: Kimlik belge kayıtları listesi
      description: >-
        Şirkete ait kimlik belge kayıtlarını (doğrulama durumlarıyla) listeler.
        Geçersiz (isDisabled) kayıtlar varsayılan olarak dönmez;
        filter[isDisabled]=true ile sorgulanabilir. Bilinmeyen filter alanı 400
        VALIDATION_FAILED döner.
      operationId: listComplianceIdentityDocuments
      parameters:
        - name: page
          in: query
          required: false
          description: Sayfa numarası (en az 1).
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          required: false
          description: Sayfa başına kayıt (1-100).
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: sort
          in: query
          required: false
          description: >-
            Sıralama: alan:asc|desc. İzinli alanlar: createdAt, updatedAt,
            validityDate. Varsayılan createdAt:asc.
          schema:
            type: string
            pattern: ^(createdAt|updatedAt|validityDate)(:(asc|desc))?$
        - name: filter[idNo]
          in: query
          required: false
          description: Belge sahibi TCKN/VKN tam eşleşme.
          schema:
            type: string
        - name: filter[type]
          in: query
          required: false
          description: Belge türü.
          schema:
            type: string
            enum:
              - unknown
              - front
              - rear
              - accord
              - signature
              - addressDoc
              - activeDoc
              - registryDoc
              - taxDoc
              - signDoc
        - name: filter[channel]
          in: query
          required: false
          description: Yükleme kanalı.
          schema:
            type: string
            enum:
              - manual
              - whatsapp
              - idv
              - accord
        - name: filter[idCheck]
          in: query
          required: false
          description: NVİ kimlik doğrulaması geçti mi.
          schema:
            type: boolean
        - name: filter[isApproval]
          in: query
          required: false
          description: idNo doğrulama durumu.
          schema:
            type: boolean
        - name: filter[isDisabled]
          in: query
          required: false
          description: Geçersizlik durumu. Verilmezse yalnız geçerli kayıtlar döner.
          schema:
            type: boolean
        - name: filter[startDate]
          in: query
          required: false
          description: ISO-8601 tarih; createdAt >= startDate.
          schema:
            type: string
            format: date-time
        - name: filter[endDate]
          in: query
          required: false
          description: ISO-8601 tarih; createdAt <= endDate.
          schema:
            type: string
            format: date-time
        - name: filter[updatedSince]
          in: query
          required: false
          description: >-
            ISO-8601 tarih; yalnız bu tarihte veya sonra güncellenen kayıtlar
            döner (updatedAt >=).
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Başarılı liste yanıtı.
          headers:
            x-request-id:
              description: İstek kimliği; yanıt gövdesindeki meta.requestId ile aynıdır.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityDocumentListResponse'
        '400':
          $ref: '#/components/responses/ValidationFailed'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    IdentityDocumentListResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: array
          items:
            $ref: '#/components/schemas/IdentityDocumentListItem'
        meta:
          $ref: '#/components/schemas/MetaList'
      required:
        - success
        - data
        - meta
    IdentityDocumentListItem:
      type: object
      properties:
        id:
          type: string
          description: Kayıt kimliği (ObjectId).
        idNo:
          type: string
          description: Belge sahibi TCKN/VKN.
        type:
          type: string
          enum:
            - unknown
            - front
            - rear
            - accord
            - signature
            - addressDoc
            - activeDoc
            - registryDoc
            - taxDoc
            - signDoc
        channel:
          type: string
          enum:
            - manual
            - whatsapp
            - idv
            - accord
          description: Yükleme kanalı.
        fileType:
          type: string
          nullable: true
        validityDate:
          type: string
          format: date-time
          nullable: true
          description: Belge geçerlilik tarihi.
        idCheck:
          type: boolean
          description: NVİ doğrulaması geçti mi.
        isApproval:
          type: boolean
          description: idNo doğrulaması yapıldı mı.
        isDisabled:
          type: boolean
          description: Belge geçersiz mi.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    MetaList:
      allOf:
        - $ref: '#/components/schemas/MetaBase'
        - type: object
          properties:
            page:
              type: integer
            limit:
              type: integer
            total:
              type: integer
            pages:
              type: integer
          required:
            - page
            - limit
            - total
            - pages
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          $ref: '#/components/schemas/ErrorBody'
        traceId:
          type: string
          format: uuid
          description: x-request-id başlığı ile aynı değer.
      required:
        - success
        - error
        - traceId
    MetaBase:
      type: object
      properties:
        requestId:
          type: string
          format: uuid
        timestamp:
          type: string
          format: date-time
      required:
        - requestId
        - timestamp
    ErrorBody:
      type: object
      properties:
        code:
          type: string
          enum:
            - VALIDATION_FAILED
            - AUTH_INVALID_CREDENTIALS
            - AUTH_FORBIDDEN
            - RESOURCE_NOT_FOUND
            - CONFLICT
            - UPSTREAM_ERROR
            - INTERNAL_ERROR
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
      required:
        - code
        - message
        - details
    ErrorDetail:
      type: object
      properties:
        field:
          type: string
        rule:
          type: string
  responses:
    ValidationFailed:
      description: Doğrulama hatası (geçersiz parametre).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Kimlik doğrulama başarısız.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Beklenmeyen sunucu hatası.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Kullanıcı adı apiUserId, parola secretKey. Authorization: Basic
        base64(apiUserId:secretKey)

````