Consultar margem

POST/v1/margem/consulta

🔒 Requer Bearer token

Escopo margem:read. DB-first: reusa a consulta inicial recente do par CPF/empregador; com skip_cache=true (ou sem consulta recente) pula o cache de banco e chama o Dataprev — o que gera cobrança. Requer vínculos já listados.

Corpo da requisição

cpfstringobrigatório

CPF do trabalhador (11 dígitos)

padrão: ^\d{11}$

matriculastringobrigatório

Matrícula do trabalhador no empregador

codigo_inscricao_empregadornumberobrigatório

Tipo de inscrição do empregador (do listar vínculos). `1` = CNPJ, `2` = CPF.

numero_inscricao_empregadorstringobrigatório

Número da inscrição do empregador, exatamente como veio em `GET /v1/margem/vinculos`. É **string**: o CNPJ pode ser alfanumérico (IN RFB 2.229/2024, ex.: `R7ZW4H8H000140`) e zeros à esquerda são significativos. Máscara (`.`, `/`, `-`) é aceita e removida.

máx. 30 car. · padrão: ^[A-Z0-9]{1,30}$

skip_cachebooleanopcional

Pula o cache de banco e vai direto na Dataprev (gera cobrança), mesmo havendo uma consulta recente para o par CPF/empregador. Por padrão (`false`), reusa a consulta salva quando disponível.

Respostas

Corpo da resposta 200

cpfstringobrigatório

matriculastringobrigatório

inscricao_empregadorobjectobrigatório

codigointegerobrigatório

descricaostringobrigatório

numero_inscricao_empregadorstringobrigatório

nomestringobrigatório

sexoobjectobrigatório

codigointegerobrigatório

descricaostringobrigatório

data_nascimentostring<date>obrigatório

codigo_categoria_trabalhadorintegerobrigatório

elegivelbooleanobrigatório

motivo_inelegibilidadestringobrigatórionullable

valor_total_vencimentosnumberobrigatório

valor_base_margemnumberobrigatório

valor_margem_disponivelnumberobrigatório

data_admissaostring<date>obrigatório

data_desligamentostring<date>obrigatórionullable

codigo_motivo_desligamentointegerobrigatórionullable

pessoa_exposta_politicamenteobjectobrigatório

codigointegerobrigatório

descricaostringobrigatório

nome_empregadorstringobrigatório

nome_maestringobrigatório

pais_nacionalidadeobjectobrigatório

codigointegerobrigatório

descricaostringobrigatório

cboobjectobrigatório

codigointegerobrigatório

descricaostringobrigatório

cnaeobjectobrigatório

codigointegerobrigatório

descricaostringobrigatório

data_inicio_atividade_empregadorstring<date>obrigatório

qtd_emprestimos_ativos_suspensosintegerobrigatório

tipo_bloqueiostringobrigatórionullable

data_hora_bloqueiostring<date-time>obrigatórionullable

percentual_verba_rescisoria_disponivelnumberobrigatório

alertasarray<object>obrigatório

tipo_alertaobjectobrigatório

codigointegerobrigatório

descricaostringobrigatório

data_referenciastring<date>obrigatório

id_eventostringobrigatórionullable

codigo_motivo_afastamentointegerobrigatórionullable

data_afastamentostring<date>obrigatórionullable

data_termino_afastamentostring<date>obrigatórionullable

codigo_motivo_desligamentointegerobrigatórionullable

data_desligamentostring<date>obrigatórionullable

data_aviso_previostring<date>obrigatórionullable

data_fim_aviso_previostring<date>obrigatórionullable

emprestimos_legadosarray<object>obrigatório

codigo_ifintegerobrigatório

contratostringobrigatório

data_inicio_contratostring<date>obrigatório

data_fim_contratostring<date>obrigatório

total_parcelasintegerobrigatório

qtd_parcelas_pagasintegerobrigatório

valor_parcelanumberobrigatório

valor_emprestimonumberobrigatório

valor_liberadonumberobrigatório

data_hora_atualizacaostring<date-time>obrigatório

valor_taxa_mensalnumberobrigatório

valor_cet_mensalnumberobrigatório

tipo_contratoobjectobrigatório

codigointegerobrigatório

descricaostringobrigatório

valor_saldo_devedornumberobrigatório

consulta_margem_idstring<uuid>obrigatório

Request

curl -X POST 'https://econsignado-api.socinal.com.br/v1/margem/consulta' \
  -H 'Authorization: Bearer SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "cpf": "12345678901",
  "matricula": "string",
  "codigo_inscricao_empregador": 1,
  "numero_inscricao_empregador": "12674953000114",
  "skip_cache": false
}'

Response

{
  "cpf": "75842274574",
  "matricula": "MAT-8024716378743464",
  "inscricao_empregador": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "numero_inscricao_empregador": "12674953000114",
  "nome": "João da Silva",
  "sexo": {
    "codigo": 1,
    "descricao": "Masculino"
  },
  "data_nascimento": "1990-01-01",
  "codigo_categoria_trabalhador": 101,
  "elegivel": true,
  "motivo_inelegibilidade": null,
  "valor_total_vencimentos": 5000,
  "valor_base_margem": 1500,
  "valor_margem_disponivel": 800,
  "data_admissao": "2020-01-15",
  "data_desligamento": null,
  "codigo_motivo_desligamento": null,
  "pessoa_exposta_politicamente": {
    "codigo": 2,
    "descricao": "Não"
  },
  "nome_empregador": "Alves Teixeira - EI",
  "nome_mae": "Maria Exemplo",
  "pais_nacionalidade": {
    "codigo": 1,
    "descricao": "Brasil"
  },
  "cbo": {
    "codigo": 357105,
    "descricao": "AGENTE DE VIAGEM"
  },
  "cnae": {
    "codigo": 4711301,
    "descricao": "Comércio varejista"
  },
  "data_inicio_atividade_empregador": "2010-01-01",
  "qtd_emprestimos_ativos_suspensos": 1,
  "tipo_bloqueio": null,
  "data_hora_bloqueio": null,
  "percentual_verba_rescisoria_disponivel": 23,
  "alertas": [
    {
      "tipo_alerta": {
        "codigo": 1,
        "descricao": "Afastamento"
      },
      "data_referencia": "2026-05-22",
      "id_evento": "1318617810000002000000000000000000",
      "codigo_motivo_afastamento": 1,
      "data_afastamento": "2026-05-22",
      "data_termino_afastamento": "2026-06-22",
      "codigo_motivo_desligamento": null,
      "data_desligamento": null,
      "data_aviso_previo": null,
      "data_fim_aviso_previo": null
    }
  ],
  "emprestimos_legados": [
    {
      "codigo_if": 425,
      "contrato": "CTR-123456",
      "data_inicio_contrato": "2024-01-01",
      "data_fim_contrato": "2026-01-01",
      "total_parcelas": 24,
      "qtd_parcelas_pagas": 12,
      "valor_parcela": 150.55,
      "valor_emprestimo": 3000,
      "valor_liberado": 2950,
      "data_hora_atualizacao": "2026-05-22T14:30:00",
      "valor_taxa_mensal": 1.99,
      "valor_cet_mensal": 2.15,
      "tipo_contrato": {
        "codigo": 1,
        "descricao": "Consignado"
      },
      "valor_saldo_devedor": 1300.75
    }
  ],
  "consulta_margem_id": "6a450285-8ae3-4419-8335-0565f82d2d47"
}