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": [
    {
      "section_key": "registration",
      "field_key": "registration_number",
      "value": "36-2382580"
    }
  ],
  "custom": [
    {
      "item_id": "019f1b00-0000-7000-8000-000000000005",
      "text": "Suite 400, 1 Market Street, San Francisco, CA 94105."
    }
  ],
  "comments": [
    {
      "item_id": "019f17aa-1b2c-73d4-95e6-0123456789ab",
      "text": "The registry still lists our old name; the rename filing is with them since May."
    }
  ]
}
'

import requests

url = "https://api.example.com/api/v4/kyb/widget/{publicId}/remediation"

payload = {
    "targets": [
        {
            "section_key": "registration",
            "field_key": "registration_number",
            "value": "36-2382580"
        }
    ],
    "custom": [
        {
            "item_id": "019f1b00-0000-7000-8000-000000000005",
            "text": "Suite 400, 1 Market Street, San Francisco, CA 94105."
        }
    ],
    "comments": [
        {
            "item_id": "019f17aa-1b2c-73d4-95e6-0123456789ab",
            "text": "The registry still lists our old name; the rename filing is with them since May."
        }
    ]
}
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: [
      {
        section_key: 'registration',
        field_key: 'registration_number',
        value: '36-2382580'
      }
    ],
    custom: [
      {
        item_id: '019f1b00-0000-7000-8000-000000000005',
        text: 'Suite 400, 1 Market Street, San Francisco, CA 94105.'
      }
    ],
    comments: [
      {
        item_id: '019f17aa-1b2c-73d4-95e6-0123456789ab',
        text: 'The registry still lists our old name; the rename filing is with them since May.'
      }
    ]
  })
};

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' => [
        [
                'section_key' => 'registration',
                'field_key' => 'registration_number',
                'value' => '36-2382580'
        ]
    ],
    'custom' => [
        [
                'item_id' => '019f1b00-0000-7000-8000-000000000005',
                'text' => 'Suite 400, 1 Market Street, San Francisco, CA 94105.'
        ]
    ],
    'comments' => [
        [
                'item_id' => '019f17aa-1b2c-73d4-95e6-0123456789ab',
                'text' => 'The registry still lists our old name; the rename filing is with them since May.'
        ]
    ]
  ]),
  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      \"section_key\": \"registration\",\n      \"field_key\": \"registration_number\",\n      \"value\": \"36-2382580\"\n    }\n  ],\n  \"custom\": [\n    {\n      \"item_id\": \"019f1b00-0000-7000-8000-000000000005\",\n      \"text\": \"Suite 400, 1 Market Street, San Francisco, CA 94105.\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"item_id\": \"019f17aa-1b2c-73d4-95e6-0123456789ab\",\n      \"text\": \"The registry still lists our old name; the rename filing is with them since May.\"\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      \"section_key\": \"registration\",\n      \"field_key\": \"registration_number\",\n      \"value\": \"36-2382580\"\n    }\n  ],\n  \"custom\": [\n    {\n      \"item_id\": \"019f1b00-0000-7000-8000-000000000005\",\n      \"text\": \"Suite 400, 1 Market Street, San Francisco, CA 94105.\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"item_id\": \"019f17aa-1b2c-73d4-95e6-0123456789ab\",\n      \"text\": \"The registry still lists our old name; the rename filing is with them since May.\"\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      \"section_key\": \"registration\",\n      \"field_key\": \"registration_number\",\n      \"value\": \"36-2382580\"\n    }\n  ],\n  \"custom\": [\n    {\n      \"item_id\": \"019f1b00-0000-7000-8000-000000000005\",\n      \"text\": \"Suite 400, 1 Market Street, San Francisco, CA 94105.\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"item_id\": \"019f17aa-1b2c-73d4-95e6-0123456789ab\",\n      \"text\": \"The registry still lists our old name; the rename filing is with them since May.\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "errors": [
    {
      "code": "invalid_email",
      "field": "contact_email",
      "message": "Invalid email address"
    }
  ],
  "remediation": {
    "items_open": 1,
    "items_total": 2,
    "status": "sent"
  },
  "saved": true
}

{
  "code": "invalid_body",
  "message": "Invalid request 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"
}

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.

A requested field brings its required_if siblings with it, so picking “Other” in an asked select lets the specify-field the catalog then makes required be answered in the same body. The widening is one hop off a real ask: a required_if field whose trigger the round did not ask for is still a 409 not_requested.

A custom ask is answered under custom instead, addressed by item_id because it has no catalog keys: {"custom":[{"item_id":"...","text":"..."}]}. Both lists are optional and a body carrying neither is a 400; anything but an open custom ask of the live round that takes text is a 409 not_requested, a file-only ask included. Clearing the text un-answers the ask, which the re-submit then refuses if it is required; an ask the officer marked optional may stay empty. Text of nothing but whitespace IS clearing it, both here and at the gate.

comments carries the merchant’s own note on an item, addressed by item_id the way a custom answer is, because that is the one key every kind has: {"comments":[{"item_id":"...","text":"..."}]}. Any item of the live round takes one, a document group and a file-only custom ask included. It is not an answer: it resolves nothing, leaves items_open where it was and does not open the re-submit gate, so an item carrying only a comment is still outstanding. Empty text erases the note. All three lists are optional and a body carrying none of them is a 400; an item_id outside the live round is a 409 not_requested.

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

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": [
    {
      "section_key": "registration",
      "field_key": "registration_number",
      "value": "36-2382580"
    }
  ],
  "custom": [
    {
      "item_id": "019f1b00-0000-7000-8000-000000000005",
      "text": "Suite 400, 1 Market Street, San Francisco, CA 94105."
    }
  ],
  "comments": [
    {
      "item_id": "019f17aa-1b2c-73d4-95e6-0123456789ab",
      "text": "The registry still lists our old name; the rename filing is with them since May."
    }
  ]
}
'

import requests

url = "https://api.example.com/api/v4/kyb/widget/{publicId}/remediation"

payload = {
    "targets": [
        {
            "section_key": "registration",
            "field_key": "registration_number",
            "value": "36-2382580"
        }
    ],
    "custom": [
        {
            "item_id": "019f1b00-0000-7000-8000-000000000005",
            "text": "Suite 400, 1 Market Street, San Francisco, CA 94105."
        }
    ],
    "comments": [
        {
            "item_id": "019f17aa-1b2c-73d4-95e6-0123456789ab",
            "text": "The registry still lists our old name; the rename filing is with them since May."
        }
    ]
}
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: [
      {
        section_key: 'registration',
        field_key: 'registration_number',
        value: '36-2382580'
      }
    ],
    custom: [
      {
        item_id: '019f1b00-0000-7000-8000-000000000005',
        text: 'Suite 400, 1 Market Street, San Francisco, CA 94105.'
      }
    ],
    comments: [
      {
        item_id: '019f17aa-1b2c-73d4-95e6-0123456789ab',
        text: 'The registry still lists our old name; the rename filing is with them since May.'
      }
    ]
  })
};

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' => [
        [
                'section_key' => 'registration',
                'field_key' => 'registration_number',
                'value' => '36-2382580'
        ]
    ],
    'custom' => [
        [
                'item_id' => '019f1b00-0000-7000-8000-000000000005',
                'text' => 'Suite 400, 1 Market Street, San Francisco, CA 94105.'
        ]
    ],
    'comments' => [
        [
                'item_id' => '019f17aa-1b2c-73d4-95e6-0123456789ab',
                'text' => 'The registry still lists our old name; the rename filing is with them since May.'
        ]
    ]
  ]),
  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      \"section_key\": \"registration\",\n      \"field_key\": \"registration_number\",\n      \"value\": \"36-2382580\"\n    }\n  ],\n  \"custom\": [\n    {\n      \"item_id\": \"019f1b00-0000-7000-8000-000000000005\",\n      \"text\": \"Suite 400, 1 Market Street, San Francisco, CA 94105.\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"item_id\": \"019f17aa-1b2c-73d4-95e6-0123456789ab\",\n      \"text\": \"The registry still lists our old name; the rename filing is with them since May.\"\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      \"section_key\": \"registration\",\n      \"field_key\": \"registration_number\",\n      \"value\": \"36-2382580\"\n    }\n  ],\n  \"custom\": [\n    {\n      \"item_id\": \"019f1b00-0000-7000-8000-000000000005\",\n      \"text\": \"Suite 400, 1 Market Street, San Francisco, CA 94105.\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"item_id\": \"019f17aa-1b2c-73d4-95e6-0123456789ab\",\n      \"text\": \"The registry still lists our old name; the rename filing is with them since May.\"\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      \"section_key\": \"registration\",\n      \"field_key\": \"registration_number\",\n      \"value\": \"36-2382580\"\n    }\n  ],\n  \"custom\": [\n    {\n      \"item_id\": \"019f1b00-0000-7000-8000-000000000005\",\n      \"text\": \"Suite 400, 1 Market Street, San Francisco, CA 94105.\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"item_id\": \"019f17aa-1b2c-73d4-95e6-0123456789ab\",\n      \"text\": \"The registry still lists our old name; the rename filing is with them since May.\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "errors": [
    {
      "code": "invalid_email",
      "field": "contact_email",
      "message": "Invalid email address"
    }
  ],
  "remediation": {
    "items_open": 1,
    "items_total": 2,
    "status": "sent"
  },
  "saved": true
}

{
  "code": "invalid_body",
  "message": "Invalid request 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"
}

Path Parameters

publicId

string

required

KYB case public id.

Body

Request body for kyb.SaveRemediationRequest

SaveRemediationRequest schema

comments

object[]

Show child attributes

custom

object[]

Show child attributes

targets

object[]

Show child attributes

Response

Answers saved.

SaveRemediationResponse schema

errors

object[]

Show child attributes

remediation

object | null

Show child attributes

saved

boolean

Example:

true

API documentation

KYB

KYT

Answer an open information request

Path Parameters

Body

Response