Dados básicos

A consulta ao conjunto dados básicos retorna dados que incluem, sempre que possível, nome completo, filiação, data de nascimento, gênero, nacionalidade, óbito, estado civil, documentos de identificação, entre outros.

Requisição

No corpo da requisição, o campo type deve conter obrigatoriamente o valor persons e datasets deve conter uma matriz que inclua o elemento basic para que este conjunto de dados seja consultado, conforme o exemplo abaixo:

{
	"type": "persons",
	"key_type": "cpf",
	"key_value": "***********",
	"datasets": [ "basic" ]
}

Retorno

Caso a consulta seja concluída com sucesso, os dados estarão disponíveis no objeto data.basic da resposta. Para saber mais sobre cada campo retornado nesta consulta, verifique a especificação do retorno de código 200 contida na seção responses abaixo.

Body Params
string
enum
required

Tipo da busca

Allowed:
string
enum
required

Tipo da chave de busca

Allowed:
string
required

Valor da chave de busca

filters
array of objects

Lista de filtros de busca

filters
datasets
array of strings
enum
required

Lista de conjuntos de dados desejados

datasets*
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json