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."
}Обновление анкеты через API: редактирование KYC-формы
Редактируйте KYC-анкету Didit через API: переименование, замена вопросов по порядку, многоязычные подписи. Оплата за вызов.
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 для частичных обновлений. Чтобы переименовать анкету, отправьте только title или description.
{
"title": "Updated Customer Onboarding"
}
form_elements. Он заменит предыдущий список вопросов. Сохраните существующие вопросы, которые вы хотите оставить.
{
"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 и условные правила.
Ответ содержит questionnaire_id. При обновлении анкеты со статусом published API может создать новую версию. Сохраните возвращённый questionnaire_id и используйте его в сценариях, а не считайте, что id из URL по-прежнему указывает на последнюю версию.Авторизации
API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.
Параметры пути
UUID конкретной версии обновляемой анкеты.
Тело
Обновить метаданные анкеты или заменить полный линейный список form_elements.
Ответ
Анкета обновлена. Тело содержит последнее состояние полученной версии — обновлённую на месте версию или вновь созданную опубликованную версию, если вы передали status: "published" для опубликованной строки (в этом случае questionnaire_id и version отличаются от тех, к которым применялся патч). Поле questionnaire_id в ответе представляет собой UUID конкретной версии; используйте questionnaire_group_id, если вам нужен неизменный идентификатор группы.
Полные сведения об анкете, возвращаемые из endpoint’ов GET, POST (создание) и PATCH (обновление).
Уникальный идентификатор анкеты. Используйте этот id при ссылке на анкету из сценария или в последующих запросах на обновление/удаление.
Структура графа с полем start_node и отображением nodes.
Содержимое анкеты, сгруппированное по разделам (на основе графа).
Постоянный идентификатор, объединяющий все версии одной и той же анкеты.
draft, published True, когда анкету всё ещё можно редактировать на месте (черновые версии).