Consulta Bureau Sync por pacote

POST

bureau

api

bureau

person

sync

Consulta Bureau Sync por pacote

curl --request POST \
  --url https://api.valid.com/bureau/api/v1/bureau/person/sync \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "key": "<string>",
  "datasetPackageId": "<string>",
  "refreshData": true
}
'

import requests

url = "https://api.valid.com/bureau/api/v1/bureau/person/sync"

payload = {
    "key": "<string>",
    "datasetPackageId": "<string>",
    "refreshData": True
}
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({key: '<string>', datasetPackageId: '<string>', refreshData: true})
};

fetch('https://api.valid.com/bureau/api/v1/bureau/person/sync', 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/bureau/person/sync",
  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([
    'key' => '<string>',
    'datasetPackageId' => '<string>',
    'refreshData' => true
  ]),
  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/bureau/person/sync"

	payload := strings.NewReader("{\n  \"key\": \"<string>\",\n  \"datasetPackageId\": \"<string>\",\n  \"refreshData\": true\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/bureau/person/sync")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"<string>\",\n  \"datasetPackageId\": \"<string>\",\n  \"refreshData\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/bureau/api/v1/bureau/person/sync")

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  \"key\": \"<string>\",\n  \"datasetPackageId\": \"<string>\",\n  \"refreshData\": true\n}"

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

{
  "requestId": "<string>",
  "createdAt": "<string>",
  "key": "<string>",
  "status": "<string>",
  "datasets": [
    {}
  ],
  "failedDatasets": [
    {
      "dataset": "<string>",
      "reason": "<string>"
    }
  ],
  "datasetPackage": {},
  "code": "<string>",
  "message": "<string>"
}

Requisito: é necessário enviar o header de autenticação, mais informações aqui Use a mesma URI de consulta síncrona (POST /bureau/api/v1/bureau/person/sync) quando quiser reutilizar um pacote de datasets criado previamente, informando o ID do pacote no campo datasetPackageId.

Sync por datasets

Escolha quais datasets consultar

Request Body

string

required

CPF ou CNPJ da pessoaExemplo: 12345678901

string

required

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

boolean

Forca a busca de dados atualizadosExemplo: true

Consulte Pacote de Datasets para criar e gerenciar pacotes.

Response

Retorna o resultado da consulta na propria resposta HTTP (modo síncrono).

string

ID da requisicaoFormato: UUID

string

Data de criacao da requisicaoExemplo: 2026-03-12T10:30:00.000Z

string

CPF ou CNPJ consultadoExemplo: 12345678901

string

Status geral da consultaValores possiveis: FINISHED, FAILEDFAILED quando pelo menos um dataset falhou (os demais podem ter retornado com sucesso).

object[]

Datasets processados com sucesso. Cada item contem dataset (código) e data (payload normalizado).

object[]

Datasets que nao foram processados ou falharam na consulta. Cada item contem:

Show propriedades

string

Codigo do dataset que falhouExemplo: pgfn_certificate_person

string

Motivo resumido da falhaExemplos: Dataset disponível apenas na consulta assíncrona., No bureau mapping found

object

Metadados do pacote utilizado (id, name).

Exemplo de sucesso (`200 OK`)

{
  "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
  "createdAt": "2026-03-12T10:30:00.000Z",
  "key": "12345678900",
  "status": "FINISHED",
  "datasetPackage": {
    "id": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
    "name": "Pacote antifraude PF"
  },
  "datasets": [
    {
      "dataset": "basic",
      "data": {
        "document": "12345678900",
        "name": "Joao da Silva",
        "motherName": "Maria da Silva",
        "birthDate": "1990-05-21",
        "status": "REGULAR"
      }
    },
    {
      "dataset": "addresses",
      "data": {
        "addresses": [
          {
            "street": "Rua das Flores",
            "number": "123",
            "complement": "Apto 45",
            "district": "Centro",
            "city": "Sao Paulo",
            "state": "SP",
            "zipCode": "01001-000",
            "country": "BR"
          }
        ]
      }
    }
  ],
  "failedDatasets": []
}

Exemplo com falha parcial (`200 OK`)

{
  "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
  "createdAt": "2026-03-12T10:30:00.000Z",
  "key": "12345678900",
  "status": "FAILED",
  "datasetPackage": {
    "id": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
    "name": "Pacote antifraude PF"
  },
  "datasets": [
    {
      "dataset": "basic",
      "data": {
        "document": "12345678900",
        "name": "Joao da Silva",
        "status": "REGULAR"
      }
    }
  ],
  "failedDatasets": [
    {
      "dataset": "clearance_certificate_person",
      "reason": "Dataset disponível apenas na consulta assíncrona."
    }
  ]
}

Respostas de Erro

string

Codigo do erro que categoriza o tipo de erroExemplo: VALIDATION_ERROR

string

Mensagem de erroExemplo: The request is invalid

⌘I

Consulta Bureau Sync por pacote

curl --request POST \
  --url https://api.valid.com/bureau/api/v1/bureau/person/sync \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "key": "<string>",
  "datasetPackageId": "<string>",
  "refreshData": true
}
'

import requests

url = "https://api.valid.com/bureau/api/v1/bureau/person/sync"

payload = {
    "key": "<string>",
    "datasetPackageId": "<string>",
    "refreshData": True
}
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({key: '<string>', datasetPackageId: '<string>', refreshData: true})
};

fetch('https://api.valid.com/bureau/api/v1/bureau/person/sync', 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/bureau/person/sync",
  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([
    'key' => '<string>',
    'datasetPackageId' => '<string>',
    'refreshData' => true
  ]),
  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/bureau/person/sync"

	payload := strings.NewReader("{\n  \"key\": \"<string>\",\n  \"datasetPackageId\": \"<string>\",\n  \"refreshData\": true\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/bureau/person/sync")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"<string>\",\n  \"datasetPackageId\": \"<string>\",\n  \"refreshData\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/bureau/api/v1/bureau/person/sync")

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  \"key\": \"<string>\",\n  \"datasetPackageId\": \"<string>\",\n  \"refreshData\": true\n}"

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

{
  "requestId": "<string>",
  "createdAt": "<string>",
  "key": "<string>",
  "status": "<string>",
  "datasets": [
    {}
  ],
  "failedDatasets": [
    {
      "dataset": "<string>",
      "reason": "<string>"
    }
  ],
  "datasetPackage": {},
  "code": "<string>",
  "message": "<string>"
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

BPO

Extração Dados

Mensageria

Documentoscopia

Consulta Bureau Sync por pacote

Sync por datasets

Request Body

Response

Exemplo de sucesso (`200 OK`)

Exemplo com falha parcial (`200 OK`)

Respostas de Erro

Sync por datasets

​Request Body

​Response

​Exemplo de sucesso (200 OK)

​Exemplo com falha parcial (200 OK)

​Respostas de Erro

Request Body

Response

Exemplo de sucesso (`200 OK`)

Exemplo com falha parcial (`200 OK`)

Respostas de Erro