Saltar al contingut principal
PATCH
cURL
Utilitza PATCH per a les actualitzacions parcials. Per canviar el nom d’un flux de treball, envia només workflow_label.
Per canviar les comprovacions del flux de treball, envia la matriu features completa que vols. Això substitueix l’ordre i la configuració de les funcionalitats anteriors.
La v3 de l’API manté els fluxos de treball senzills: un camí lineal i un únic pas d’estat final. No s’accepten bifurcacions, nodes d’acció ni nodes de webhook.

Referència de configuració de les funcionalitats

Quan envies features en un PATCH, la matriu substitueix l’ordre i la configuració de les funcionalitats anteriors. Torna a incloure tota la configuració obligatòria. L’objecte config exacte depèn de la funcionalitat. Consulta la llista completa de camps, els valors per defecte, la configuració obligatòria, els intervals de valors i els exemples a Configuracions de les funcionalitats del flux de treball. Per a OCR, omet config.documents_allowed, envia null o envia {} per permetre tots els tipus de document compatibles. Inclou-lo només si vols restringir el flux de treball a països o tipus de document concrets. Per a QUESTIONNAIRE, config.questionnaire_uuid és obligatori.

Actualització de la configuració del flux de treball

Pots actualitzar la configuració a nivell de sessió sense tocar la llista de funcionalitats. Envia només els camps que vols canviar.
Utilitza el uuid del flux de treball que retorna l’endpoint de llista, de creació o d’obtenció com a settings_uuid en aquesta URL.

Autoritzacions

x-api-key
string
header
requerit

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.

Paràmetres de ruta

settings_uuid
string<uuid>
requerit

UUID per versió del flux de treball que s'actualitzarà.

Cos

application/json

Actualitza les metadades del flux de treball o substitueix la llista lineal completa de funcionalitats. Llista blanca de camps ESTRICTA: qualsevol clau no indicada aquí es rebutja amb un 400.

workflow_label
string

Nom visible per al flux de treball (màxim 50 caràcters).

Maximum string length: 50
is_default
boolean

Estableix aquest flux de treball com a predeterminat per a les noves sessions.

status
enum<string>

Controla el versionat. Omet-ho per actualitzar la versió actual directament (els esborranys es publiquen automàticament). published en una versió ja publicada crea i retorna una NOVA versió. draft només és vàlid mentre la versió encara sigui un esborrany.

Opcions disponibles:
draft,
published
features
object[]

Si es proporciona, això substitueix l'ordre i la configuració completes de les funcionalitats.

Minimum array length: 1
is_white_label_enabled
boolean

Habilita la personalització de marca blanca per a les sessions creades amb aquest flux de treball.

is_desktop_allowed
boolean

Permet que el flux de verificació s'executi en navegadors d'escriptori.

max_retry_attempts
integer

Nombre màxim d'intents de reintent permesos després d'una verificació rebutjada. 0 bloqueja l'usuari després del primer rebuig.

Rang requerit: 0 <= x <= 10
retry_window_days
integer | null

Finestra mòbil en dies utilitzada per comptar els reintents. null aplica un límit per a tot l'historial.

Rang requerit: 1 <= x <= 365
face_liveness_max_attempts
integer

Nombre màxim d'enviaments de prova de vida per sessió. Aquest valor també es copia als nodes generats del flux de treball de prova de vida i estimació d'edat tret que la configuració a nivell de funcionalitat el sobreescrigui.

Rang requerit: 1 <= x <= 3
face_match_max_attempts
integer

Nombre màxim d'enviaments de coincidència facial per sessió. Aquest valor també es copia als nodes generats del flux de treball de coincidència facial tret que la configuració a nivell de funcionalitat el sobreescrigui.

Rang requerit: 1 <= x <= 3
session_expiration_time
integer

Segons abans que caduqui una sessió no finalitzada. Mínim 1 hora (3600), màxim 4 setmanes (2419200).

Rang requerit: 3600 <= x <= 2419200

Resposta

Flux de treball actualitzat. El cos és la configuració COMPLETA de la versió resultant (la mateixa estructura VerificationSettings en brut que GET /v3/workflows/{settings_uuid}/). Quan l'actualització crea una nova versió (s'ha enviat status: "published" en una fila publicada), l'uuid i la version retornats difereixen dels que has modificat; utilitza l'uuid retornat per a les crides posteriors.

Els camps següents estan tipats; l'objecte també conté la resta de columnes de la configuració del flux de treball (commutadors de funcionalitats, llindars, accions d'advertència, documents permesos, callbacks) com a propietats addicionals. Els camps que no s'apliquen al workflow_type són null.

uuid
string<uuid>

Identificador per versió (settings_uuid). Cada versió d'un flux de treball té el seu propi identificador.

workflow_id
string<uuid>

Identificador estable compartit per totes les versions del flux de treball. Les sessions creades amb aquest identificador utilitzen l'última versió publicada.

workflow_label
string

Nom visible del flux de treball.

workflow_type
enum<string> | null

Plantilla de flux de treball. null per a fluxos de treball basats en grafs creats sense plantilla.

Opcions disponibles:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
is_default
boolean

Si aquest és el flux de treball per defecte de l'aplicació.

is_archived
boolean

Els fluxos de treball arxivats no poden iniciar noves sessions.

version
integer

Número de versió dins del flux de treball.

status
enum<string>

Les versions en esborrany són editables; les versions publicades són immutables i s'utilitzen per a noves sessions.

Opcions disponibles:
draft,
published
published_at
string<date-time> | null

Quan es va publicar aquesta versió. null per a esborranys.

is_simple_workflow
boolean

true quan el flux de treball no té cap workflow_graph personalitzat.

is_editable
boolean

true només per a versions draft.

workflow_url
string<uri>

URL pública que inicia una sessió amb aquest flux de treball.

workflow_graph
object | null

Estructura del graf del flux de treball (nodes i arestes). null per a fluxos de treball simples.

features
string

Funcionalitats habilitades unides amb " + ", per exemple "OCR + LIVENESS".

total_price
number | null

Preu per sessió; per als fluxos de treball amb graf, el camí més car.

min_price
number | null

Preu del camí més econòmic a través del flux de treball.

max_price
number | null

Preu del camí més car a través del flux de treball.

special_add_on_prices
object | null

Preus de complements específics de l'organització, o null si no n'hi ha cap de definit.

max_retry_attempts
integer

Reintents permesos després d'una verificació rebutjada.

retry_window_days
integer | null

Dies durant els quals es permeten els reintents.

session_expiration_time
integer

Segons abans que caduqui una sessió no finalitzada.

questionnaire
object | null

El qüestionari adjunt al flux de treball, o null.

kyb_role_settings
object[]

Configuració de verificació per rol per a persones clau de KYB.

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

Quins nivells de signatura electrònica poden signar ara mateix. Comprova-ho abans d'establir signature_level. Es retorna en fluxos de treball kyc, kyb i de graf.

is_bank_verification_enabled
boolean

Indica si un flux de treball senzill de KYC o KYB executa la verificació bancària. S'executa després dels passos de contacte (i la verificació d'ubicació) i abans de la validació en bases de dades, l'anàlisi AML i l'anàlisi d'IP. La verificació bancària encara no està disponible de manera general: activar-la es rebutjarà allà on no estigui habilitada.

bank_verification_config
object

Configuració de verificació bancària d'un flux de treball simple, amb les mateixes claus que accepta un node BANK_VERIFICATION (per exemple bank_countries i bank_method_order). Les claus desconegudes es descarten. Cada clau és opcional i una clau absent manté el seu valor per defecte, de manera que {} indica tots els valors per defecte. Consulta Configuració de verificació bancària.

Exemple:
is_geolocation_enabled
boolean

Indica si un flux de treball senzill de KYC executa la verificació d'ubicació. S'executa després dels passos de contacte i abans de la verificació bancària i la validació en bases de dades. Els fluxos de treball d'empreses (KYB) no la poden executar.

geolocation_config
object

Configuració de verificació d'ubicació d'un flux de treball simple, amb les mateixes claus que accepta un node GEOLOCATION (per exemple, is_geolocation_geofencing_enabled i geolocation_max_attempts). S'ometen les claus desconegudes. Totes les claus són opcionals i una clau absent manté el seu valor per defecte, de manera que {} implica tots els valors per defecte.

Exemple:
Darrera modificació el 7 de novembre del 2026