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."
}Atualizar questionário via API: editar formulário KYC
Edite um questionário KYC da Didit: renomeie, substitua perguntas ordenadas e atualize rótulos em vários idiomas. Pago por chamada.
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 para atualizações parciais. Para renomear um questionário, envie apenas title ou description.
{
"title": "Updated Customer Onboarding"
}
form_elements completo, como você quer que ele fique. Ele substitui a lista de perguntas anterior. Mantenha todas as perguntas existentes que você ainda quer exibir.
{
"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 e regras condicionais.
A resposta inclui questionnaire_id. Quando você atualiza um questionário published, a API pode criar uma nova versão. Guarde o questionnaire_id retornado e use-o nos fluxos, em vez de presumir que o id na URL ainda é a versão mais recente.Autorizações
Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.
Parâmetros de caminho
UUID da versão do questionário a ser atualizada.
Corpo
Atualize os metadados do questionário ou substitua a lista linear completa form_elements.
Resposta
Questionário atualizado. O corpo é o estado mais recente da versão resultante: a versão atualizada no próprio registro, ou a nova versão publicada criada quando você enviou status: "published" em um registro publicado (nesse caso, questionnaire_id e version diferem dos que você atualizou). O questionnaire_id na resposta é o UUID por versão; use questionnaire_group_id se precisar do identificador estável do grupo.
Detalhes completos do questionário retornados pelos endpoints GET, POST (criação) e PATCH (atualização).
Identificador único do questionário. Use este id ao referenciar o questionário a partir de um fluxo ou em requisições posteriores de atualização/exclusão.
Estrutura de grafo com start_node e o mapa de nós.
Conteúdo do questionário agrupado em seções (derivado do grafo).
Identificador estável que agrupa todas as versões do mesmo questionário.
draft, published True quando o questionário ainda pode ser editado diretamente (versões de rascunho).