Edit an information request item
curl --request PATCH \
--url https://api.example.com/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId} \
--header 'Content-Type: application/json' \
--cookie ds-prod-session= \
--data '
{
"audience": "merchant",
"message": "Please attach the most recent filing."
}
'import requests
url = "https://api.example.com/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}"
payload = {
"audience": "merchant",
"message": "Please attach the most recent filing."
}
headers = {
"cookie": "ds-prod-session=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {cookie: 'ds-prod-session=', 'Content-Type': 'application/json'},
body: JSON.stringify({audience: 'merchant', message: 'Please attach the most recent filing.'})
};
fetch('https://api.example.com/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}', 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/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'audience' => 'merchant',
'message' => 'Please attach the most recent filing.'
]),
CURLOPT_COOKIE => "ds-prod-session=",
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/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}"
payload := strings.NewReader("{\n \"audience\": \"merchant\",\n \"message\": \"Please attach the most recent filing.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cookie", "ds-prod-session=")
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.patch("https://api.example.com/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}")
.header("cookie", "ds-prod-session=")
.header("Content-Type", "application/json")
.body("{\n \"audience\": \"merchant\",\n \"message\": \"Please attach the most recent filing.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cookie"] = 'ds-prod-session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"audience\": \"merchant\",\n \"message\": \"Please attach the most recent filing.\"\n}"
response = http.request(request)
puts response.read_body{
"code": "case_not_found",
"message": "Case not found"
}{
"code": "request_finalized",
"message": "The information request is already finalized"
}{
"errors": [
{
"field": "<string>",
"message": "<string>",
"type": "<string>"
}
],
"message": "<string>"
}{
"case_id": "019f179b-0fa7-72c8-818e-819652540477",
"case_status": "in_remediation",
"created_at": "2023-11-07T05:31:56Z",
"id": "019f179b-0fa7-72c8-818e-819652540477",
"items": [
{
"audience": "merchant",
"canceled_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "019f1383-8f38-7d31-b921-39310a19b444",
"field_key": "registration_number",
"id": "019f179b-0fa7-72c8-818e-819652540477",
"last_value": null,
"message": "The number does not match the registry, please re-enter it.",
"new_value": null,
"request_id": "019f179b-0fa7-72c8-818e-819652540477",
"resolved_at": "2023-11-07T05:31:56Z",
"section_key": "registration",
"status": "open",
"target_kind": "field"
}
],
"received_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"status": "draft",
"widget_url": "https://kyb.dataspike.io/KYB0123456789abcdef"
}KYB Remediation
Edit an information request item
Changes an open item’s message or audience. The target and its kind are immutable — pointing the item at another field would mean redoing the whole reopen side effect, so cancel it and add a new one instead. Allowed until the applicant answers; an already resolved or canceled item is a 409 request_finalized.
PATCH
/
webapi
/
v4
/
kyb
/
organization
/
{organizationId}
/
verifications
/
{caseId}
/
info-request
/
items
/
{itemId}
Edit an information request item
curl --request PATCH \
--url https://api.example.com/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId} \
--header 'Content-Type: application/json' \
--cookie ds-prod-session= \
--data '
{
"audience": "merchant",
"message": "Please attach the most recent filing."
}
'import requests
url = "https://api.example.com/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}"
payload = {
"audience": "merchant",
"message": "Please attach the most recent filing."
}
headers = {
"cookie": "ds-prod-session=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {cookie: 'ds-prod-session=', 'Content-Type': 'application/json'},
body: JSON.stringify({audience: 'merchant', message: 'Please attach the most recent filing.'})
};
fetch('https://api.example.com/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}', 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/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'audience' => 'merchant',
'message' => 'Please attach the most recent filing.'
]),
CURLOPT_COOKIE => "ds-prod-session=",
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/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}"
payload := strings.NewReader("{\n \"audience\": \"merchant\",\n \"message\": \"Please attach the most recent filing.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cookie", "ds-prod-session=")
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.patch("https://api.example.com/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}")
.header("cookie", "ds-prod-session=")
.header("Content-Type", "application/json")
.body("{\n \"audience\": \"merchant\",\n \"message\": \"Please attach the most recent filing.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/webapi/v4/kyb/organization/{organizationId}/verifications/{caseId}/info-request/items/{itemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cookie"] = 'ds-prod-session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"audience\": \"merchant\",\n \"message\": \"Please attach the most recent filing.\"\n}"
response = http.request(request)
puts response.read_body{
"code": "case_not_found",
"message": "Case not found"
}{
"code": "request_finalized",
"message": "The information request is already finalized"
}{
"errors": [
{
"field": "<string>",
"message": "<string>",
"type": "<string>"
}
],
"message": "<string>"
}{
"case_id": "019f179b-0fa7-72c8-818e-819652540477",
"case_status": "in_remediation",
"created_at": "2023-11-07T05:31:56Z",
"id": "019f179b-0fa7-72c8-818e-819652540477",
"items": [
{
"audience": "merchant",
"canceled_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "019f1383-8f38-7d31-b921-39310a19b444",
"field_key": "registration_number",
"id": "019f179b-0fa7-72c8-818e-819652540477",
"last_value": null,
"message": "The number does not match the registry, please re-enter it.",
"new_value": null,
"request_id": "019f179b-0fa7-72c8-818e-819652540477",
"resolved_at": "2023-11-07T05:31:56Z",
"section_key": "registration",
"status": "open",
"target_kind": "field"
}
],
"received_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"status": "draft",
"widget_url": "https://kyb.dataspike.io/KYB0123456789abcdef"
}Authorizations
Session cookie for web dashboard authentication.
Path Parameters
Organization id.
KYB case id (the id from the list).
Request item id.
Body
application/jsonapplication/xml
Request body for kyb.PatchInfoRequestItemRequest
Response
OK
⌘I