API
Adicione Datasets a um Pacote
Adiciona datasets a um pacote existente
POST
/
bureau
/
api
/
v1
/
datasets-package
/
{id}
/
datasets
Adicione Datasets a um Pacote
curl --request POST \
--url https://api.valid.com/bureau/api/v1/datasets-package/{id}/datasets \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"datasets": [
"<string>"
]
}
'import requests
url = "https://api.valid.com/bureau/api/v1/datasets-package/{id}/datasets"
payload = { "datasets": ["<string>"] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({datasets: ['<string>']})
};
fetch('https://api.valid.com/bureau/api/v1/datasets-package/{id}/datasets', 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.valid.com/bureau/api/v1/datasets-package/{id}/datasets",
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([
'datasets' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.valid.com/bureau/api/v1/datasets-package/{id}/datasets"
payload := strings.NewReader("{\n \"datasets\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.valid.com/bureau/api/v1/datasets-package/{id}/datasets")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"datasets\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/bureau/api/v1/datasets-package/{id}/datasets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"datasets\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
]
}Path Parameters
string
required
ID do pacote de datasetsFormato: UUIDExemplo:
05be75cc-8f8a-414a-891f-434aa9b4e7a5Request Body
string[]
required
Lista de datasets a serem adicionados ao pacote (mínimo 1 item)Formato: Array de stringsExemplo:
["basic", "addresses"]Response
Retorna status204 No Content em caso de sucesso.
Respostas de Erro
string
Código do erro que categoriza o tipo de erroExemplo:
VALIDATION_ERRORstring
Mensagem de erroExemplo:
The request is invalid⌘I
Adicione Datasets a um Pacote
curl --request POST \
--url https://api.valid.com/bureau/api/v1/datasets-package/{id}/datasets \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"datasets": [
"<string>"
]
}
'import requests
url = "https://api.valid.com/bureau/api/v1/datasets-package/{id}/datasets"
payload = { "datasets": ["<string>"] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({datasets: ['<string>']})
};
fetch('https://api.valid.com/bureau/api/v1/datasets-package/{id}/datasets', 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.valid.com/bureau/api/v1/datasets-package/{id}/datasets",
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([
'datasets' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.valid.com/bureau/api/v1/datasets-package/{id}/datasets"
payload := strings.NewReader("{\n \"datasets\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.valid.com/bureau/api/v1/datasets-package/{id}/datasets")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"datasets\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/bureau/api/v1/datasets-package/{id}/datasets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"datasets\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>"
}
]
}