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

# Llista de bloqueig: API per llistar elements bloquejats

> GET /v3/blocklist/: llista cares, documents, telèfons i correus bloquejats de Didit, del més recent al més antic, en un únic llistat.



Prompt de l'API per llistar els elements bloquejats
        Copia el prompt al porta-retalls



      
      

\<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>



      
      

Enganxa a

Llista les cares, els documents d'identitat, els números de telèfon i les adreces de correu electrònic de les teves sessions de verificació que estan actualment a la llista de bloqueig, de més recent a més antiga. Cada element apunta a la sessió d'on prové, perquè la puguis obrir a la consola o obtenir-ne la decisió.Aquest llistat mostra el que s'ha bloquejat **des d'una sessió**: amb [Afegir a la llista de bloqueig](https://docs.didit.me/ca/management-api/blocklist/add.md), des de la consola, o amb una [entrada de llista](https://docs.didit.me/ca/management-api/lists/create-entry.md) creada a partir de `reference_session_id`. Els valors introduïts en una llista, les [cares pujades](https://docs.didit.me/ca/management-api/lists/upload-face.md), les cares extretes d'una selfie de captura de document i la resta de tipus d'entrada (adreça IP, empremta digital del dispositiu, cartera, compte bancari, usuari i empresa) només es troben a les llistes de bloqueig del sistema: consulta-les amb [Entrades de llista](https://docs.didit.me/ca/management-api/lists/list-entries.md).Consulta [Bloqueig d'usuaris](https://docs.didit.me/ca/console/blocklist-users.md) per veure com funciona el bloqueig a la consola.


## OpenAPI

````yaml ca/openapi-25.json GET /v3/blocklist/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/blocklist/:
    get:
      tags:
        - Blocklist
      summary: Llista els elements de la llista de bloqueig
      description: >-
        Retorna un canal paginat de les cares, documents d'identitat, números de
        telèfon i adreces de correu electrònic de les sessions de verificació de
        l'aplicació que estan actualment a la llista de bloqueig, ordenats pel
        `blocklisted_at` més recent primer; filtra amb `item_type`. Els elements
        de sessions suprimides no s'inclouen. El canal cobreix els registres
        afegits a la llista de bloqueig des d'una sessió (amb [Afegir elements
        de la sessió a la llista de
        bloqueig](https://docs.didit.me/ca/management-api/blocklist/add), des de
        la consola o mitjançant una entrada de llista creada a partir d'una
        sessió); els valors afegits a una llista manualment, les cares pujades,
        les cares d'una selfie de captura de document i els altres tipus
        d'entrada es consulten amb [Llistar entrades de
        llista](https://docs.didit.me/ca/management-api/lists/list-entries).
        `face_image` i `front_image` són URL signades de curta durada, i una
        clau d'API amb àmbit sense `media: read` rep `null`. Una clau d'API amb
        àmbit requereix `workflows: read`.
      operationId: list_blocklist_items
      parameters:
        - name: item_type
          in: query
          required: false
          description: >-
            Només elements d'aquest tipus. Quan s'omet, es retornen tots els
            tipus.
          schema:
            type: string
            enum:
              - face
              - document
              - phone
              - email
        - name: limit
          in: query
          required: false
          description: >-
            Mida de la pàgina. Per defecte és 50. Un valor superior a 1000000
            retorna `400`; un zero, un valor negatiu o un valor no numèric torna
            al valor per defecte de 50.
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
        - name: offset
          in: query
          required: false
          description: >-
            Índex basat en zero del primer element a retornar. És preferible
            seguir `next`. Un valor superior a 1000000 retorna `400`; un valor
            negatiu o no numèric torna a 0 per defecte.
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
      responses:
        '200':
          description: >-
            Una pàgina d'elements a la llista de bloqueig, els més recents
            primer.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    minimum: 0
                    description: >-
                      Nombre total d'elements a la llista de bloqueig que
                      coincideixen amb els filtres.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absoluta de la pàgina següent, o `null` a l'última
                      pàgina.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      URL absoluta de la pàgina anterior, o `null` a la primera
                      pàgina.
                  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: Un paràmetre de consulta no és vàlid.
          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: >-
            La clau d'API amb abast ha caducat. Altres fallades d'autenticació
            retornen `403`.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Falta la capçalera `x-api-key` (una clau incorrecta, revocada o
            caducada rep un `401`), o una clau d'API amb àmbit no té `workflows:
            read` o s'utilitza des d'una adreça fora de la seva llista
            d'admesos.
          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: >-
            S'ha superat el límit compartit de lectura de 600 sol·licituds per
            minut per clau d'API. Respecta `Retry-After` abans de reintentar.
          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: >-
        Una cara, document d'identitat, número de telèfon o adreça de correu
        electrònic a la llista de bloqueig d'una sessió de verificació. Els
        camps que no s'apliquen al `type` de l'element són `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: Què s'ha afegit a la llista de bloqueig.
        session_id:
          type: string
          format: uuid
          description: Sessió de verificació a la qual pertany l'element.
        session_number:
          type: integer
          nullable: true
          description: >-
            Número d'aquesta sessió en l'àmbit de l'aplicació, tal com es mostra
            a la consola.
        blocklisted_at:
          type: string
          format: date-time
          description: >-
            Quan es va afegir l'element a la llista de bloqueig per darrera
            vegada.
        face_image:
          type: string
          nullable: true
          description: >-
            Elements facials: URL signada de curta durada, emesa de nou en cada
            crida; `null` per a una clau d'API amb àmbit sense `media: read`.
            També `null` quan no hi ha cap imatge de referència emmagatzemada.
        document_type:
          type: string
          nullable: true
          description: >-
            Elements de document: codi de tipus de document, per exemple `P`
            (passaport), `ID` (document nacional d'identitat), `DL` (permís de
            conduir) o `RP` (permís de residència).
        document_number:
          type: string
          nullable: true
          description: >-
            Elements de document: el número de document, o el número personal
            quan el document no en té cap.
        front_image:
          type: string
          nullable: true
          description: >-
            Elements de document: imatge frontal del document, URL signat de
            curta durada, emès novament a cada crida; `null` per a una clau
            d'API amb abast limitat sense `media: read`.
        phone_number:
          type: string
          nullable: true
          description: 'Elements de telèfon: el número de telèfon en E.164.'
        country_code:
          type: string
          nullable: true
          description: 'Elements de telèfon: país ISO 3166-1 alfa-2 del número.'
        email:
          type: string
          nullable: true
          description: 'Elements de correu electrònic: l''adreça de correu electrònic.'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.

````

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