Answer an open information request
curl --request POST \
--url https://api.example.com/api/v4/kyb/widget/{publicId}/remediation \
--header 'Content-Type: application/json' \
--data '
{
"targets": [
{
"field_key": "legal_name",
"section_key": "business",
"value": "<unknown>"
}
]
}
'import requests
url = "https://api.example.com/api/v4/kyb/widget/{publicId}/remediation"
payload = { "targets": [
{
"field_key": "legal_name",
"section_key": "business",
"value": "<unknown>"
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
targets: [{field_key: 'legal_name', section_key: 'business', value: '<unknown>'}]
})
};
fetch('https://api.example.com/api/v4/kyb/widget/{publicId}/remediation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v4/kyb/widget/{publicId}/remediation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'targets' => [
[
'field_key' => 'legal_name',
'section_key' => 'business',
'value' => '<unknown>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v4/kyb/widget/{publicId}/remediation"
payload := strings.NewReader("{\n \"targets\": [\n {\n \"field_key\": \"legal_name\",\n \"section_key\": \"business\",\n \"value\": \"<unknown>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v4/kyb/widget/{publicId}/remediation")
.header("Content-Type", "application/json")
.body("{\n \"targets\": [\n {\n \"field_key\": \"legal_name\",\n \"section_key\": \"business\",\n \"value\": \"<unknown>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v4/kyb/widget/{publicId}/remediation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"targets\": [\n {\n \"field_key\": \"legal_name\",\n \"section_key\": \"business\",\n \"value\": \"<unknown>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": "case_not_found",
"message": "Case not found"
}{
"code": "case_locked",
"message": "Case is locked and cannot be modified"
}{
"code": "unknown_field",
"message": "Unknown field",
"param": "not_a_field"
}{
"errors": [
{
"code": "invalid_email",
"field": "contact_email",
"message": "Invalid email address"
}
],
"remediation": {
"items_open": 1,
"items_total": 2,
"status": "sent"
},
"saved": true
}KYB Widget
Answer an open information request
Autosaves the answers to the round in remediation[] of the widget state. Same soft draft validation as the section form (format issues come back in errors[] while the save succeeds); the round is closed by POST /api/v4/kyb/widget//submit, which refuses while any target is still unanswered.
Targets carry their own section_key because a round crosses sections. Only the FIELD targets of the live round are accepted: anything else is a 409 not_requested, a document group included, since a group is answered by uploading through POST /api/v4/upload/kyb//documents.
remediation in the response is the round after this write, the same block the widget state carries as info_request: items_open counts the targets still outstanding.
POST
/
api
/
v4
/
kyb
/
widget
/
{publicId}
/
remediation
Answer an open information request
curl --request POST \
--url https://api.example.com/api/v4/kyb/widget/{publicId}/remediation \
--header 'Content-Type: application/json' \
--data '
{
"targets": [
{
"field_key": "legal_name",
"section_key": "business",
"value": "<unknown>"
}
]
}
'import requests
url = "https://api.example.com/api/v4/kyb/widget/{publicId}/remediation"
payload = { "targets": [
{
"field_key": "legal_name",
"section_key": "business",
"value": "<unknown>"
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
targets: [{field_key: 'legal_name', section_key: 'business', value: '<unknown>'}]
})
};
fetch('https://api.example.com/api/v4/kyb/widget/{publicId}/remediation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v4/kyb/widget/{publicId}/remediation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'targets' => [
[
'field_key' => 'legal_name',
'section_key' => 'business',
'value' => '<unknown>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v4/kyb/widget/{publicId}/remediation"
payload := strings.NewReader("{\n \"targets\": [\n {\n \"field_key\": \"legal_name\",\n \"section_key\": \"business\",\n \"value\": \"<unknown>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v4/kyb/widget/{publicId}/remediation")
.header("Content-Type", "application/json")
.body("{\n \"targets\": [\n {\n \"field_key\": \"legal_name\",\n \"section_key\": \"business\",\n \"value\": \"<unknown>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v4/kyb/widget/{publicId}/remediation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"targets\": [\n {\n \"field_key\": \"legal_name\",\n \"section_key\": \"business\",\n \"value\": \"<unknown>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": "case_not_found",
"message": "Case not found"
}{
"code": "case_locked",
"message": "Case is locked and cannot be modified"
}{
"code": "unknown_field",
"message": "Unknown field",
"param": "not_a_field"
}{
"errors": [
{
"code": "invalid_email",
"field": "contact_email",
"message": "Invalid email address"
}
],
"remediation": {
"items_open": 1,
"items_total": 2,
"status": "sent"
},
"saved": true
}⌘I