Crie um Pacote de Datasets

POST

bureau

api

datasets-package

curl --request POST \
  --url https://api.valid.com/bureau/api/v1/datasets-package \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "group": "<string>",
  "datasets": [
    "<string>"
  ]
}
'

import requests

url = "https://api.valid.com/bureau/api/v1/datasets-package"

payload = {
    "name": "<string>",
    "group": "<string>",
    "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({name: '<string>', group: '<string>', datasets: ['<string>']})
};

fetch('https://api.valid.com/bureau/api/v1/datasets-package', 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",
  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([
    'name' => '<string>',
    'group' => '<string>',
    '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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"group\": \"<string>\",\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")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"group\": \"<string>\",\n  \"datasets\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/bureau/api/v1/datasets-package")

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  \"name\": \"<string>\",\n  \"group\": \"<string>\",\n  \"datasets\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "group": "<string>",
  "datasets": [
    "<string>"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Request Body

string

required

Nome do pacote de datasetsExemplo: Pacote de datasets

string

required

Grupo do pacote de datasetsValores possíveis: PF, PJExemplo: PF

string[]

required

Lista de datasets do pacote (mínimo 1 item)Formato: Array de stringsExemplo: ["basic", "addresses"]

Response

string

ID do pacote de datasetsFormato: UUIDExemplo: 05be75cc-8f8a-414a-891f-434aa9b4e7a5

string

Nome do pacote de datasetsExemplo: Pacote de datasets

string

Grupo do pacote de datasetsExemplo: PF

string[]

Lista de datasets do pacoteFormato: Array de stringsExemplo: ["basic", "addresses"]

string

Data de criaçãoExemplo: 2023-01-01T12:00:00Z

string

Data de atualizaçãoExemplo: 2023-01-01T12:00:00Z

Respostas de Erro

string

Código do erro que categoriza o tipo de erroExemplo: VALIDATION_ERROR

string

Mensagem de erroExemplo: The request is invalid

array

Lista contendo detalhes do erro (opcional)

Show Estrutura de Details

string

Campo que está incorreto ou inválidoExemplo: name

string

Mensagem de erro do campoExemplo: The field cannot be blank

⌘I

Crie um Pacote de Datasets

curl --request POST \
  --url https://api.valid.com/bureau/api/v1/datasets-package \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "group": "<string>",
  "datasets": [
    "<string>"
  ]
}
'

import requests

url = "https://api.valid.com/bureau/api/v1/datasets-package"

payload = {
    "name": "<string>",
    "group": "<string>",
    "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({name: '<string>', group: '<string>', datasets: ['<string>']})
};

fetch('https://api.valid.com/bureau/api/v1/datasets-package', 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",
  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([
    'name' => '<string>',
    'group' => '<string>',
    '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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"group\": \"<string>\",\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")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"group\": \"<string>\",\n  \"datasets\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/bureau/api/v1/datasets-package")

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  \"name\": \"<string>\",\n  \"group\": \"<string>\",\n  \"datasets\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "group": "<string>",
  "datasets": [
    "<string>"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

BPO

Extração Dados

Mensageria

Documentoscopia

Crie um Pacote de Datasets

Request Body

Response

Respostas de Erro

​Request Body

​Response

​Respostas de Erro

Request Body

Response

Respostas de Erro