Skip to main content
POST
/
bureau
/
api
/
v1
/
person
/
sync
Consulta Bureau Person Sync
curl --request POST \
  --url https://api.valid.com/bureau/api/v1/person/sync \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "key": "<string>",
  "datasets": [
    "<string>"
  ],
  "datasetPackageId": "<string>",
  "refreshData": true
}
'
{
  "code": "<string>",
  "message": "<string>"
}

​
Request Body

​
key
string
required
CPF ou CNPJ da pessoaExemplo: 12345678901
​
datasets
string[]
Datasets a serem consultadosExemplo: ["basic", "addresses"]
​
datasetPackageId
string
ID do pacote de datasetsFormato: UUIDExemplo: 05be75cc-8f8a-414a-891f-434aa9b4e7a5
​
refreshData
boolean
Forca a busca de dados atualizadosExemplo: true
Use os mesmos codigos de datasets documentados em Datasets PF e PJ.

​
Response

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

​
Exemplo de sucesso (200 OK)

{
  "result": {
    "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
    "key": "12345678900",
    "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"
            }
          ]
        }
      }
    ]
  }
}

​
Respostas de Erro

​
code
string
Codigo do erro que categoriza o tipo de erroExemplo: VALIDATION_ERROR
​
message
string
Mensagem de erroExemplo: The request is invalid