API CADIN CREDORA
Procuradoria-Geral da Fazenda Nacional (PGFN)
PGFN/PGDAU
Versão 2.0 - 08/08/2025
Api para gerenciamento de cadastro para acesso por entidades credoras
1. Principais Funcionalidades
Realiza ação em um registro na base de dados de devedores.:
Realiza uma ação de baixa, suspensão ou reativação em um registro na base de dados de devedores.
cadastro-conectagov/apirest/registro/{numeroTransacao}/{operacao}
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
numeroTransacao |
Número da transação a ser afetada |
|
acao |
Ação a ser realizada no registro: baixar, reativar, suspender |
|
motivo |
Motivo causador da ação |
|
Parâmetros de Saída |
|
|
code |
Código HTTP de retorno: 202: Sucesso 400: Erro de cadastro |
|
|
403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Altera um registro na base de dados de devedores:
Baixa um registro na base de dados de devedores.
cadastro-conectagov/apirest/registro/{numeroTransacao}/alterar
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
numeroTransacao |
Número da transação a ser afetada |
|
motivo |
Motivo da alteração no registro Nome do devedor |
|
nome |
|
|
Parâmetros de Saída |
|
|
code |
Código HTTP de retorno: 202: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Inclui um ou mais registros na base de dados de devedores:
Inclui um ou mais registros na base de dados de devedores (limite de 250 a cada requisição).
cadastro-conectagov/apirest/registro/{origem}/registrar
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
origem |
Código de origem da entidade credora |
|
tipoCpfCnpj |
Se o Número de identificação do contribuinte no Cadin é um CPF (1) ou CNPJ (2) |
|
cpf_cnpj |
Número de identificação do contribuinte no Cadin |
|
nome |
Nome |
|
numeroReferencia |
Número de referência da dívida na entidade credora |
|
complementoReferencia |
Complemento da referência |
|
dataComunicacao |
Data da comunicação do débito |
|
dataInadimplencia |
Data que deu origem ao débito |
|
isn |
Número de controle da credora |
|
Parâmetros de Saída |
|
|
code |
Código HTTP de retorno: 201: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Consulta todos os registros armazenados para a origem, ni e referência:
Retorna as informações de registro na situação atual para a origem, o ni e a referência. cpf_cnpj define se a busca será por 'cpf' ou 'cnpj'.
cadastro-conectagov/apirest/registro/{origem}/{ni}/{referencia}/{cpf_cnpj}
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
origem |
Código de origem da entidade credora |
|
ni |
Número de identificação do contribuinte no Cadin |
|
referencia |
Número de referência da dívida na entidade credora |
|
cpf_cnpj |
Define se a busca será por 'cpf' ou 'cnpj' |
|
Parâmetros de Saída |
|
|
cpfCnpj |
Número de identificação do contribuinte no Cadin |
|
tipoCpfCnpj |
Se o Número de identificação do contribuinte no Cadin é um CPF (1) ou CNPJ (2) |
|
nome |
Nome referente ao registro |
|
numeroTransacao |
Número da transação como registrado no Cadin |
|
numeroReferencia |
Número de referência da dívida na entidade credora |
|
complementoReferencia |
Complemento da referência |
|
dataComunicacao |
Data da comunicação do débito |
|
dataInadimplencia |
Data que deu origem ao débito |
|
origem |
Código de origem da entidade credora |
|
dataAtualizacao |
Data da última atualização |
|
motivo |
Motivo da atualização, se houver |
|
tipoAtualizacao |
Tipo da última atualização realizada no registro |
|
situacao |
Situação atual do registro (Ativo, Baixado, Suspenso) |
|
nomeInstituicao |
Nome da instituição |
|
instrucoes |
Instruções de regularização, conforme cadastro pela instituição |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 404: Nenhum registro encontrado 500: Erro interno |
Consulta todos os registros armazenados pelo número de transação:
Retorna as informações de devedores pelo número de transação na situação atual.
cadastro-conectagov/apirest/registro/{transacao}/transacao
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
transacao |
Número da transação a ser consultada |
|
Parâmetros de Saída |
|
|
cpfCnpj |
Número de identificação do contribuinte no Cadin |
|
tipoCpfCnpj |
Se o Número de identificação do contribuinte no Cadin é um CPF (1) ou CNPJ (2) |
|
nome |
Nome referente ao registro |
|
numeroTransacao |
Número da transação como registrado no Cadin |
|
numeroReferencia |
Número de referência da dívida na entidade credora |
|
complementoReferencia |
Complemento da referência |
|
dataComunicacao |
Data da comunicação do débito |
|
dataInadimplencia |
Data que deu origem ao débito |
|
origem |
Código de origem da entidade credora |
|
dataAtualizacao |
Data da última atualização |
|
motivo |
Motivo da atualização, se houver |
|
tipoAtualizacao |
Tipo da última atualização realizada no registro |
|
situacao |
Situação atual do registro (Ativo, Baixado, Suspenso) |
|
nomeInstituicao |
Nome da instituição |
|
instrucoes |
Instruções de regularização, conforme cadastro pela instituição |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 404: Nenhum registro encontrado 500: Erro interno |
Consulta todos os registros armazenados pelo número de transação:
Retorna as informações de devedores pelo número de transação com o histórico. cadastro-conectagov/apirest/registro/{transacao}/transacao/historico
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
transacao |
Número da transação a ser consultada |
|
Parâmetros de Saída |
|
|
cpfCnpj |
Número de identificação do contribuinte no Cadin |
|
tipoCpfCnpj |
Se o Número de identificação do contribuinte no Cadin é um CPF (1) ou CNPJ (2) |
|
|
nome |
Nome referente ao registro |
|
|
numeroTransacao |
Número da transação como registrado no Cadin |
|
|
numeroReferencia |
Número de referência da dívida na entidade credora |
|
|
complementoReferencia |
Complemento da referência |
|
|
dataComunicacao |
Data da comunicação do débito |
|
|
dataInadimplencia |
Data que deu origem ao débito |
|
|
origem |
Código de origem da entidade credora |
|
|
nomeInstituicao |
Nome da instituição |
|
|
instrucoes |
Instruções de regularização, conforme cadastro pela instituição |
|
|
Transaçoes |
||
|
|
dataAtualizacao |
Data da última atualização |
|
motivo |
Motivo da atualização, se houver |
|
|
tipoAtualizacao |
Tipo da última atualização realizada no registro |
|
|
situacao |
Situação atual do registro (Ativo, Baixado, Suspenso) |
|
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 404: Nenhum registro encontrado 500: Erro interno |
|
Consulta todos os registros armazenados para o CPF:
Retorna as informações de devedores por CPF na situação atual. cadastro-conectagov/apirest/registro/{cpf}/cpf
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
cpf |
Número de identificação do contribuinte no Cadin |
|
Parâmetros de Saída |
|
|
cpfCnpj |
Número de identificação do contribuinte no Cadin |
|
tipoCpfCnpj |
Se o Número de identificação do contribuinte no Cadin é um CPF (1) ou CNPJ (2) |
|
nome |
Nome referente ao registro |
|
numeroTransacao |
Número da transação como registrado no Cadin |
|
numeroReferencia |
Número de referência da dívida na entidade credora |
|
complementoReferencia |
Complemento da referência |
|
dataComunicacao |
Data da comunicação do débito |
|
dataInadimplencia |
Data que deu origem ao débito |
|
origem |
Código de origem da entidade credora |
|
dataAtualizacao |
Data da última atualização |
|
motivo |
Motivo da atualização, se houver |
|
tipoAtualizacao |
Tipo da última atualização realizada no registro |
|
situacao |
Situação atual do registro (Ativo, Baixado, Suspenso) |
|
nomeInstituicao |
Nome da instituição |
|
instrucoes |
Instruções de regularização, conforme cadastro pela instituição |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 404: Nenhum registro encontrado 500: Erro interno |
Consulta informações por CPF para obter o histórico:
Retorna as informações de devedores por CPF com o histórico.
cadastro-conectagov/apirest/registro/{cpf}/cpf/historico
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
transacao |
Número da transação a ser consultada |
|
Parâmetros de Saída |
|
|
cpfCnpj |
Número de identificação do contribuinte no Cadin |
|
tipoCpfCnpj |
Se o Número de identificação do contribuinte no Cadin é um CPF (1) ou CNPJ (2) |
|
nome |
Nome referente ao registro |
|
numeroTransacao |
Número da transação como registrado no Cadin |
|
numeroReferencia |
Número de referência da dívida na entidade credora |
|
complementoReferencia |
Complemento da referência |
|
dataComunicacao |
Data da comunicação do débito |
|
dataInadimplencia |
Data que deu origem ao débito |
|
origem |
Código de origem da entidade credora |
|
|
nomeInstituicao |
Nome da instituição |
|
|
instrucoes |
Instruções de regularização, conforme cadastro pela instituição |
|
|
Transaçoes |
||
|
|
dataAtualizacao |
Data da última atualização |
|
motivo |
Motivo da atualização, se houver |
|
|
tipoAtualizacao |
Tipo da última atualização realizada no registro |
|
|
situacao |
Situação atual do registro (Ativo, Baixado, Suspenso) |
|
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 404: Nenhum registro encontrado 500: Erro interno |
|
Consulta todos os registros armazenados para o CNPJ:
Retorna as informações de devedores por CNPJ na situação atual.
cadastro-conectagov/apirest/registro/{cnpj}/cnpj
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
cnpj |
Número de identificação do contribuinte no Cadin |
|
Parâmetros de Saída |
|
|
cpfCnpj |
Número de identificação do contribuinte no Cadin |
|
tipoCpfCnpj |
Se o Número de identificação do contribuinte no Cadin é um CPF (1) ou CNPJ (2) |
|
nome |
Nome referente ao registro |
|
numeroTransacao |
Número da transação como registrado no Cadin |
|
numeroReferencia |
Número de referência da dívida na entidade credora |
|
complementoReferencia |
Complemento da referência |
|
dataComunicacao |
Data da comunicação do débito |
|
dataInadimplencia |
Data que deu origem ao débito |
|
origem |
Código de origem da entidade credora |
|
dataAtualizacao |
Data da última atualização |
|
motivo |
Motivo da atualização, se houver |
|
tipoAtualizacao |
Tipo da última atualização realizada no registro |
|
situacao |
Situação atual do registro (Ativo, Baixado, Suspenso) |
|
nomeInstituicao |
Nome da instituição |
|
instrucoes |
Instruções de regularização, conforme cadastro pela instituição |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 404: Nenhum registro encontrado 500: Erro interno |
Consulta informações por CNPJ para obter o histórico:
Retorna as informações de devedores por CNPJ com o histórico.
cadastro-conectagov/apirest/registro/{cnpj}/cnpj/historico
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
transacao |
Número da transação a ser consultada |
|
Parâmetros de Saída |
|
|
cpfCnpj |
Número de identificação do contribuinte no Cadin |
|
tipoCpfCnpj |
Se o Número de identificação do contribuinte no Cadin é um CPF (1) ou CNPJ (2) |
|
nome |
Nome referente ao registro |
|
numeroTransacao |
Número da transação como registrado no Cadin |
|
numeroReferencia |
Número de referência da dívida na entidade credora |
|
complementoReferencia |
Complemento da referência |
|
dataComunicacao |
Data da comunicação do débito |
|
dataInadimplencia |
Data que deu origem ao débito |
|
origem |
Código de origem da entidade credora |
|
nomeInstituicao |
Nome da instituição |
|
instrucoes |
Instruções de regularização, conforme cadastro pela instituição |
|
Transaçoes |
|
|
dataAtualizacao |
Data da última atualização |
|
motivo |
Motivo da atualização, se houver |
|
|
tipoAtualizacao |
Tipo da última atualização realizada no registro |
|
|
situacao |
Situação atual do registro (Ativo, Baixado, Suspenso) |
|
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 404: Nenhum registro encontrado 500: Erro interno |
|
Download do arquivo de retorno de uma remessa:
Consulta o arquivo de retorno de uma remessa por número de remessa e origem.
cadastro-conectagov/download/{numeroRemessa}/{origem}
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
numeroRemessa |
Número da Remessa |
|
origem |
Código da Origem |
|
Parâmetros de Saída |
|
|
code |
Código HTTP de retorno 200: Arquivo encontrado com sucesso - Arquivo de retorno para download (application/octet-stream) 400: Arquivo não gerado. Retorna mensagem com status atual - { "erro": 0, "mensagem": "string" } 403: Usuário sem autorização no Conecta.Gov 404: Nenhum arquivo encontrado para a remessa informada 500: Erro interno |
Download do Delta da Base:
Download do Delta da Base
cadastro-conectagov/apirest/registro/downloadSituacaoAtual/{data}
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
data |
Data do delta (Ex: 2023-11-01) |
|
Parâmetros de Saída |
|
|
code |
Código HTTP de retorno: 200: Arquivo encontrado com Sucesso 404: Nenhum arquivo encontrado 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Consulta a situação atual do cidadão através do seu CPF (não tem restrição de origens):
Retorna a situação atual do cidadão, se regular ou irregular.
cadastro-conectagov/apirest/registro/info/{cpf}/cpf
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
cpf |
Número do CPF a ser consultado |
|
Parâmetros de Saída |
|
|
nome |
Nome que está cadastrado no sistema como associado ao CPF solicitado |
|
cpf |
Número do CPF consultado |
|
situação |
Situação do CPF consultado |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Consulta a situação atual da empresa através do seu CNPJ:
Retorna a situação atual da empresa, se regular ou irregular.
cadastro-conectagov/apirest/registro/info/{cnpj}/cnpj
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
cnpj |
Número do CNPJ a ser consultado |
|
Parâmetros de Saída |
|
|
razaoSocial |
Razão social que está cadastrada no sistema como associado ao CNPJ solicitado |
|
cnpj |
Número do CNPJ consultado |
|
situacao |
Indica se o CNPJ solicitado possui alguma pendência no sistema Cadin. Retorna “regular” ou “irregular” |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Consulta todos os registros armazenados para o CPF com a União:
Retorna as informações de devedores por CPF para dívidas com a União.
cadastro-conectagov/apirest/registro/consultaCompleta/{cpf}/cpf
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
cpf |
Número do CPF a ser consultado |
|
Parâmetros de Saída |
|
|
nome |
Nome que está cadastrado no sistema como associado ao CPF solicitado |
|
cpfCnpj |
Número do CPF/CNPJ consultado |
|
numeroReferencia |
Número de referência do registro |
|
complementoReferencia |
Complemento da referência do registro |
|
dataComunicacao |
Data de comunicação |
|
dataRegistro |
Data de criação do registro |
|
nomeInstituicao |
Nome da instituição responsável pelo registro |
|
origem |
Origem da instituição responsável pelo registro |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Consulta todos os registros armazenados para o CNPJ com a União:
Retorna as informações de devedores por CNPJ para dívidas com a União.
cadastro-conectagov/apirest/registro/consultaCompleta/{cnpj}/cnpj
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
cnpj |
Número do CNPJ a ser consultado |
|
Parâmetros de Saída |
|
|
nome |
Nome que está cadastrado no sistema como associado ao CPF solicitado |
|
cpfCnpj |
Número do CPF/CNPJ consultado |
|
numeroReferencia |
Número de referência do registro |
|
complementoReferencia |
Complemento da referência do registro |
|
dataComunicacao |
Data de comunicação |
|
dataRegistro |
Data de criação do registro |
|
nomeInstituicao |
Nome da instituição responsável pelo registro |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Consulta a situação atual para o CPF para o ente federativo solicitado:
Retorna a situação atual para o CPF de acordo com o ente federativo solicitado, se regular ou irregular. As informações sempre retornam dados da União.
cadastro-conectagov/apirest/registro/info/{cpf}/cpf/enteFederativo
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
cpf |
Número do CPF a ser consultado |
|
enteFederativo |
Ente federativo para o qual a consulta será realizada |
|
Parâmetros de Saída |
|
|
nome |
Nome que está cadastrado no sistema como associado ao CPF solicitado |
|
cpf |
Número do CPF consultado |
|
situação |
Situação do CPF consultado |
|
nivelFederativo |
Nível federativo do registro |
|
enteFederativo |
Ente federativo responsável pelo registro |
|
descricaoConvenio |
Descrição do convênio responsável pelo Registro |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Consulta a situação atual para o CNPJ para o ente federativo solicitado:
Retorna a situação atual para o CNPJ de acordo com o ente federativo solicitado, se regular ou irregular. As informações sempre retornam dados da União.
cadastro-conectagov/apirest/registro/info/{cnpj}/cnpj/enteFederativo
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
cnpj |
Número do CNPJ a ser consultado |
|
enteFederativo |
Ente federativo para o qual a consulta será realizada |
|
Parâmetros de Saída |
|
|
razaoSocial |
Razão social que está cadastrada no sistema como associado ao CNPJ solicitado |
|
cnpj |
Número do CNPJ consultado |
|
situacao |
Indica se o CNPJ solicitado possui alguma pendência no sistema Cadin. Retorna “regular” ou “irregular” |
|
nivelFederativo |
Nível federativo do registro |
|
enteFederativo |
Ente federativo responsável pelo registro |
|
descricaoConvenio |
Descrição do convênio responsável pelo Registro |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Consulta todos os entes federativos:
Retorna as informações dos entes federativos que celebraram convênio com o Cadin.
cadastro-conectagov/apirest/registro/enteFederativo
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
|
|
|
Parâmetros de Saída |
|
|
numeroConvenio |
Número do convênio firmado entre o ente e o CADIN |
|
descricao |
Descrição do convênio |
|
cnpjEntePrincipal |
CNPJ do ente principal ao que o ente se relaciona |
|
enteFederativo |
Ente federativo |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Consulta todos os registros armazenados para o CPF para o ente federativo solicitado:
Retorna as informações de devedores por CPF na situação atual de acordo com o ente federativo solicitado, se regular ou irregular. As informações sempre retornam dados da União.
cadastro-conectagov/apirest/registro/consultaCompleta/{cpf}/ cpf/enteFederativo
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
cpf |
Número do CPF a ser consultado |
|
enteFederativo |
Ente federativo para o qual a consulta será realizada |
|
Parâmetros de Saída |
|
|
nome |
Nome que está cadastrado no sistema como associado ao CPF solicitado |
|
cpfCnpj |
Número do CPF/CNPJ consultado |
|
numeroReferencia |
Número de referência do registro |
|
complementoReferencia |
Complemento da referência do registro |
|
dataComunicacao |
Data de comunicação |
|
dataRegistro |
Data de criação do registro |
|
nomeInstituicao |
Nome da instituição responsável pelo registro |
|
origem |
Origem da instituição responsável pelo registro |
|
nivelFederativo |
Nível federativo do registro |
|
enteFederativo |
Ente federativo responsável pelo registro |
|
descricaoConvenio |
Descrição do convênio responsável pelo Registro |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
Consulta todos os registros armazenados para o CNPJ para o ente federativo solicitado:
Retorna as informações de devedores por CNPJ na situação atual de acordo com o ente federativo solicitado, se regular ou irregular. As informações sempre retornam dados da União.
cadastro-conectagov/apirest/registro/consultaCompleta/{cnpj}/cnpj/enteFederativo
|
Atributo |
Descrição de Negócio |
|
Parâmetros de Entrada |
|
|
cnpj |
Número do CNPJ a ser consultado |
|
enteFederativo |
Ente federativo para o qual a consulta será realizada |
|
Parâmetros de Saída |
|
|
nome |
Nome que está cadastrado no sistema como associado ao CPF solicitado |
|
cpfCnpj |
Número do CPF/CNPJ consultado |
|
numeroReferencia |
Número de referência do registro |
|
complementoReferencia |
Complemento da referência do registro |
|
dataComunicacao |
Data de comunicação |
|
dataRegistro |
Data de criação do registro |
|
nomeInstituicao |
Nome da instituição responsável pelo registro |
|
origem |
Origem da instituição responsável pelo registro |
|
nivelFederativo |
Nível federativo do registro |
|
enteFederativo |
Ente federativo responsável pelo registro |
|
descricaoConvenio |
Descrição do convênio responsável pelo Registro |
|
code |
Código HTTP de retorno: 200: Sucesso 400: Erro de cadastro 403: Usuário sem autorização no Conecta.Gov 500: Erro interno |
1. Indique seu interesse.
Indique seu interesse enviando um e-mail para o endereço cadin.pgdau@pgfn.gov.br e cda.pgfn@pgfn.gov.br.
2. Preencha, assine e encaminhe a adesão
Você receberá a minuta do ofício de adesão ao Conecta, que deverá ser preenchida, assinada e devolvida para o endereço do e-mail recebido. Ressaltamos os seguintes pontos relativos ao ofício de adesão:
- é preciso a definição clara da finalidade do uso dos dados, de acordo com a Lei Geral de Proteção de Dados Pessoais (LGPD);
- não é necessária a análise jurídica;
- deve ser assinado pelo Dirigente de TI e Responsável Técnico;
- deve haver definição da volumetria anual desejada (de 01/01 a 31/12);
- o ofício de adesão pode incluir outras APIs disponibilizadas pelo Conecta.
3. Esclareça eventuais dúvidas
O Conecta enviará sua solicitação de autorização de acesso para o órgão cedente dos dados, que poderá entrar em contato direto com o órgão solicitante para esclarecer eventuais dúvidas pertinentes à autorização.
4. Receba o resultado da solicitação
Após análise do órgão cedente, o Conecta enviará e-mail com ofício indicando se a solicitação de autorização de acesso à API foi deferida ou não. Em caso de deferimento, serão enviadas também orientações técnicas para acesso à plataforma e geração da chave de acesso para consumo da API. Em caso de indeferimento, o órgão receberá a justificativa.
Não
Endpoint Homologação:
Endpoints Access Token
-
Endpoint Access Token URL de Produção: https://apigateway.conectagov.estaleiro.serpro.gov.br/oauth2/jwt-token
-
Endpoint Access Token URL de Homologação: https://h-apigateway.conectagov.estaleiro.serpro.gov.br/oauth2/jwt-token
Endpoints APIs
-
Endpoint Produção API Consulta Contratante: https://apigateway.conectagov.estaleiro.serpro.gov.br/api-cadin-consulta-contratante/v1
-
Endpoint Produção API Consulta Credora : https://apigateway.conectagov.estaleiro.serpro.gov.br/api-cadin-consulta-credora/v1
-
Endpoint Homologação API Consulta Contratante: https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-cadin-consulta-contratante/v1
-
Endpoint Homologação API Consulta Credora: https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-cadin-consulta-credora/v1
Para gerar o token de acesso favos seguir as orientações do seguinte endereço: https://gerenciador-conecta.readthedocs.io/outras_informacoes_tecnicas.html
FAQ - Acesse o link abaixo se está com problema para acessar a API
Swagger
SWAGGER
TECNOLOGIAS
JSON
TAGS
SEGURANÇA
SSL
SEGURANÇA
DISPONIBILIDADE
O serviço ficará disponível 24 horas por 7 dias
DISPONIBILIDADE
- A carga máxima de acessos é de 1000 acessos simultâneos
- Em caso de falhas o tempo de retorno esperado é de 2 horas
CONTROLE DE ACESSO
Outro
CONTROLE DE ACESSO
Hospedagem
SERPRO
