> ## 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.

# API Ambil Daftar: Detail Daftar Kepatuhan

> Ambil detail daftar blokir, daftar izin, atau daftar kustom Didit lewat GET /v3/lists/{list_uuid}/, termasuk jumlah entri dan metadata.



Prompt API untuk Mendapatkan Daftar
        Salin prompt ke papan klip



      
      

\<pre>

\`Fetch a single Didit list's metadata through the Management API.

Endpoint:
GET https://verification.didit.me/v3/lists/{list_uuid}/

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

Goal:
\- Retrieve the details of a specific list: name, description, list_type, entry_type, is_system, entry_count, last_entry_added_at.
\- Use this to render a list-detail view or to confirm a list still exists before adding entries.

Path parameter:
\- list_uuid: the list UUID returned by GET /v3/lists/ or POST /v3/lists/.

Example call:
curl -X GET "https://verification.didit.me/v3/lists/{list_uuid}/" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- list_type: "blocklist" | "allowlist" | "custom" (drives what a match does).
\- entry_type: decides how values are validated and which data is matched.
\- is_system: true for the lists Didit provisions (one blocklist per entry type, the "High Risk Countries" list, any system allowlist). These cannot be renamed, edited or deleted.
\- entry_count, last_entry_added_at: computed over the list's current entries.

This endpoint returns the list metadata only. To fetch entries, call GET /v3/lists/{list_uuid}/entries/.

Failure modes:
\- 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.
\- 404: no list with this UUID in this application, or it was deleted ({ "detail": "No List matches the given query." }).
\- 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

Dapatkan detail satu daftar, termasuk jumlah entrinya dan kapan entri terbarunya ditambahkan. Daftar milik aplikasi lain, atau daftar yang telah dihapus, mengembalikan `404`.Untuk membaca nilai dalam daftar, gunakan [Entri daftar](https://docs.didit.me/id/management-api/lists/list-entries.md).


## OpenAPI

````yaml id/openapi-25.json GET /v3/lists/{list_uuid}/
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/lists/{list_uuid}/:
    get:
      tags:
        - Lists
      summary: Dapatkan daftar
      description: >-
        Mengembalikan satu daftar dari aplikasi beserta jumlah entri dan waktu
        entri terbarunya ditambahkan. Daftar milik aplikasi lain, atau yang
        telah dihapus, mengembalikan `404`. Ini hanya mengembalikan daftar
        tersebut: baca nilai-nilainya dengan [Cantumkan entri
        daftar](https://docs.didit.me/id/management-api/lists/list-entries).
        Kunci API dengan cakupan memerlukan `workflows: read`.
      operationId: get_list
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: >-
            UUID daftar, seperti yang dikembalikan oleh Cantumkan daftar atau
            Buat daftar.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
      responses:
        '200':
          description: Daftar tersebut.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceList'
              examples:
                System face blocklist:
                  value:
                    uuid: 11111111-2222-3333-4444-555555555555
                    name: Face Blocklist
                    description: >-
                      Blocked biometric faces. When a face matching an entry in
                      this list is detected during liveness verification, the
                      session will be automatically declined.
                    list_type: blocklist
                    entry_type: face
                    is_system: true
                    entry_count: 12
                    last_entry_added_at: '2026-10-09T16:42:03.118204Z'
                    created_at: '2026-01-14T10:02:11.402917Z'
                    updated_at: '2026-01-14T10:02:11.402917Z'
        '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.
        '404':
          description: >-
            Tidak ada daftar dengan UUID ini di aplikasi milik kunci API, atau
            daftar tersebut telah dihapus.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: No List matches the given query.
        '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/lists/11111111-2222-3333-4444-555555555555/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.lists.retrieve(
                "11111111-2222-3333-4444-555555555555",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.lists.retrieve("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.lists().retrieve("11111111-2222-3333-4444-555555555555");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->lists->retrieve('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.lists.retrieve("11111111-2222-3333-4444-555555555555")

            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Lists.RetrieveAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    ComplianceList:
      type: object
      description: Daftar blokir, daftar izin, atau daftar kustom dari satu aplikasi.
      required:
        - uuid
        - name
        - description
        - list_type
        - entry_type
        - is_system
        - entry_count
        - last_entry_added_at
        - created_at
        - updated_at
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            Pengidentifikasi daftar. Gunakan ini sebagai `list_uuid` di endpoint
            daftar dan entri, serta sebagai nilai dari kondisi aturan alur kerja
            atau transaksi dengan `value_type: "list"`.
        name:
          type: string
          maxLength: 255
          description: Nama daftar, unik di antara daftar milik aplikasi.
        description:
          type: string
          description: Deskripsi teks bebas. String kosong jika tidak diatur.
        list_type:
          type: string
          enum:
            - blocklist
            - allowlist
            - custom
          description: >-
            `blocklist`: kecocokan akan menolak sesi atau transaksi (hanya
            daftar sistem, satu per tipe entri). `allowlist`: item yang cocok
            dipercaya, misalnya allowlist wajah melewati tindakan untuk wajah
            duplikat; tidak pernah menimpa kecocokan daftar blokir. `custom`:
            digunakan dalam kondisi aturan alur kerja dan transaksi
            (`value_type: "list"`).
        entry_type:
          type: string
          enum:
            - face
            - document
            - phone
            - email
            - ip_address
            - device_fingerprint
            - wallet_address
            - bank_account
            - country
            - user
            - business
            - key
          description: >-
            Apa yang dimuat dalam daftar: `face`, `document` (nomor dokumen),
            `phone`, `email`, `ip_address` (alamat atau rentang CIDR),
            `device_fingerprint`, `wallet_address`, `bank_account`, `country`
            (ISO 3166-1 alpha-3), `user` atau `business` (`vendor_data` Anda),
            atau `key` (string apa pun). Ini menentukan cara nilai entri
            divalidasi dan dicocokkan.
        is_system:
          type: boolean
          description: >-
            `true` untuk daftar yang disediakan oleh Didit: satu daftar blokir
            per tipe entri (`face`, `document`, `phone`, `email`, `ip_address`,
            `device_fingerprint`, `wallet_address`, `bank_account`, `user`,
            `business`), daftar kustom **Negara Berisiko Tinggi**, dan daftar
            izin sistem. Daftar sistem tidak dapat diganti namanya, diedit, atau
            dihapus; Anda dapat menambahkan dan menghapus entrinya.
        entry_count:
          type: integer
          minimum: 0
          description: Jumlah entri yang saat ini ada dalam daftar.
        last_entry_added_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Waktu entri saat ini yang terbaru ditambahkan. `null` untuk daftar
            kosong.
        created_at:
          type: string
          format: date-time
          description: Waktu daftar dibuat.
        updated_at:
          type: string
          format: date-time
          description: Waktu daftar terakhir diperbarui.
  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.