> ## 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. # Criar Entrada em Lista de Bloqueio e Permissões: API > Adicione à Didit uma entrada (rosto, documento, IP, carteira, e-mail, telefone) numa lista de bloqueio ou de permissões. Prompt da API para criar entrada de lista Copiar o prompt para a área de transferência \

\`Add an entry to a Didit list (blocklist, allowlist, or custom) through the Management API.

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

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

Goal:
\- Insert a single entry into a list. Three add modes are supported:
1\. By value: pass value matching the list's entry_type.
2\. From a verification session: pass reference_session_id and Didit reads the value from the session's most recent record of the list's entry_type (face, document, phone, email, ip_address, device_fingerprint) and links the entry to the session.
3\. With a source reference: pass value plus reference_object_uuid and metadata.reference_type so the console links the entry back to the transaction, user or business it came from.

Path parameter:
\- list_uuid: list UUID from GET /v3/lists/. For a face without a session, use POST /v3/lists/{list_uuid}/entries/face-upload/ instead.

Request body (application/json):
\{
"value": "string",                  // required unless reference_session_id is sent
"reference_session_id": "uuid",     // optional: read the value from this session of my application
"reference_object_uuid": "uuid",    // optional: transaction UUID, or didit_internal_id of a user or business
"face_image_source": "liveness" | "front_image_camera_front" | "back_image_camera_front", // optional, system face blocklist + reference_session_id only; default liveness
"reference_node_id": "string",      // optional, with a document-capture face_image_source: which ID verification node's selfie to use
"display_label": "string",          // optional, at most 512 characters
"comment": "string",                // optional, reason or note
"metadata": {                       // optional, free-form; reference_image_url and front_image_url are ignored
"reference_type": "transaction" | "vendor_user" | "vendor_business",
"reference_id": "uuid"
}
}

Value validation by entry_type:
\- email: valid email address.
\- phone: valid international phone number (stored in E.164).
\- ip_address: IP address or CIDR range (e.g. 10.0.0.0/8).
\- device_fingerprint: at least 8 characters among letters, digits, -, _, : and . (a blocklist refuses a fingerprint that several distinct devices have reported).
\- country: ISO 3166-1 alpha-2 or alpha-3 (stored as alpha-3).
\- user, business: the vendor_data to block.
\- face, document, wallet_address, bank_account, key: any non-empty string.
Values are case-insensitive: country codes are stored in upper case, phone numbers in E.164, everything else in lower case.
A list holds each value once: adding a value that is already there returns 400.

Adding from a session, what Didit does:
\- Looks up the session (it must belong to the same application).
\- Reads the value from the session's most recent record of the list's entry_type:
\- face: the liveness face (value is the face UUID). With face_image_source = front_image_camera_front / back_image_camera_front, the face from the selfie the front camera took while the user photographed the front / back of their document instead (system face blocklist only, leave value empty).
\- document: the document number; full_name, issuing_state, document_type, region and document_number go into metadata.
\- phone / email: the phone number / email address.
\- ip_address: the session's IP address.
\- device_fingerprint: a fingerprint that identifies one device. On a blocklist, Didit refuses a session that only has a device-class fingerprint or was completed on more than one device; pass the exact fingerprint as value in that case.
\- Links the entry to the session (reference_session_id) and to that record (reference_object_uuid).
\- If I also send value, Didit stores my value but still links the most recent record. To list a value from an earlier record, add it by value without reference_session_id.

Example calls:
\# By value
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"value": "+14155552671", "comment": "Reported fraud"}'

\# From a session
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"reference_session_id": "33333333-4444-5555-6666-777777777777"}'

\# The face from the selfie taken during document capture (system face blocklist)
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"reference_session_id": "33333333-4444-5555-6666-777777777777", "face_image_source": "front_image_camera_front"}'

\# From a transaction
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"value": "0x52908400098527886E0F7030069857D2E4169EE7", "reference_object_uuid": "55555555-6666-7777-8888-999999999999", "metadata": {"reference_type": "transaction"}}'

Failure modes:
\- 400: value fails the entry_type validator or is already in the list, neither value nor reference_session_id was sent, reference_session_id is not a session of this application, or the session has no data of the list's entry_type.
\- 400 (face_image_source): the list is not the system face blocklist, value was sent, the session has no image for that source, no clear face was found in that selfie, or that selfie is already in the blocklist.
\- 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.
\- 404: list not found in this application ({ "detail": "List not found." }).
\- 503 (face_image_source): face analysis is temporarily unavailable; nothing was added, retry later.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects:
\- System face, document, phone and email blocklists: a record read from a session is flagged as blocklisted at once, and new sessions that match it are declined.
\- System user and business blocklists: users or businesses of the application whose vendor_data equals value (or whose UUID equals reference_object_uuid) are set to BLOCKED.
\- Sessions and transactions that already finished are not changed.

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

\
Colar em Adicione uma entrada a uma lista. O valor é validado de acordo com o tipo de entrada da lista:* **email**: um endereço de e-mail válido * **phone**: um número de telefone internacional válido, armazenado em E.164 (por exemplo `+14155552671`) * **ip\_address**: um endereço IP válido ou um intervalo CIDR (por exemplo `192.168.1.1` ou `10.0.0.0/8`) * **device\_fingerprint**: pelo menos 8 caracteres entre letras, algarismos, `-`, `_`, `:` e `.`. Uma lista de bloqueio recusa uma impressão digital que tenha sido reportada por vários dispositivos distintos, porque bloqueá-la recusaria pessoas sem relação entre si. * **country**: um [código de país ISO 3166-1 alfa-3](https://docs.didit.me/pt/core-technology/id-verification/supported-documents-id-verification.md) válido (por exemplo `USA`, `GBR`, `ESP`). Os códigos alfa-2 (por exemplo `US`) são aceites e convertidos automaticamente para alfa-3. * **user**, **business**: o `vendor_data` do utilizador ou da empresa * **face**, **document**, **wallet\_address**, **bank\_account**, **key**: qualquer cadeia de caracteres não vazia> [!NOTE] > > Todos os valores das entradas **não diferenciam maiúsculas de minúsculas**. Os valores que envia são normalizados no armazenamento (números de telefone para E.164, códigos de país para maiúsculas, tudo o resto para minúsculas) e comparados sem distinção entre maiúsculas e minúsculas durante a verificação. Por exemplo, bloquear `User@Example.COM` também deteta `user@example.com`. Uma lista guarda cada valor apenas uma vez: adicionar um valor que já está na lista devolve `400`.Para um rosto, use [Carregar rosto](https://docs.didit.me/pt/management-api/lists/upload-face.md) quando tiver apenas uma imagem, ou envie um `reference_session_id` para usar o rosto de uma sessão existente. Uma entrada de rosto precisa de um rosto armazenado contra o qual comparar, o que um `value` introduzido não fornece.## Adicionar a partir de uma sessãoQuando fornece um `reference_session_id`, a Didit:1) Procura a sessão (esta tem de pertencer à mesma aplicação) 2) Lê o valor do registo **mais recente** da sessão do tipo de entrada da lista: * **face**: o rosto da selfie de prova de vida; `value` é o UUID do rosto * **document**: o número do documento; o nome completo, o estado emissor, o tipo de documento, a região e o número do documento ficam armazenados em `metadata`, e `display_label` assume por predefinição o nome do titular e o número do documento * **phone**: o número de telefone * **email**: o endereço de e-mail * **ip\_address**: o endereço IP da sessão * **device\_fingerprint**: uma impressão digital que identifica um dispositivo, dando preferência a um dispositivo que tenha concluído um passo de verificação. Numa lista de bloqueio, a Didit recusa uma sessão que tenha apenas uma impressão digital de classe de dispositivo, ou uma concluída em mais do que um dispositivo: nesse caso, envie a impressão digital exata como `value`. 3) Associa a entrada à sessão (`reference_session_id`) e ao registo (`reference_object_uuid`) para rastreabilidadeNas listas de bloqueio de rosto, documento, telefone e e-mail do sistema, o registo fica também assinalado como bloqueado, pelo que as novas sessões que correspondam são recusadas. Para qualquer outro tipo de entrada, envie também `value`.Devolve `400` se a sessão não for encontrada ou não contiver dados do tipo de entrada pedido.### Rostos da selfie da captura do documentoEnquanto o utilizador fotografa o seu documento, a câmara frontal pode tirar-lhe uma selfie (as imagens `front_image_camera_front` e `back_image_camera_front` do [relatório de verificação de identidade](https://docs.didit.me/pt/core-technology/id-verification/report-id-verification.md)). Esse rosto pode ser adicionado também à lista de bloqueio de rostos, para além do rosto da prova de vida: envie `face_image_source` com a imagem que pretende.```json theme={null} { "reference_session_id": "33333333-4444-5555-6666-777777777777", "face_image_source": "front_image_camera_front" } ```- A entrada é criada apenas na **lista de bloqueio de rostos** do sistema, e `value` tem de ficar vazio: a Didit obtém o rosto a partir da selfie da sessão. - A selfie tem de conter um único rosto nítido. Caso contrário, o pedido devolve `400` e nada é adicionado. - Cada selfie só pode ser adicionada uma vez. Os campos `metadata.face_image_source` e `metadata.reference_node_id` indicam de que selfie provém a entrada. - Num fluxo com mais do que um passo de verificação de identidade, `reference_node_id` escolhe o passo cuja selfie é usada. Por predefinição, a Didit usa a verificação de identidade mais recente que tenha essa selfie. - A partir daí, o rosto é verificado como qualquer outro rosto da lista de bloqueio: contra a selfie de prova de vida de cada nova sessão e contra cada nova selfie da captura do documento (ver [`FRONT_CAMERA_FACE_IN_BLOCKLIST`](https://docs.didit.me/pt/core-technology/id-verification/warnings-id-verification)). - Eliminar a entrada remove o rosto da lista de bloqueio, e este deixa de corresponder a novas sessões.### Sessões com vários registos do mesmo tipoUma sessão pode ter mais do que um registo de um tipo, por exemplo dois números de telefone num fluxo de vários passos. A Didit lê sempre o **mais recente**. Se enviar `value` juntamente com `reference_session_id`, a entrada armazena o seu `value`, mas continua associada a esse registo mais recente e, numa lista de bloqueio do sistema, é esse o registo assinalado.Para adicionar um valor de um registo anterior, adicione-o apenas por `value`, sem `reference_session_id`:```json theme={null} { "value": "+34612345678", "comment": "First phone number of session 42" } ```## Referenciar transações, utilizadores e empresasAo colocar na lista de bloqueio dados de uma transação ou de um utilizador ou empresa do fornecedor, passe o UUID da entidade como `reference_object_uuid` e indique o tipo de origem em `metadata`:```json theme={null} { "value": "0x52908400098527886E0F7030069857D2E4169EE7", "reference_object_uuid": "55555555-6666-7777-8888-999999999999", "metadata": { "reference_type": "transaction", "reference_id": "55555555-6666-7777-8888-999999999999" } } ```Isto permite navegar desde a entrada da lista de bloqueio até à transação, utilizador ou empresa original na consola. A Didit armazena as chaves de `metadata` que envia, exceto `reference_image_url` e `front_image_url`, que só a Didit define. Para uma entrada lida de uma sessão, a Didit acrescenta as suas próprias chaves às suas, e as chaves da Didit prevalecem.| Entidade de origem | `reference_object_uuid` | `metadata.reference_type` | | - | - | - | | Sessão de verificação | Definido pela Didit (o registo de rosto, documento, telefone ou e-mail) | Não é necessário: use `reference_session_id` | | Transação | UUID da transação | `"transaction"` | | Utilizador do fornecedor | `didit_internal_id` | `"vendor_user"` | | Empresa do fornecedor | `didit_internal_id` | `"vendor_business"` |Nas listas de bloqueio do sistema **Utilizador** e **Empresa**, a Didit também define como `BLOCKED` os utilizadores ou empresas cujo `vendor_data` é igual a `value`, ou cujo `didit_internal_id` é igual a `reference_object_uuid`. Ver [Lista de bloqueio de utilizadores](https://docs.didit.me/pt/entities/users/blocklist.md) e [Lista de bloqueio de empresas](https://docs.didit.me/pt/entities/businesses/blocklist.md). ## OpenAPI ````yaml pt/openapi-25.json POST /v3/lists/{list_uuid}/entries/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/lists/{list_uuid}/entries/: post: tags: - Lists summary: Criar uma entrada na lista description: >- Adiciona uma entrada a uma lista através de uma de três formas: por `value`; a partir de uma sessão de verificação com `reference_session_id`, em que a Didit lê o valor a partir do registo mais recente da sessão do tipo de entrada da lista e associa-lhe a entrada; ou por `value` com um `reference_object_uuid` e `metadata.reference_type` que aponta para uma transação, utilizador ou empresa. Nas listas de bloqueio de rostos, documentos, telefones e e-mails do sistema, o registo lido da sessão é também sinalizado como incluído na lista de bloqueio, pelo que novas sessões correspondentes são recusadas; nas listas de bloqueio de utilizadores e empresas do sistema, os utilizadores ou empresas correspondentes são definidos como `BLOCKED`. As sessões e transações que já terminaram não são alteradas. Uma chave de API com âmbito necessita de `workflows: write`. Consulte [Criar uma entrada de lista](https://docs.didit.me/pt/management-api/lists/create-entry) para cada modo. operationId: create_list_entry parameters: - name: list_uuid in: path required: true description: >- UUID da lista à qual adicionar. Para um rosto do qual só tenha a imagem, utilize Carregar um rosto para uma lista. schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 requestBody: required: true content: application/json: schema: type: object description: >- Envie `value`, `reference_session_id` ou ambos. Os campos aplicáveis dependem do `entry_type` da lista. properties: value: type: string description: >- O valor a listar, validado relativamente ao `entry_type` da lista: `email` um endereço de e-mail válido; `phone` um número internacional válido, guardado em E.164; `ip_address` um endereço IP ou intervalo CIDR (por exemplo `10.0.0.0/8`); `device_fingerprint` pelo menos 8 carateres entre letras, dígitos, `-`, `_`, `:` e `.` (uma lista de bloqueio recusa uma fingerprint que vários dispositivos distintos tenham reportado); `country` um código ISO 3166-1 alfa-2 ou alfa-3, guardado como alfa-3; `user` e `business` o `vendor_data`; qualquer outro tipo uma cadeia não vazia. Guardado em minúsculas, exceto números de telefone e códigos de país, e uma lista contém cada valor apenas uma vez (não sensível a maiúsculas/minúsculas). Obrigatório exceto se `reference_session_id` for enviado; deve ser deixado em branco com um `face_image_source` de captura de documentos. reference_session_id: type: string format: uuid description: >- Uma sessão de verificação de pessoa ou empresa da sua aplicação da qual obter o valor. A Didit lê o registo mais recente da sessão do tipo de entrada da lista (`face`, `document`, `phone`, `email`, `ip_address` ou `device_fingerprint`), associa a entrada à sessão e a esse registo, e preenche `display_label` e `metadata` para documentos. Para uma lista de bloqueio de `device_fingerprint`, uma sessão que apenas tenha uma impressão digital de classe de dispositivo, ou que tenha sido concluída em mais de um dispositivo, é recusada: envie a impressão digital exata como `value`. Para outros tipos de entrada, ou quando a sessão não tiver tal registo, envie também `value`; o seu `value` é então armazenado e a entrada continua associada à sessão. reference_object_uuid: type: string format: uuid description: >- UUID do registo que a entrada representa quando não provém de uma sessão: um UUID de transação, ou o `didit_internal_id` de um utilizador ou empresa. Combine-o com `metadata.reference_type`. Substituído pelo registo da sessão quando `reference_session_id` fornece um. face_image_source: type: string enum: - liveness - front_image_camera_front - back_image_camera_front default: liveness description: >- Listas de rostos com `reference_session_id`: de qual das imagens da sessão o rosto é retirado. `liveness` (predefinição) é a selfie de prova de vida. `front_image_camera_front` e `back_image_camera_front` são as selfies que a câmara frontal tirou enquanto o utilizador fotografava a frente ou o verso do seu documento: aceites apenas na lista de bloqueio de rostos do sistema, com `reference_session_id` e um `value` vazio. Cada selfie pode ser adicionada uma vez e deve mostrar um rosto nítido. reference_node_id: type: string nullable: true maxLength: 100 description: >- Com um `face_image_source` de captura de documento: o nó de verificação de identidade cuja selfie deve ser utilizada, para fluxos com mais de um. O valor padrão é a verificação de identidade mais recente que tenha essa imagem. Recusado com `liveness`. display_label: type: string maxLength: 512 description: >- Rótulo legível. Quando vazio, a Didit deriva um a partir da sessão sempre que possível (por exemplo, o nome do titular e o número do documento). comment: type: string description: Nota em texto livre, como o motivo da inclusão na lista. metadata: type: object additionalProperties: true description: >- JSON de formato livre armazenado com a entrada e devolvido tal como foi guardado. Utilize `reference_type` e `reference_id` para que a consola estabeleça uma ligação para a origem. `reference_image_url` e `front_image_url` são definidos apenas pela Didit e são descartados se os enviar. Para uma entrada lida a partir de uma sessão, as chaves da Didit são combinadas com as suas. properties: reference_type: type: string enum: - transaction - vendor_user - vendor_business description: A que se refere `reference_object_uuid`. reference_id: type: string description: Identificador do registo de origem. examples: By value: value: value: '+14155552671' comment: Reported fraud From a session: value: reference_session_id: 33333333-4444-5555-6666-777777777777 Face from a document-capture selfie: value: reference_session_id: 33333333-4444-5555-6666-777777777777 face_image_source: front_image_camera_front From a transaction: value: value: '0x52908400098527886E0F7030069857D2E4169EE7' reference_object_uuid: 55555555-6666-7777-8888-999999999999 comment: Linked to a chargeback metadata: reference_type: transaction reference_id: 55555555-6666-7777-8888-999999999999 Country: value: value: PRK comment: Sanctioned jurisdiction responses: '201': description: A entrada foi criada. content: application/json: schema: $ref: '#/components/schemas/ComplianceListEntry' examples: By value: value: uuid: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee value: '+14155552671' display_label: '' comment: Reported fraud added_by: api reference_session_id: null reference_session_number: null reference_session_type: null reference_object_uuid: null metadata: null created_at: '2026-10-12T10:04:51.220391Z' Document from a session: value: uuid: bbbbbbbb-cccc-dddd-eeee-ffffffffffff value: X1234567 display_label: Jane Doe - X1234567 comment: '' added_by: api reference_session_id: 33333333-4444-5555-6666-777777777777 reference_session_number: 1042 reference_session_type: kyc reference_object_uuid: 66666666-7777-8888-9999-000000000000 metadata: full_name: Jane Doe issuing_state: ESP document_type: ID region: '' document_number: X1234567 created_at: '2026-10-12T10:06:12.774915Z' From a transaction: value: uuid: dddddddd-eeee-ffff-0000-111111111111 value: '0x52908400098527886e0f7030069857d2e4169ee7' display_label: '' comment: Linked to a chargeback added_by: api reference_session_id: null reference_session_number: null reference_session_type: null reference_object_uuid: 55555555-6666-7777-8888-999999999999 metadata: reference_type: transaction reference_id: 55555555-6666-7777-8888-999999999999 created_at: '2026-10-12T10:20:40.117062Z' '400': description: >- O corpo é inválido, o valor já existe na lista ou a sessão não pode fornecer o valor. content: application/json: examples: Nothing to list: value: value: - >- Either 'value' or 'reference_session_id' must be provided. Duplicate value: value: value: - An entry with this value already exists in this list. Invalid phone: value: value: - >- Invalid phone number. Provide a valid international number (e.g. +1234567890). Invalid IP: value: value: - >- Invalid IP address or CIDR range (e.g. 192.168.1.1 or 10.0.0.0/24). Invalid country: value: value: - >- Invalid country code: XX. Provide a valid ISO 3166-1 alpha-2 or alpha-3 country code. Device-class fingerprint: value: value: - >- This value is a device-class fingerprint: several distinct devices have reported it, so blocklisting it would decline unrelated people. Block the user by document, face, email or phone instead. Unknown session: value: reference_session_id: - >- Session not found or does not belong to this application. No data in session: value: value: - >- Either provide a 'value' or ensure the session contains data for this entry type. Selfie on another list: value: face_image_source: - >- A document-capture selfie can only be added to the face blocklist. No clear face in selfie: value: face_image_source: - >- No clear face was found in this selfie, so it cannot be blocklisted. Selfie already listed: value: face_image_source: - This selfie is already in the blocklist. '401': description: >- A chave de API com âmbito expirou. Outras falhas de autenticação devolvem `403`. content: application/json: examples: Expired API key: value: detail: This API key has expired. '403': description: >- O cabeçalho `x-api-key` está em falta (uma chave errada, revogada ou expirada recebe `401`), ou uma chave de API com âmbito não tem `workflows: write` ou é utilizada a partir de um endereço IP fora da sua lista de permissões. 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. '404': description: >- Não existe nenhuma lista com este UUID na aplicação da chave de API, ou foi eliminada. content: application/json: examples: Not found: value: detail: List not found. '429': $ref: '#/components/responses/RateLimitedWrite' '503': description: >- A análise facial de uma selfie de captura de documento está temporariamente indisponível. Nada foi adicionado; tente novamente mais tarde. content: application/json: examples: Unavailable: value: detail: Service temporarily unavailable. Please try again later. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X POST 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"value": "+14155552671", "comment": "Reported fraud"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.lists.entries.create( "11111111-2222-3333-4444-555555555555", value="+14155552671", comment="Reported fraud", ) 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.entries.create("11111111-2222-3333-4444-555555555555", { value: "+14155552671", comment: "Reported fraud", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Entries.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesCreateParams{\n\tValue: didit.String(\"+14155552671\"),\n\tComment: didit.String(\"Reported fraud\"),\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.ListsEntriesCreateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.lists().entries().create("11111111-2222-3333-4444-555555555555", ListsEntriesCreateParams.builder() .value("+14155552671") .comment("Reported fraud") .build()); System.out.println(result); - lang: php label: PHP source: >- lists->entries->create('11111111-2222-3333-4444-555555555555', [ 'value' => '+14155552671', 'comment' => 'Reported fraud', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.lists.entries.create( "11111111-2222-3333-4444-555555555555", value: "+14155552671", comment: "Reported fraud" ) 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.Entries.CreateAsync("11111111-2222-3333-4444-555555555555", new ListsEntriesCreateParams { Value = "+14155552671", Comment = "Reported fraud", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: ComplianceListEntry: type: object description: Um valor numa lista. required: - uuid - value - display_label - comment - added_by - reference_session_id - reference_session_number - reference_session_type - reference_object_uuid - metadata - created_at properties: uuid: type: string format: uuid description: >- Identificador da entrada. Utilize-o como `entry_uuid` em Eliminar uma entrada da lista. value: type: string description: >- O valor listado: um número de telefone em E.164, um endereço de e-mail, um número de documento, um endereço IP ou intervalo CIDR, uma impressão digital do dispositivo, um endereço de carteira, uma conta bancária, um código de país ISO 3166-1 alfa-3, um `vendor_data`, qualquer cadeia de carateres numa lista de `key`, ou o UUID do rosto armazenado numa lista de rostos. Os valores que envia são armazenados em minúsculas, exceto números de telefone e códigos de país. A correspondência não diferencia maiúsculas de minúsculas. display_label: type: string nullable: true maxLength: 512 description: >- Rótulo legível. A Didit preenche-o para entradas obtidas de uma sessão (por exemplo, o nome do titular e o número do documento) quando não envia nenhum. comment: type: string description: Nota em texto livre. String vazia quando não definida. added_by: type: string nullable: true description: >- Quem adicionou a entrada: `api` (uma chave de API), o endereço de e-mail de um utilizador da consola ou `console`, `system` ou `migration` (entradas criadas pela Didit), ou `rule` (uma ação de regra de transação ou de monitorização). reference_session_id: type: string format: uuid nullable: true description: >- Sessão de verificação da qual a entrada foi retirada. `null` quando a entrada foi adicionada por valor. reference_session_number: type: integer nullable: true description: >- Número dessa sessão no âmbito da aplicação, como mostrado na consola. reference_session_type: type: string nullable: true enum: - kyc - kyb - null description: >- `kyc` para uma sessão de verificação de pessoa, `kyb` para uma sessão de verificação de empresa, `null` quando não existe sessão. reference_object_uuid: type: string format: uuid nullable: true description: >- O registo que a entrada representa: o registo de rosto, documento, telefone ou e-mail lido a partir de uma sessão, o rosto criado por Carregar um rosto para uma lista, ou o UUID que enviou (por exemplo, o UUID de uma transação ou o `didit_internal_id` de um utilizador). metadata: type: object nullable: true additionalProperties: true description: >- Contexto adicional. Contém as chaves definidas pela Didit (aqui listadas) combinadas com quaisquer `metadata` que tenha enviado ao criar a entrada, devolvidas conforme armazenadas. `null` quando não existir nenhum. properties: reference_image_url: type: string description: >- Entradas de rosto: URL assinado de curta duração, emitido novamente a cada chamada; `null` para uma chave de API com âmbito sem `media: read`. Ausente quando não existir nenhuma imagem associada à entrada. front_image_url: type: string description: >- Entradas de documentos que contêm uma imagem da frente do documento: URL assinado de curta duração, emitido novamente a cada chamada; `null` para uma chave de API com âmbito restrito sem `media: read`. full_name: type: string description: >- Entradas de documentos obtidas de uma sessão: nome completo do titular. issuing_state: type: string description: >- Entradas de documentos obtidas de uma sessão: país emissor ISO 3166-1 alfa-3. document_type: type: string description: >- Entradas de documentos obtidas de uma sessão: código do tipo de documento, por exemplo `P`, `ID` ou `DL`. region: type: string description: >- Entradas de documentos obtidas de uma sessão: estado ou província de emissão de um documento emitido regionalmente, vazio quando não aplicável. Não definido por Adicionar itens da sessão à lista de bloqueio. document_number: type: string description: >- Entradas de documentos obtidas de uma sessão: o número do documento. face_image_source: type: string enum: - front_image_camera_front - back_image_camera_front description: >- Entradas de rosto obtidas a partir de uma selfie de captura de documento: qual é a selfie. Ausente para rostos de prova de vida. reference_node_id: type: string nullable: true description: >- Entradas de rosto obtidas a partir de uma selfie de captura de documento: o nó de Verificação de identidade de onde a selfie teve origem. fingerprint_tier: type: string nullable: true enum: - persistent_id - composite_hash - legacy_fp - unknown - null description: >- Entradas da impressão digital do dispositivo recolhidas de uma sessão: como a impressão digital foi obtida. O `persistent_id` identifica um dispositivo; o `composite_hash` e o `legacy_fp` podem ser partilhados por dispositivos do mesmo modelo. sandbox: type: boolean description: >- `true` numa entrada facial carregada numa aplicação de sandbox; essa entrada não corresponde a nada. reference_type: type: string enum: - transaction - vendor_user - vendor_business description: >- Definido por si: para o que aponta `reference_object_uuid`, para que a consola possa criar uma ligação para o mesmo. reference_id: type: string description: 'Definido por si: identificador do registo de origem.' created_at: type: string format: date-time description: Quando a entrada foi adicionada. responses: RateLimitedWrite: description: >- O limite de escrita partilhado de 300 pedidos por minuto por chave de API foi excedido. Respeite o `Retry-After` antes de tentar novamente. 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: >- A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.