> ## Documentation Index
> Fetch the complete documentation index at: https://docs-platform.services-valid.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Consulta Bureau Sync por datasets

> Consulte PF ou PJ com retorno imediato, informando a lista de datasets desejados.

Use `POST /bureau/api/v1/bureau/person/sync` quando quiser **escolher quais datasets consultar**, informando a lista de codigos no campo `datasets`.

<Card title="Sync por pacote" icon="box" href="/plataforma/background-check/bureau-person/api/post-person-sync-package">
  Reutilize um pacote de datasets por ID
</Card>

## Request Body

<ParamField body="key" type="string" required>
  CPF ou CNPJ da pessoa

  **Exemplo**: `12345678901`
</ParamField>

<ParamField body="datasets" type="string[]" required>
  Datasets a serem consultados

  **Exemplo**: `["basic", "addresses"]`
</ParamField>

<ParamField body="refreshData" type="boolean">
  Forca a busca de dados atualizados

  **Exemplo**: `true`
</ParamField>

Use os mesmos codigos de datasets documentados em [Datasets PF e PJ](/plataforma/background-check/bureau-person/datasets).

## Response

Retorna o resultado da consulta na propria resposta HTTP (modo sincrono).

<ResponseField name="requestId" type="string">
  ID da requisicao

  **Formato**: UUID
</ResponseField>

<ResponseField name="createdAt" type="string">
  Data de criacao da requisicao

  **Exemplo**: `2026-03-12T10:30:00.000Z`
</ResponseField>

<ResponseField name="key" type="string">
  CPF ou CNPJ consultado

  **Exemplo**: `12345678901`
</ResponseField>

<ResponseField name="status" type="string">
  Status geral da consulta

  **Valores possiveis**: `FINISHED`, `FAILED`

  `FAILED` quando pelo menos um dataset falhou (os demais podem ter retornado com sucesso).
</ResponseField>

<ResponseField name="datasets" type="object[]">
  Datasets processados com sucesso. Cada item contem `dataset` (codigo) e `data` (payload normalizado).
</ResponseField>

<ResponseField name="failedDatasets" type="object[]">
  Datasets que nao foram processados ou falharam na consulta. Cada item contem:

  <Expandable title="propriedades">
    <ResponseField name="dataset" type="string">
      Codigo do dataset que falhou

      **Exemplo**: `pgfn_certificate_person`
    </ResponseField>

    <ResponseField name="reason" type="string">
      Motivo resumido da falha

      **Exemplos**: `Dataset disponível apenas na consulta assíncrona.`, `No bureau mapping found`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="datasetPackage" type="object">
  Metadados do pacote utilizado, quando a consulta foi feita com `datasetPackageId` (opcional).
</ResponseField>

### Exemplo de sucesso (`200 OK`)

```json theme={"theme":"catppuccin-latte"}
{
  "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
  "createdAt": "2026-03-12T10:30:00.000Z",
  "key": "12345678900",
  "status": "FINISHED",
  "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`)

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

## Respostas de Erro

<ResponseField name="code" type="string">
  Codigo do erro que categoriza o tipo de erro

  **Exemplo**: `VALIDATION_ERROR`
</ResponseField>

<ResponseField name="message" type="string">
  Mensagem de erro

  **Exemplo**: `The request is invalid`
</ResponseField>