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

# Daftar Item Daftar Blokir API

> GET /v3/blocklist/: daftar wajah, dokumen, nomor telepon, dan email dari sesi Didit yang diblokir, dari yang terbaru, dalam satu feed.



Prompt API Daftar Item Blokir
        Salin prompt ke papan klip



      
      

\<pre>

\`List the blocklisted faces, documents, phone numbers and email addresses of my Didit verification sessions through the Management API.

Endpoint:
GET https://verification.didit.me/v3/blocklist/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: read.

Goal:
\- Get one paginated feed of every session record that is currently blocklisted, to build a "Blocked" screen or audit what my team has blocked.

Behavior:
\- Items are sorted by blocklisted_at, newest first. Items of deleted sessions are not included.
\- Each item has a type ("face", "document", "phone" or "email") and the session it belongs to (session_id, session_number). Fields that do not apply to the type are null.
\- The feed covers records blocklisted from a session: with POST /v3/blocklist/add/, from the console, or with a list entry created from reference_session_id. It does not include values added to a list by hand, uploaded faces, faces taken from a document-capture selfie, or IP address, device fingerprint, wallet, bank account, user and business entries. Read those with GET /v3/lists/{list_uuid}/entries/ on the matching system blocklist.
\- face_image and front_image are short-lived signed URLs, issued again on every call; a scoped key without media: read gets null instead.

Query parameters (all optional):
\- item_type: "face" | "document" | "phone" | "email". When omitted, every type is returned.
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

Example call:
curl -X GET "https://verification.didit.me/v3/blocklist/?item_type=document" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].type, session_id, session_number, blocklisted_at.
\- face items: face_image.
\- document items: document_type (for example "P" passport, "ID" national ID, "DL" driver's license), document_number, front_image.
\- phone items: phone_number (E.164), country_code (ISO 3166-1 alpha-2).
\- email items: email.

Failure modes:
\- 400: an unknown item_type, or limit/offset above 1000000.
\- 401: the API key has expired.
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401) ({ "detail": "You do not have permission to perform this action." }), or a scoped key without workflows: read.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects: none. This is a pure read.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Tempel ke

Daftar wajah, dokumen identitas, nomor telepon, dan alamat email dari sesi verifikasi Anda yang saat ini masuk daftar blokir, dari yang terbaru. Setiap item menunjuk ke sesi asalnya, sehingga Anda dapat membukanya di konsol atau mengambil hasil keputusannya.Umpan ini hanya menampilkan apa yang dimasukkan ke daftar blokir **dari sebuah sesi**: dengan [Tambahkan ke daftar blokir](https://docs.didit.me/id/management-api/blocklist/add.md), dari konsol, atau dengan [entri daftar](https://docs.didit.me/id/management-api/lists/create-entry.md) yang dibuat dari `reference_session_id`. Nilai yang diketik ke dalam daftar, [wajah yang diunggah](https://docs.didit.me/id/management-api/lists/upload-face.md), wajah yang diambil dari swafoto saat pengambilan dokumen, dan jenis entri lainnya (alamat IP, sidik jari perangkat, dompet, rekening bank, pengguna, bisnis) hanya ada di daftar blokir sistem: bacalah dengan [Daftar entri](https://docs.didit.me/id/management-api/lists/list-entries.md).Lihat [Blokir pengguna](https://docs.didit.me/id/console/blocklist-users.md) untuk cara kerja pemblokiran di konsol.


## OpenAPI

````yaml id/openapi-25.json GET /v3/blocklist/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API Verifikasi Identitas. Lakukan autentikasi dengan header x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/blocklist/:
    get:
      tags:
        - Blocklist
      summary: Daftar item yang masuk daftar blokir
      description: >-
        Mengembalikan satu feed terpaginasi dari wajah, dokumen identitas, nomor
        telepon, dan alamat email dari sesi verifikasi aplikasi yang saat ini
        masuk daftar blokir, `blocklisted_at` terbaru terlebih dahulu; filter
        dengan `item_type`. Item dari sesi yang dihapus tidak disertakan. Feed
        ini mencakup catatan yang dimasukkan ke daftar blokir dari suatu sesi
        (dengan [Tambahkan item sesi ke daftar
        blokir](https://docs.didit.me/id/management-api/blocklist/add), dari
        konsol, atau oleh entri daftar yang dibuat dari suatu sesi); nilai yang
        ditambahkan ke daftar secara manual, wajah yang diunggah, wajah dari
        swafoto pengambilan dokumen, dan jenis entri lainnya dibaca dengan
        [Daftar entri
        daftar](https://docs.didit.me/id/management-api/lists/list-entries).
        `face_image` dan `front_image` adalah URL bertanda tangan berumur
        pendek, dan kunci API ber-scope tanpa `media: read` menerima `null`.
        Kunci API ber-scope memerlukan `workflows: read`.
      operationId: list_blocklist_items
      parameters:
        - name: item_type
          in: query
          required: false
          description: >-
            Hanya item dari jenis ini. Jika dihilangkan, semua jenis
            dikembalikan.
          schema:
            type: string
            enum:
              - face
              - document
              - phone
              - email
        - name: limit
          in: query
          required: false
          description: >-
            Ukuran halaman. Nilai default-nya 50. Nilai di atas 1000000
            mengembalikan `400`; nol, nilai negatif, atau nilai non-numerik akan
            kembali ke 50.
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
        - name: offset
          in: query
          required: false
          description: >-
            Indeks berbasis nol dari item pertama yang dikembalikan. Sebaiknya
            ikuti `next`. Nilai di atas 1000000 mengembalikan `400`; nilai
            negatif atau non-numerik akan kembali ke 0.
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
      responses:
        '200':
          description: Satu halaman item daftar blokir, yang terbaru lebih dulu.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    minimum: 0
                    description: >-
                      Jumlah total item dalam daftar blokir yang cocok dengan
                      filter.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absolut halaman berikutnya, atau `null` di halaman
                      terakhir.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absolut halaman sebelumnya, atau `null` di halaman
                      pertama.
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/BlocklistedItem'
              examples:
                Mixed feed:
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - type: document
                        session_id: 33333333-4444-5555-6666-777777777777
                        session_number: 1042
                        blocklisted_at: '2026-10-12T10:06:12.701553Z'
                        face_image: null
                        document_type: ID
                        document_number: X1234567
                        front_image: >-
                          https://media.example.com/documents/front.jpg?expires=1760263938&signature=8b2e47
                        phone_number: null
                        country_code: null
                        email: null
                      - type: phone
                        session_id: 77777777-8888-9999-0000-111111111111
                        session_number: 1017
                        blocklisted_at: '2026-10-08T15:31:09.400127Z'
                        face_image: null
                        document_type: null
                        document_number: null
                        front_image: null
                        phone_number: '+14155552671'
                        country_code: US
                        email: null
        '400':
          description: Parameter kueri tidak valid.
          content:
            application/json:
              examples:
                Unknown item type:
                  value:
                    item_type:
                      - '"wallet" is not a valid choice.'
                Limit too large:
                  value:
                    - limit must not exceed 1000000.
        '401':
          description: >-
            Kunci API dengan cakupan terbatas telah kedaluwarsa. Kegagalan
            autentikasi lainnya mengembalikan `403`.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Header `x-api-key` tidak ada (kunci yang salah, dicabut, atau
            kedaluwarsa menghasilkan `401`), atau kunci API dengan cakupan
            tertentu tidak memiliki `workflows: read` atau digunakan dari alamat
            IP di luar daftar izinnya.
          content:
            application/json:
              examples:
                Missing or invalid API key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without workflows access:
                  value:
                    detail: This API key has no read access to workflows.
        '429':
          description: >-
            Batas baca bersama sebesar 600 permintaan per menit per kunci API
            telah terlampaui. Patuhi `Retry-After` sebelum mencoba lagi.
          content:
            application/json:
              examples:
                Rate limited:
                  value:
                    detail: >-
                      GET request rate limit exceeded. You can make up to 600
                      requests per minute.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/blocklist/?item_type=document' \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            for item in client.blocklist.list():
                print(item)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            for await (const item of didit.blocklist.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Blocklist.ListAutoPaging(ctx, didit.BlocklistListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            for (var item : client.blocklist().list()) {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            foreach ($didit->blocklist->list() as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            didit.blocklist.list.auto_paging_each do |item|
              puts item.to_h
            end
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY.
            using var client = new DiditClient();

            await foreach (var item in await client.Blocklist.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    BlocklistedItem:
      type: object
      description: >-
        Satu wajah, dokumen identitas, nomor telepon, atau alamat email yang
        masuk daftar blokir dari suatu sesi verifikasi. Kolom yang tidak berlaku
        untuk `type` item tersebut bernilai `null`.
      required:
        - type
        - session_id
        - session_number
        - blocklisted_at
        - face_image
        - document_type
        - document_number
        - front_image
        - phone_number
        - country_code
        - email
      properties:
        type:
          type: string
          enum:
            - face
            - document
            - phone
            - email
          description: Apa yang dimasukkan ke daftar blokir.
        session_id:
          type: string
          format: uuid
          description: Sesi verifikasi tempat item tersebut berada.
        session_number:
          type: integer
          nullable: true
          description: >-
            Nomor sesi tersebut dalam cakupan aplikasi, seperti yang ditampilkan
            di konsol.
        blocklisted_at:
          type: string
          format: date-time
          description: Waktu item terakhir kali dimasukkan ke daftar blokir.
        face_image:
          type: string
          nullable: true
          description: >-
            Item wajah: URL bertanda tangan berumur pendek, diterbitkan kembali
            pada setiap panggilan; `null` untuk kunci API dengan cakupan
            terbatas tanpa `media: read`. Juga `null` jika tidak ada gambar
            referensi yang disimpan.
        document_type:
          type: string
          nullable: true
          description: >-
            Item dokumen: kode jenis dokumen, misalnya `P` (paspor), `ID`
            (KTP/ID nasional), `DL` (SIM) atau `RP` (izin tinggal).
        document_number:
          type: string
          nullable: true
          description: >-
            Item dokumen: nomor dokumen, atau nomor pribadi jika dokumen tidak
            memilikinya.
        front_image:
          type: string
          nullable: true
          description: >-
            Item dokumen: gambar depan dokumen, URL bertanda tangan berumur
            pendek, diterbitkan ulang pada setiap panggilan; `null` untuk kunci
            API dengan cakupan tanpa `media: read`.
        phone_number:
          type: string
          nullable: true
          description: 'Item telepon: nomor telepon dalam E.164.'
        country_code:
          type: string
          nullable: true
          description: 'Item telepon: negara ISO 3166-1 alpha-2 dari nomor tersebut.'
        email:
          type: string
          nullable: true
          description: 'Item email: alamat email.'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Kunci API aplikasi Anda, dari Developers -> API keys di Business
        Console. Kunci utama memiliki akses penuh. Kunci bernama dapat diberi
        cakupan: none, read, atau write per sumber daya, dibatasi pada beberapa
        alur kerja atau pada sesi yang disetujui, pada daftar alamat IP, dan
        pada tanggal kedaluwarsa. 401 berarti kuncinya salah, dicabut, atau
        kedaluwarsa; 403 berarti tidak ada kunci yang dikirimkan, kunci tidak
        memiliki akses ke sumber daya atau tindakan ini, atau permintaan datang
        dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi
        berada di luar alur kerja atau status kunci tersebut. Kunci tanpa akses
        media menerima URL gambar, video, dan PDF sebagai null, dan kunci tanpa
        izin tulis sesi menerima tautan sesi dan token sebagai null. Lihat
        https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.