---
url: https://developers.zarv.com/api/datasources.md
description: >-
  Consultas brutas e síncronas às fontes de dados, mapeadas para os modelos do
  Zarv ID, sem verificação, sem fila e sem score. Cobrança por consulta.
---

# Datasources

Os endpoints de **Datasources** expõem consultas **brutas e síncronas** às fontes de dados, mapeadas diretamente para os modelos do Zarv ID — **sem verificação, sem fila e sem score**. São úteis quando você precisa apenas do dado consolidado de uma fonte, sem passar pelo pipeline de análise.

A cobrança é **por consulta** (pós-paga): cada chamada bem-sucedida registra um consumo no plano do workspace.

## Autenticação

Usa a **mesma estrutura de login / JWT** do restante da API. Obtenha o token em [Autenticação](/api/zarv-id/post-api-v1-authentication) e envie-o no cabeçalho `Authorization` de cada requisição:

```
Authorization: Bearer <access_token>
```

## Perfil de Pessoa (CPF)

Retorna os dados cadastrais básicos de um CPF (basic data), sem enriquecimento, blacklist ou avaliação de score.

### Endpoint

```
GET https://services.zarv.com/api/v1/datasources/people/profile
```

### Parâmetros de consulta

| Parâmetro    | Tipo   | Obrigatório | Descrição                          |
| ------------ | ------ | ----------- | ---------------------------------- |
| `nationalId` | string | sim         | CPF a ser consultado (apenas CPF). |

### Exemplo de requisição

```bash
curl --location 'https://services.zarv.com/api/v1/datasources/people/profile?nationalId=00000000000' \
  --header 'Authorization: Bearer <access_token>'
```

### Resposta `200 OK`

```json
{
  "nationalId": "00000000000",
  "name": "FULANO DE TAL",
  "age": 41,
  "birthDate": "1984-11-21",
  "gender": "M",
  "fiscalStatus": "REGULAR",
  "motherName": "MARIA DE TAL",
  "obit": false
}
```

| Campo          | Tipo    | Descrição                              |
| -------------- | ------- | -------------------------------------- |
| `nationalId`   | string  | CPF consultado.                        |
| `name`         | string  | Nome completo.                         |
| `age`          | number  | Idade em anos.                         |
| `birthDate`    | string  | Data de nascimento (`YYYY-MM-DD`).     |
| `gender`       | string  | Gênero.                                |
| `fiscalStatus` | string  | Situação cadastral na Receita Federal. |
| `motherName`   | string  | Nome da mãe.                           |
| `obit`         | boolean | `true` quando há indicação de óbito.   |

### Erros

Em caso de falha, a resposta traz um objeto com a mensagem em `error`.

CPF válido, mas não localizado na base:

```json
{
  "error": "CPF_NOT_FOUND"
}
```

Demais códigos possíveis:

| `error`                                    | Situação                                         |
| ------------------------------------------ | ------------------------------------------------ |
| `invalid national id format (CPF or CNPJ)` | O `nationalId` não é um CPF válido.              |
| `CPF_NOT_FOUND`                            | O CPF é válido mas não consta na base de origem. |
| `MINOR_AGE`                                | O titular é menor de idade.                      |
| `not found`                                | A base não retornou dados cadastrais para o CPF. |