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

# Liste erstellen API: Allowlist & benutzerdefinierte Liste

> POST /v3/lists/: Mit Didit neue Allowlist oder benutzerdefinierte Liste erstellen. Systemsperrlisten werden automatisch angelegt. Keine Verträge.



API-Prompt zum Erstellen einer Liste
        Prompt in die Zwischenablage kopieren



      
      

\<pre>

\`Create a new allowlist or custom list in my Didit application through the Management API.

Endpoint:
POST https://verification.didit.me/v3/lists/

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

Goal:
\- Create an allowlist (matching items are treated as trusted, for example to skip a duplicated-face or duplicated-IP action; it never overrides a blocklist match) or a custom list (for workflow conditions, transaction rules, or manual review).
\- System blocklists are provisioned by Didit, one per entry type. You cannot create a blocklist.

Request body (application/json):
\{
"name": "Trusted office IPs",          // required, at most 255 characters, unique among the application's lists
"description": "Office egress ranges", // optional
"list_type": "allowlist",              // required: "allowlist" or "custom"
"entry_type": "ip_address"             // required: face | document | phone | email | ip_address | device_fingerprint | wallet_address | bank_account | country | user | business | key
}

entry_type is fixed once the list exists: it decides how entry values are validated and matched.

Example call:
curl -X POST "https://verification.didit.me/v3/lists/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Trusted office IPs", "list_type": "allowlist", "entry_type": "ip_address"}'

Example response (201):
\{
"uuid": "66666666-7777-8888-9999-000000000000",
"name": "Trusted office IPs",
"description": "",
"list_type": "allowlist",
"entry_type": "ip_address",
"is_system": false,
"entry_count": 0,
"last_entry_added_at": null,
"created_at": "2026-10-12T09:15:44.031876Z",
"updated_at": "2026-10-12T09:15:44.031876Z"
}

Persist the returned uuid: use it as list_uuid in the entry calls, and as the value of a workflow or transaction rule condition with value_type "list".

Failure modes:
\- 400: list_type is "blocklist", a required field is missing, name is longer than 255 characters, entry_type is unknown, or another list of the application already has this name ({ "name": ["A list with this name already exists for this application."] }).
\- 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: write.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects:
\- Creates a new list in the application the API key belongs to.

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

\</pre>



      
      

Einfügen in

Erstellen Sie eine Liste für Ihre Anwendung. Es können nur Listen vom Typ `allowlist` und `custom` erstellt werden: Didit stellt pro Eintragstyp eine systemseitige Blockliste bereit, zu der Sie über [Eintrag erstellen](https://docs.didit.me/de/management-api/lists/create-entry.md) Einträge hinzufügen.Wählen Sie `entry_type` sorgfältig aus: Der Wert kann später nicht mehr geändert werden, und er legt fest, wie jeder Wert bei seiner Hinzufügung validiert wird. Unter [Listen](https://docs.didit.me/de/management-api/lists/overview.md) finden Sie, was jeder Listentyp bewirkt.


## OpenAPI

````yaml de/openapi-25.json POST /v3/lists/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API für Ausweisverifizierung. Authentifizierung über den x-api-key-Header.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/lists/:
    post:
      tags:
        - Lists
      summary: Erstellen Sie eine Liste
      description: >-
        Erstellt eine Positivliste oder eine benutzerdefinierte Liste in der
        Anwendung, zu der der API-Schlüssel gehört. Sperrlisten können nicht
        erstellt werden: Didit stellt eine System-Sperrliste pro Eintragstyp
        bereit, die Sie mit [Listeneintrag
        erstellen](https://docs.didit.me/de/management-api/lists/create-entry)
        erweitern können. `entry_type` kann nach der Erstellung nicht mehr
        geändert werden und bestimmt, wie Eintragswerte validiert und
        abgeglichen werden. Positivlisten-Einträge markieren übereinstimmende
        Elemente als vertrauenswürdig (beispielsweise überspringt eine
        Gesichts-Positivliste die Aktion für doppelte Gesichter) und heben einen
        Sperrlisten-Treffer niemals auf; verweisen Sie über eine Workflow- oder
        Transaktionsregel-Bedingung mit `value_type: "list"` auf beliebige
        Listen. Ein API-Schlüssel mit eingeschränktem Berechtigungsumfang
        erfordert `workflows: write`.
      operationId: create_list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - list_type
                - entry_type
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: >-
                    Listenname. Muss sich vom Namen jeder anderen Liste der
                    Anwendung unterscheiden, einschließlich Systemlisten.
                description:
                  type: string
                  default: ''
                  description: Optionale Freitextbeschreibung.
                list_type:
                  type: string
                  enum:
                    - allowlist
                    - custom
                  description: >-
                    `allowlist` oder `custom`. `blocklist` wird mit `400`
                    abgewiesen.
                entry_type:
                  type: string
                  enum:
                    - face
                    - document
                    - phone
                    - email
                    - ip_address
                    - device_fingerprint
                    - wallet_address
                    - bank_account
                    - country
                    - user
                    - business
                    - key
                  description: >-
                    Was die Liste enthält: `face`, `document`
                    (Dokumentennummer), `phone`, `email`, `ip_address` (Adresse
                    oder CIDR-Bereich), `device_fingerprint`, `wallet_address`,
                    `bank_account`, `country` (ISO 3166-1 alpha-3), `user` oder
                    `business` (Ihre `vendor_data`) oder `key` (eine beliebige
                    Zeichenkette). Damit wird bestimmt, wie Eintragswerte
                    validiert und abgeglichen werden. Kann später nicht mehr
                    geändert werden.
            examples:
              IP allowlist:
                value:
                  name: Trusted office IPs
                  description: Office egress ranges
                  list_type: allowlist
                  entry_type: ip_address
              Custom country list:
                value:
                  name: Enhanced due diligence countries
                  list_type: custom
                  entry_type: country
      responses:
        '201':
          description: Die Liste wurde erstellt.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceList'
              examples:
                New allowlist:
                  value:
                    uuid: 22222222-3333-4444-5555-666666666666
                    name: Trusted office IPs
                    description: Office egress ranges
                    list_type: allowlist
                    entry_type: ip_address
                    is_system: false
                    entry_count: 0
                    last_entry_added_at: null
                    created_at: '2026-10-12T09:15:44.031876Z'
                    updated_at: '2026-10-12T09:15:44.031876Z'
        '400':
          description: Der Body ist ungültig.
          content:
            application/json:
              examples:
                Blocklist refused:
                  value:
                    list_type:
                      - >-
                        Cannot create additional blocklist lists. System
                        blocklists are auto-created for each application.
                Duplicate name:
                  value:
                    name:
                      - >-
                        A list with this name already exists for this
                        application.
                Missing fields:
                  value:
                    name:
                      - This field is required.
                    list_type:
                      - This field is required.
                    entry_type:
                      - This field is required.
                Unknown entry type:
                  value:
                    entry_type:
                      - '"iban" is not a valid choice.'
                Name too long:
                  value:
                    name:
                      - Ensure this field has no more than 255 characters.
        '401':
          description: >-
            Der API-Schlüssel mit eingeschränktem Geltungsbereich ist
            abgelaufen. Andere Authentifizierungsfehler geben `403` zurück.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Der `x-api-key`-Header fehlt (ein falscher, widerrufener oder
            abgelaufener Schlüssel erhält `401`), oder ein API-Schlüssel mit
            Berechtigungseinschränkungen verfügt nicht über `workflows: write`
            oder wird von einer IP-Adresse außerhalb seiner Zulassungsliste
            verwendet.
          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 write access to workflows.
        '429':
          $ref: '#/components/responses/RateLimitedWrite'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X POST 'https://verification.didit.me/v3/lists/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{
                "name": "Trusted office IPs",
                "description": "Office egress ranges",
                "list_type": "allowlist",
                "entry_type": "ip_address"
              }'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.lists.create(
                name="Trusted office IPs",
                description="Office egress ranges",
                list_type="allowlist",
                entry_type="ip_address",
            )
            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.create({
              name: "Trusted office IPs",
              description: "Office egress ranges",
              list_type: "allowlist",
              entry_type: "ip_address",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Create(ctx, didit.ListsCreateParams{\n\tName:        \"Trusted office IPs\",\n\tDescription: didit.String(\"Office egress ranges\"),\n\tListType:    \"allowlist\",\n\tEntryType:   \"ip_address\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;
            import me.didit.types.ListsCreateParams;

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

            var result = client.lists().create(ListsCreateParams.builder()
                    .name("Trusted office IPs")
                    .description("Office egress ranges")
                    .listType(ListsCreateParams.ListType.of("allowlist"))
                    .entryType(ListsCreateParams.EntryType.of("ip_address"))
                    .build());
            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->create([
                'name' => 'Trusted office IPs',
                'description' => 'Office egress ranges',
                'list_type' => 'allowlist',
                'entry_type' => 'ip_address',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.lists.create(
              name: "Trusted office IPs",
              description: "Office egress ranges",
              list_type: "allowlist",
              entry_type: "ip_address"
            )
            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.CreateAsync(new ListsCreateParams
            {
                Name = "Trusted office IPs",
                Description = "Office egress ranges",
                ListType = "allowlist",
                EntryType = "ip_address",
            });
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    ComplianceList:
      type: object
      description: >-
        Eine Sperrliste, Positivliste oder benutzerdefinierte Liste einer
        Anwendung.
      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: >-
            Listen-Identifikator. Verwenden Sie ihn als `list_uuid` in den
            Listen- und Eintrag-Endpoints sowie als Wert einer Workflow- oder
            Transaktionsregel-Bedingung mit `value_type: "list"`.
        name:
          type: string
          maxLength: 255
          description: Listenname, eindeutig unter den Listen der Anwendung.
        description:
          type: string
          description: Freitext-Beschreibung. Leere Zeichenkette, wenn nicht festgelegt.
        list_type:
          type: string
          enum:
            - blocklist
            - allowlist
            - custom
          description: >-
            `blocklist`: Eine Übereinstimmung lehnt die Sitzung oder Transaktion
            ab (nur Systemlisten, eine pro Eintragstyp). `allowlist`:
            Übereinstimmende Elemente gelten als vertrauenswürdig,
            beispielsweise überspringt eine Gesichts-Allowlist die Aktion für
            doppelte Gesichter; überschreibt niemals eine
            Sperrlisten-Übereinstimmung. `custom`: Wird in Workflow- und
            Transaktionsregel-Bedingungen verwendet (`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: >-
            Was die Liste enthält: `face`, `document` (Dokumentennummer),
            `phone`, `email`, `ip_address` (Adresse oder CIDR-Bereich),
            `device_fingerprint`, `wallet_address`, `bank_account`, `country`
            (ISO 3166-1 Alpha-3), `user` oder `business` (Ihre `vendor_data`)
            oder `key` (eine beliebige Zeichenkette). Damit wird bestimmt, wie
            Eintragswerte validiert und abgeglichen werden.
        is_system:
          type: boolean
          description: >-
            `true` für die von Didit bereitgestellten Listen: eine Sperrliste
            pro Eintragstyp (`face`, `document`, `phone`, `email`, `ip_address`,
            `device_fingerprint`, `wallet_address`, `bank_account`, `user`,
            `business`), die benutzerdefinierte Liste **High Risk Countries**
            und System-Positivlisten. Systemlisten können weder umbenannt noch
            bearbeitet oder gelöscht werden; Sie können deren Einträge
            hinzufügen und löschen.
        entry_count:
          type: integer
          minimum: 0
          description: Anzahl der Einträge, die sich derzeit in der Liste befinden.
        last_entry_added_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Wann der neueste aktuelle Eintrag hinzugefügt wurde. `null` bei
            einer leeren Liste.
        created_at:
          type: string
          format: date-time
          description: Wann die Liste erstellt wurde.
        updated_at:
          type: string
          format: date-time
          description: Wann die Liste zuletzt aktualisiert wurde.
  responses:
    RateLimitedWrite:
      description: >-
        Das geteilte Schreiblimit von 300 Anfragen pro Minute pro API-Schlüssel
        wurde überschritten. Beachten Sie `Retry-After`, bevor Sie es erneut
        versuchen.
      content:
        application/json:
          schema:
            type: object
            required:
              - detail
            properties:
              detail:
                type: string
          example:
            detail: >-
              Write request rate limit exceeded. You can make up to 300 requests
              per minute.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in
        der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter
        Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese-
        oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte
        Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und
        auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen
        oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde,
        der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder
        die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei
        einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows
        oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff
        erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne
        Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als
        null. Siehe https://docs.didit.me/console/api-keys.

````

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