---
title: 2.1. Enumerações
url: https://docs.vehub.com.br/Emiss%C3%A3o%20de%20Ativos/API/Cr%C3%A9dito/2.%20Enumera%C3%A7%C3%B5es/2.1.%20Enumera%C3%A7%C3%B5es/
---
# 2.1. Enumerações

!!! warning "Especificação — em construção"
    Os serviços descritos nesta área ainda não estão disponíveis.

Esta seção descreve os enumeradores usados no fluxo de crédito. Parte deles é servida
dinamicamente pela API; os demais são valores estáveis, documentados aqui.

---

## 🔗 Endpoint

| Método | URL |
|--------|-----|
| ![GET](https://img.shields.io/badge/GET-green) | `/enumeracoes/{tipo}` |

Todos os enumeradores dinâmicos respondem no mesmo formato:

```json
[
  { "id": 1, "nome": "Descrição" }
]
```

### 🧪 Exemplo de cURL

```bash
curl -X GET "https://api.vehub.com.br/enumeracoes/estado-civil" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"
```

---

## Enumeradores dinâmicos

### Cadastro do tomador

| Enumerador | `{tipo}` |
|---|---|
| Bancos | `bancos` |
| UF | `uf` |
| Tipo de endereço | `tipo-endereco` |
| Estado civil | `estado-civil` |
| Escolaridade | `escolaridade` |
| Categoria de CNH | `cnh` |
| Nacionalidade | `nacionalidade` |
| Sexo | `sexo` |
| Ocupação (CBO) | `ocupacoes` |
| Porte da empresa | `porte-empresa` |
| Natureza jurídica | `natureza-juridica` |
| Ramo de atividade | `ramo-atividade` |
| Tipo de conta bancária | `tipo-conta-bancaria` |
| Situação de renda | `situacao-renda` |

### Operação

| Enumerador | `{tipo}` |
|---|---|
| Tipo de documento | `tipo-documento` |
| Tipo de garantia | `tipo-garantia` |
| Tipo de simulação | `tipo-simulacao` |
| Destinatário do desembolso | `destinatario-desembolso` |
| Modalidade Bacen | `modalidade-bacen` |

### Status

Necessários para traduzir os códigos que a API devolve:

| Enumerador | `{tipo}` |
|---|---|
| Status do contrato / proposta | `status-contrato` |
| Status da parcela | `status-parcela` |
| Status da análise de crédito | `status-proposta-credito` |
| Status da assinatura | `status-assinatura` |
| Método de assinatura | `metodo-assinatura` |
| Plataforma de assinatura | `plataforma-assinatura` |

> **Prefira o endpoint dinâmico** para listas de cadastro (bancos, ocupações, UF). Elas mudam sem
> versionamento da API. As tabelas estáticas abaixo existem para os enumeradores cujo valor é
> estrutural e aparece em regras de negócio.

---

## Enumeradores estáticos

### Tipo de pessoa

| Código | Descrição |
|--------|-----------|
| `1` | Pessoa física |
| `2` | Pessoa jurídica |

Usado em `tomador.tipo` e em `tipoPessoa` na simulação avulsa.

---

### Tipo de pessoa permitida (esteira)

| Código | Descrição |
|--------|-----------|
| `0` | Ambos |
| `1` | Somente pessoa física |
| `2` | Somente pessoa jurídica |

Devolvido em `operacao.tipoPessoaPermitida` nos parâmetros da esteira. Criar proposta com tipo não
permitido resulta em `422`.

---

### Tipo de simulação

| Código | Descrição |
|--------|-----------|
| `1` | Por valor financiado (padrão) |
| `2` | Por valor da parcela |

O código `3` está **reservado** para um modo futuro que descobre a taxa a partir do valor financiado
e do valor da parcela. Não o utilize.

> O modo `2` **não suporta fluxo irregular**. Ver
> [5.2. Fluxo Regular e Irregular](../5.%20Simulação/5.2.%20Fluxo%20Regular%20e%20Irregular.md).

---

### Tipo de conta bancária

| Código | Descrição |
|--------|-----------|
| `1` | Poupança |
| `2` | Corrente |

---

### Destinatário do desembolso

| Código | Descrição |
|--------|-----------|
| `1` | Emitente — o valor vai para a conta do tomador |
| `2` | Parceiro — o valor vai para a conta do parceiro originador |

Só produz efeito em **CDC**. Em EP o campo é sempre `null`.

---

### Status do contrato e da proposta

Os valores usados no fluxo de crédito:

| Código | Descrição | Terminal? |
|--------|-----------|-----------|
| `1` | Em digitação | |
| `5` | Aguardando assinaturas | |
| `6` | Finalizado | ✅ |
| `7` | Cancelado | ✅ |
| `9` | Falha na inclusão da proposta | |
| `10` | Falha na simulação | |
| `13` | Aguardando motor de crédito | |
| `14` | Enviando proposta | |
| `16` | Retorno do motor de crédito recebido | |

> A enumeração completa (`status-contrato`) contém valores usados por outros produtos da
> plataforma. Os códigos acima são os que uma operação de EP ou CDC assume. Ver o diagrama de
> estados em [1.3. Operações Assíncronas](../1.%20Início/1.3.%20Operações%20Assíncronas.md).

---

### Status da análise de crédito

| Código | Descrição | Permite enviar a proposta? |
|--------|-----------|-----------------------------|
| `4` | Recusado | ❌ |
| `6` | Aprovado | ✅ |
| `7` | Aprovado com alteração | ✅ |
| `11` | Pendente | ❌ |
| `27` | Cancelado | ❌ |

---

### Tipo de garantia

| Código | Descrição |
|--------|-----------|
| `1` | Cessão fiduciária |
| `2` | Alienação fiduciária |
| `3` | Hipoteca |
| `4` | Fiador — pessoa física |
| `5` | Fiador — pessoa jurídica |
| `6` | Estoque ou maquinário |
| `7` | Outros |
| `8` | Recebíveis |
| `9` | Imóvel |
| `10` | Veículo |
| `11` | Devedor solidário |

Os tipos efetivamente aceitos nas esteiras de crédito estão documentados em
[6.5. Garantias](../6.%20Proposta/6.5.%20Garantias.md). O tipo `4` é o usado pela etapa de
[avalistas](../6.%20Proposta/6.4.%20Avalistas.md).

---

### Tipo de documento

Os tipos que aparecem na coleta de documentos de crédito:

| Código | Descrição |
|--------|-----------|
| `42` | Documento de identificação |
| `43` | Comprovante de residência |
| `44` | Comprovante de renda |
| `45` | Estatuto / ata social |
| `52` | Contrato social |
| `57` | Contrato ou estatuto social |

A lista exigida em cada proposta é definida pela plataforma — ver
[6.6. Documentos](../6.%20Proposta/6.6.%20Documentos.md).

---

### Assinatura

**Plataforma** (`operacao.assinatura.idPlataformaAssinatura`):

| Código | Descrição |
|--------|-----------|
| `1` | Sem integração |
| `2` | FlixSign |
| `3` | Certisign |

**Modalidade** (`operacao.assinatura.modalidadeAssinatura`):

| Código | Descrição |
|--------|-----------|
| `1` | Certificado digital |
| `2` | Assinatura eletrônica |
| `3` | Assinatura eletrônica com biometria facial |

**Método por assinante** (`idMetodoAssinatura` em [6.9](../6.%20Proposta/6.9.%20Assinantes%20e%20CCB.md)):

| Código | Descrição |
|--------|-----------|
| `1` | Digital |
| `2` | Eletrônica |

**Status da assinatura**:

| Código | Descrição |
|--------|-----------|
| `1` | Pendente |
| `2` | Assinado |
| `3` | Rejeitado |

---

### Situação de renda

!!! info "Valores a confirmar"
    Este enumerador está em desenvolvimento. Consulte `GET /enumeracoes/situacao-renda` para os
    valores vigentes antes de fixá-los no seu código. A semântica está descrita em
    [4.2. Pessoa Física e Situação de Renda](../4.%20Tomador/4.2.%20Pessoa%20Física%20e%20Situação%20de%20Renda.md).

| Código | Descrição |
|--------|-----------|
| `1` | Com vínculo empregatício |
| `2` | Sem vínculo empregatício |
| `3` | Sem renda |