API REST v1.0.0

Documentação da API

API para integração e análise de dados do eSocial

Como Obter Acesso à API
Processo em 3 etapas para integração completa com a plataforma
1

Solicitar Credenciais

Entre em contato para solicitar credenciais específicas do seu estado

2

Gerar API Key

Com as credenciais, cada estado pode emitir sua própria API key para autenticação

3

Submeter Dados

Use a API key para enviar os arquivos XML do eSocial e acessar análises

Importante

Após receber as credenciais da plataforma, cada estado poderá gerar e gerenciar suas próprias API keys através do painel administrativo. As keys são específicas por estado e garantem isolamento e segurança dos dados.

Arquivos eSocial Necessários
Eventos do eSocial que devem ser submetidos via API para análise completa dos dados
CódigoNomeDescriçãoStatus
S-1000EmpregadoresInformações do empregador/contribuinte/órgão públicoObrigatório
S-1010RubricasTabela de rubricas (verbas/proventos/descontos)Obrigatório
S-2200Servidores Regime GeralCadastro de trabalhadores vinculados ao Regime GeralObrigatório
S-2300Servidores Regime PróprioCadastro de servidores vinculados ao RPPSObrigatório
S-1200Remunerações de Regime GeralRemuneração dos trabalhadores vinculados ao Regime Geral de Previdência Social (RGPS)Obrigatório
S-1202Remunerações de RGPS sem VínculoRemuneração dos trabalhadores do RGPS sem vínculo empregatícioObrigatório
Endpoints da API
Documentação completa dos endpoints disponíveis na API REST
Carregando documentação...

Para mais informações ou suporte técnico, entre em contato:

gabriel.coelho@sead.pi.gov.br