> ## 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.
# Afegir imatges a una sessió (API)
> Afegeix a Didit una imatge o PDF extra al resultat d'una sessió KYC finalitzada, per exemple el revers d'un document o un comprovant de domicili.
Afegeix imatges a una indicació de l'API de sessió
Copia el prompt al porta-retalls
\`Attach an extra image or PDF to a finished Didit User Verification (KYC) session through the API.
Endpoint:
PATCH [https://verification.didit.me/v3/session/\{session\_id}/add-images/](https://verification.didit.me/v3/session/\{session_id}/add-images/)
Authentication:
Send my Didit API key in the x-api-key header. A scoped key needs sessions: write.
Goal:
* Add evidence collected outside the verification flow (for example the back of an ID document, or a supporting letter) to the session's ID verification or Proof of Address result, so reviewers see it with the rest of the session.
Request (multipart/form-data):
* file (required): JPG, JPEG, PNG, WEBP, TIFF or PDF, at most 15 MB as uploaded. Didit compresses it and rejects it if it is still over 2 MB (2,097,152 bytes) after compression.
* model\_type (required): "kyc" for the ID verification, "poa" for the Proof of Address.
* file\_password (optional): the password of an encrypted PDF.
Behavior:
* The session must be Approved, Declined, In Review or Kyc Expired, and must have the result named by model\_type. Business (KYB) sessions are not supported.
* When the step ran more than once, the file goes to the most recent result.
* Each call adds one file and keeps the existing ones.
* The file then appears in extra\_files of id\_verifications\[] or poa\_verifications\[] in GET /v3/session/{session_id}/decision/.
* A FILE\_ADDED entry is added to the session's activity log. No webhook is sent and the session status does not change.
* Rate limit: 10 requests per minute per API key.
Example call:
curl -X PATCH "[https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/add-images/](https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/add-images/)" \
-H "x-api-key: YOUR\_API\_KEY" \
-F "file=@back-of-id.jpg" \
-F "model\_type=kyc"
What to read from the response:
* extra\_files: short-lived presigned links to every extra file of that result, including the new one. A scoped key without media: read receives them as null.
Failure modes:
* 400: file or model\_type missing, unsupported format, file too large before or after compression, encrypted PDF without the right file\_password.
* 401: the API key has expired.
* 403: missing key (a wrong, revoked or expired key gets 401), a key of another application, a scoped key without sessions: write, or a request from outside the key's IP allowlist.
* 404: the session does not exist, was deleted, is outside a scoped key's limits, is not in a reviewable status, or has no result of that model\_type.
* 429: more than 10 calls in a minute. Wait for Retry-After seconds.
Side effects: stores the file with the session and adds an activity entry.
For the full integration shape, see /integration/integration-prompt.\`
Enganxa a
Els enllaços presignats de `extra_files` caducen. Quan necessitis els fitxers més endavant, llegeix-ne de nous des de la [decisió de la sessió](https://docs.didit.me/ca/sessions-api/retrieve-session.md). En canvi, per corregir les dades extretes d'un document, utilitza [Actualitza les dades de la sessió](https://docs.didit.me/ca/sessions-api/update-data.md).
## OpenAPI
````yaml ca/openapi-25.json PATCH /v3/session/{sessionId}/add-images/
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/session/{sessionId}/add-images/:
patch:
tags:
- Sessions
summary: Afegeix una imatge a una sessió
description: >-
Adjunta una imatge o un PDF addicional al resultat de Verificació
d'identitat (`model_type=kyc`) o de Comprovant de domicili
(`model_type=poa`) d'una sessió finalitzada de Verificació d'usuaris
(KYC), per exemple proves recollides fora del flux. La sessió ha d'estar
en estat `Approved`, `Declined`, `In Review` o `Kyc Expired` i incloure
el resultat indicat per `model_type`; les sessions de Verificació
d'empreses (KYB) no són compatibles. Cada crida afegeix un fitxer (al
resultat més recent quan el pas s'ha executat més d'una vegada), manté
els fitxers existents i registra una entrada `FILE_ADDED` al registre
d'activitat de la sessió; la pujada no envia cap webhook ni canvia
l'estat de la sessió. El fitxer es comprimeix durant la pujada i es
retorna a `extra_files` de la decisió de la sessió. Aquest endpoint està
limitat a 10 sol·licituds per minut per clau d'API. Una clau d'API amb
abast restringit necessita `sessions: write`, i sense `media: read` rep
els enllaços d'`extra_files` com a `null`.
operationId: patch_v3_session_add_images
parameters:
- name: sessionId
in: path
required: true
description: >-
UUID de la sessió de Verificació d'usuaris (KYC) a la qual s'ha
d'afegir el fitxer (el `session_id` retornat per `POST
/v3/session/`). Un ID de sessió de Verificació d'empreses (KYB)
retorna `404`.
schema:
type: string
format: uuid
example: 11111111-2222-3333-4444-555555555555
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- file
- model_type
properties:
file:
type: string
format: binary
description: >-
La imatge o PDF. Extensions permeses: `jpg`, `jpeg`, `png`,
`webp`, `tiff`, `pdf`. Com a màxim 15 MB en pujar-la;
posteriorment el fitxer es comprimeix i es rebutja amb un
error `400` si encara supera els 2 MB (2.097.152 bytes). Els
fitxers buits es rebutgen.
model_type:
type: string
enum:
- kyc
- poa
description: >-
`kyc` afegeix el fitxer al resultat de Verificació
d'identitat, `poa` al resultat de Comprovant de domicili.
example: kyc
file_password:
type: string
description: >-
Contrasenya d'un PDF xifrat. Sense ella, o amb una
d'incorrecta, un PDF xifrat retorna `400`.
example:
file: (binary)
model_type: kyc
responses:
'200':
description: >-
Fitxer afegit. Retorna tots els fitxers addicionals d'aquest
resultat, inclòs el nou.
content:
application/json:
schema:
type: object
required:
- extra_files
properties:
extra_files:
type: array
description: >-
Enllaços presignats de curta durada a tots els fitxers
addicionals del resultat anomenat per `model_type`, del
més antic al més recent. Cada enllaç és `null` per a una
clau d'API d'abast limitat sense `media: read`. Llegeix
enllaços actualitzats des de la decisió de la sessió més
endavant.
items:
type: string
format: uri
nullable: true
example:
extra_files:
- >-
https://media.example.com/session/11111111-2222-3333-4444-555555555555/kyc-extra-files/66666666-7777-8888-9999-000000000000.jpg?expires=1789383731&signature=abc123
'400':
description: >-
Error de validació. Els errors de camp arriben com a `{"":
[""]}`; els errors de PDF xifrat com a `{"detail": "..."}`.
content:
application/json:
examples:
Missing file:
summary: No hi ha cap part de fitxer al formulari
value:
file:
- No file was submitted.
Missing model_type:
summary: model_type omès
value:
model_type:
- This field is required.
Invalid model_type:
summary: model_type no és kyc o poa
value:
model_type:
- '"passport" is not a valid choice.'
File too large:
summary: Pujada de més de 15 MB
value:
file:
- File size should not exceed 15 MB
Too large after compression:
summary: Encara supera els 2 MB després de la compressió
value:
file:
- File size is too big. Max allowed size is 2097152 bytes.
Encrypted PDF:
summary: PDF xifrat sense file_password
value:
detail: >-
The PDF is encrypted. Please upload a decrypted PDF or a
photo instead.
Wrong PDF password:
summary: file_password no obre el PDF
value:
detail: >-
The PDF password is incorrect. Please provide the correct
password.
'401':
description: >-
La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna
`401`: una clau absent, no vàlida o revocada retorna `403`.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Missatge d'error fàcil de llegir.
examples:
Expired key:
summary: La data de caducitat de la clau ha passat
value:
detail: This API key has expired.
'403':
description: >-
Fallada d'autenticació o d'autorització. Si falta la clau es retorna
`403`, igual que amb una clau d'una altra aplicació, una clau amb
àmbit sense el permís que necessita aquest endpoint o una
sol·licitud des de fora de la llista d'adreces IP permeses de la
clau; una clau incorrecta, revocada o caducada retorna `401`.
Distingeix-les pel camp `detail`.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Missatge d'error fàcil de llegir.
examples:
Missing or invalid credentials:
summary: >-
Falta la capçalera x-api-key, o la clau ha fallat la
validació
value:
detail: >-
Authentication credentials were not provided or are
invalid.
Other application:
summary: >-
Una clau vàlida que pertany a una aplicació diferent de la
de la sessió
value:
detail: You do not have permission to perform this action.
Scoped key without sessions write:
summary: >-
A la clau amb abast li manca el permís d'escriptura de
sessions
value:
detail: This API key has no write access to sessions.
IP not allowed:
summary: >-
Sol·licitud des de fora de la llista d'adreces IP permeses
de la clau
value:
detail: This API key can't be used from this IP address.
'404':
description: >-
La sessió no existeix, s'ha suprimit o queda fora dels límits d'una
clau amb abast limitat; és una sessió KYB o no està en `Approved`,
`Declined`, `In Review` o `Kyc Expired`; o no té cap resultat del
`model_type` sol·licitat (comprovat abans de validar el fitxer). La
cerca de la sessió s'executa abans de comprovar les credencials, de
manera que un `sessionId` desconegut retorna `404` fins i tot sense
una clau vàlida.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Missatge d'error fàcil de llegir.
examples:
Unknown session:
summary: No existeix cap sessió amb aquest ID, o s'ha suprimit
value:
detail: Not found.
Outside key limits:
summary: >-
La sessió queda fora dels límits del flux de treball o dels
límits que només permeten sessions aprovades d'una clau amb
abast limitat
value:
detail: Session not found.
Not eligible:
summary: >-
La sessió encara no ha finalitzat, o és un ID de sessió de
KYB
value:
detail: No Session matches the given query.
No ID verification:
summary: model_type=kyc en una sessió sense Verificació d'identitat
value:
detail: The session does not have KYC data.
No Proof of Address:
summary: model_type=poa en una sessió sense Comprovant de domicili
value:
detail: The session does not have POA data.
'429':
description: >-
S'ha superat el límit de freqüència: 10 sol·licituds per afegir
imatges per minut per clau d'API (les sol·licituds rebutjades també
compten). El pressupost compartit de 300 sol·licituds d'escriptura
per minut també s'aplica. Espera els segons indicats a `Retry-After`
abans de reintentar; les capçaleres `X-RateLimit-*` mostren el
pressupost restant.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Missatge d'error fàcil de llegir.
examples:
Rate limited:
summary: Pressupost per al minut actual esgotat
value:
detail: >-
Session add-images rate limit exceeded. You can make up to
10 requests per minute.
headers:
Retry-After:
description: Segons que cal esperar abans de reintentar.
schema:
type: integer
minimum: 1
example: 30
'503':
$ref: '#/components/responses/DocumentProcessingBusy'
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: >-
curl -X PATCH
'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/add-images/'
\
-H 'x-api-key: YOUR_API_KEY' \
-F 'file=@./back-of-id.jpg' \
-F 'model_type=kyc'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.add_images(
"11111111-2222-3333-4444-555555555555",
file=open("image.jpg", "rb"),
model_type="kyc",
)
print(result)
- lang: javascript
label: Node.js
source: >-
import Didit, { fileFromPath } from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await
didit.sessions.addImages("11111111-2222-3333-4444-555555555555", {
file: await fileFromPath("image.jpg"),
model_type: "kyc",
});
console.log(result);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.AddImages(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsAddImagesParams{\n\tFile: didit.FileFromPath(\"image.jpg\"),\n\tModelType: \"kyc\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
import java.nio.file.Path;
import me.didit.Didit;
import me.didit.types.SessionsAddImagesParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result =
client.sessions().addImages("11111111-2222-3333-4444-555555555555",
SessionsAddImagesParams.builder()
.file(Path.of("image.jpg"))
.modelType(SessionsAddImagesParams.ModelType.of("kyc"))
.build());
System.out.println(result);
- lang: php
label: PHP
source: >-
sessions->addImages('11111111-2222-3333-4444-555555555555',
[
'file' => File::fromPath('image.jpg'),
'model_type' => 'kyc',
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.add_images(
"11111111-2222-3333-4444-555555555555",
file: Pathname("image.jpg"),
model_type: "kyc"
)
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.Sessions.AddImagesAsync("11111111-2222-3333-4444-555555555555",
new SessionsAddImagesParams
{
File = FileUpload.FromPath("image.jpg"),
ModelType = "kyc",
});
Console.WriteLine(JsonSerializer.Serialize(result));
components:
responses:
DocumentProcessingBusy:
description: >-
Ara mateix s'estan processant massa documents, de manera que aquesta
càrrega no s'ha processat: no s'ha emmagatzemat res i no s'ha consumit
cap intent. Torna a enviar el mateix fitxer després del nombre de segons
indicat a `Retry-After`. Bifurca segons `code`, no segons el text del
missatge.
headers:
Retry-After:
description: >-
Nombre de segons que cal esperar abans de tornar a enviar la mateixa
sol·licitud.
schema:
type: integer
example: 10
content:
application/json:
schema:
type: object
required:
- detail
- code
properties:
detail:
type: string
code:
type: string
enum:
- document_processing_busy
example:
detail: We are busy processing documents. Please try again in a moment.
code: document_processing_busy
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.