curl -X PATCH 'https://verification.didit.me/v3/questionnaires/11111111-2222-3333-4444-555555555555/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"title": "Updated Customer Onboarding"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.questionnaires.update(
"11111111-2222-3333-4444-555555555555",
title="Updated Customer Onboarding",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.questionnaires.update("11111111-2222-3333-4444-555555555555", {
title: "Updated Customer Onboarding",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Questionnaires.Update(ctx, "11111111-2222-3333-4444-555555555555", didit.SimpleQuestionnaireUpdateRequest{
Title: didit.String("Updated Customer Onboarding"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.SimpleQuestionnaireUpdateRequest;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.questionnaires().update("11111111-2222-3333-4444-555555555555", SimpleQuestionnaireUpdateRequest.builder()
.title("Updated Customer Onboarding")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->questionnaires->update('11111111-2222-3333-4444-555555555555', [
'title' => 'Updated Customer Onboarding',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.questionnaires.update(
"11111111-2222-3333-4444-555555555555",
title: "Updated Customer Onboarding"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Questionnaires.UpdateAsync("11111111-2222-3333-4444-555555555555", new SimpleQuestionnaireUpdateRequest
{
Title = "Updated Customer Onboarding",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"questionnaire_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"languages": [
"<string>"
],
"default_language": "<string>",
"is_active": true,
"is_simple_questionnaire": true,
"graph": {},
"sections": [
{}
],
"questionnaire_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"status": "draft",
"published_at": "2023-11-07T05:31:56Z",
"is_editable": true
}{
"detail": "You do not have permission to perform this action."
}Fragebogen-API aktualisieren: KYC-Formular bearbeiten
Mit der Didit-API einen KYC-Fragebogen bearbeiten: umbenennen, geordnete Fragen ersetzen und mehrsprachige Labels aktualisieren. Pay-per-Call.
curl -X PATCH 'https://verification.didit.me/v3/questionnaires/11111111-2222-3333-4444-555555555555/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"title": "Updated Customer Onboarding"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.questionnaires.update(
"11111111-2222-3333-4444-555555555555",
title="Updated Customer Onboarding",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.questionnaires.update("11111111-2222-3333-4444-555555555555", {
title: "Updated Customer Onboarding",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Questionnaires.Update(ctx, "11111111-2222-3333-4444-555555555555", didit.SimpleQuestionnaireUpdateRequest{
Title: didit.String("Updated Customer Onboarding"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.SimpleQuestionnaireUpdateRequest;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.questionnaires().update("11111111-2222-3333-4444-555555555555", SimpleQuestionnaireUpdateRequest.builder()
.title("Updated Customer Onboarding")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->questionnaires->update('11111111-2222-3333-4444-555555555555', [
'title' => 'Updated Customer Onboarding',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.questionnaires.update(
"11111111-2222-3333-4444-555555555555",
title: "Updated Customer Onboarding"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Questionnaires.UpdateAsync("11111111-2222-3333-4444-555555555555", new SimpleQuestionnaireUpdateRequest
{
Title = "Updated Customer Onboarding",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"questionnaire_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"languages": [
"<string>"
],
"default_language": "<string>",
"is_active": true,
"is_simple_questionnaire": true,
"graph": {},
"sections": [
{}
],
"questionnaire_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"status": "draft",
"published_at": "2023-11-07T05:31:56Z",
"is_editable": true
}{
"detail": "You do not have permission to perform this action."
}PATCH für Teilaktualisierungen. Um einen Fragebogen umzubenennen, senden Sie nur title oder description.
{
"title": "Updated Customer Onboarding"
}
form_elements-Array. Dies ersetzt die bisherige Fragenliste. Behalten Sie bestehende Fragen bei, die Sie weiterhin anzeigen möchten.
{
"form_elements": [
{
"id": "occupation",
"element_type": "short_text",
"label": { "en": "What is your occupation?" },
"is_required": true
},
{
"id": "source_of_funds",
"element_type": "multiple_choice",
"label": { "en": "Source of funds" },
"options": [
{ "value": "employment", "label": { "en": "Employment" } },
{ "value": "business", "label": { "en": "Business" } }
]
}
]
}
graph, branches, next und bedingte Regeln ab.
Die Antwort enthält questionnaire_id. Wenn Sie einen published-Fragebogen aktualisieren, kann die API eine neue Version erstellen. Speichern Sie die zurückgegebene questionnaire_id und verwenden Sie sie in Workflows, statt anzunehmen, dass die ID in der URL weiterhin die neueste Version ist.Autorisierungen
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.
Pfadparameter
Versionsspezifische UUID des zu aktualisierenden Fragebogens.
Body
Fragebogen-Metadaten aktualisieren oder die vollständige lineare Liste von form_elements ersetzen.
Antwort
Fragebogen aktualisiert. Der Body stellt den neuesten Status der resultierenden Version dar — die direkt aktualisierte Version oder die neu erstellte veröffentlichte Version, wenn Sie status: "published" für eine veröffentlichte Zeile übermittelt haben (in diesem Fall weichen questionnaire_id und version von denen ab, die Sie gepatcht haben). Die questionnaire_id in der Antwort ist die versionsspezifische UUID; verwenden Sie questionnaire_group_id, wenn Sie die stabile Gruppenkennung benötigen.
Vollständige Fragebogendetails, die von den Endpoints GET, POST (Erstellen) und PATCH (Aktualisieren) zurückgegeben werden.
Eindeutige Kennung des Fragebogens. Verwenden Sie diese ID, wenn Sie aus einem Workflow oder in nachfolgenden Update-/Löschanfragen auf den Fragebogen verweisen.
Graphstruktur mit start_node und nodes-Map.
In Abschnitte gruppierter Fragebogeninhalt (aus dem Graph abgeleitet).
Stabile Kennung, die alle Versionen desselben Fragebogens gruppiert.
draft, published True, wenn der Fragebogen noch direkt bearbeitet werden kann (Entwurfsversionen).