A API Ceape Brasil foi desenvolvida de acordo com os melhores padrões REST.
As operações são feitas por requisições aos endpoints, de acordo com os verbos HTTP, com corpos de mensagem em JSON. As respostas podem ser interpretadas através do código de status HTTP. Isso permite que quaisquer aplicações consumam a API de forma simples e clara, independente da linguagem utilizada.
Confira a baixo a documentação
Esta é a chave criptografada que identifica um cadastro de cliente no Ceape Brasil. Qualquer requisição que envolva informações sensíveis ou modificação de registros relacionado a uma pessoa exigirá o Id do cliente (costumer_id) e também o uso desta chave (cryptKey) no parâmetro da requisição.
Para realizar qualquer requisão referente ao Endpoint Clientes é necessário que você possua o seu TOKEN API.
O seu TOKEN API deverá ser informado como parâmetro na URL da Requisição (seguindo o exemplo no tópico de Requisição)
| Nome do Parâmetro | Tipo | Obrigatório |
|---|---|---|
| tokenApi | String | SIM |
A obtenção de um cadastro de cliente é feita a partir do documento de identificação (CPF ou CNPJ) que você irá informar no parâmetro {document} da URL. Ao informar o número do documento, remova toda formatação (traços, pontos ou barras, etc.) de forma a manter apenas os números..
Atenção para o parâmetro CryptKey no retorno da requisição, pois para as demais requisições ele será necessário ser informado, na URL, como parâmetro (cryptKey).
Atenção para o parâmetro Id no retorno da requisição, pois para as demais requisições ele será necessário ser informado, na URL, como parâmetro (costumer_id).
A API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo:
{
"Id":5000,
"CryptKey":"XXXXXXXXX",
"Nome":"EDEM FERNANDO BASTOS CASTRO",
"Cpf":"XXX.XXX.XXX-XX",
"NumeroRG":"XXXXXXXXX",
"NomeMae":"FULANO DE TAL",
"Email":"[email protected]",
"Telefone":"(99) 9 9999-9999",
"Apelido":"ECASTRO",
"DataNasc":"2000-11-28T00:00:00",
"FaixaRenda":6,
"NomeConjuge":"FULANO DE TAL",
"CpfConjuge":"xxx.xxx.xx-xx",
"RgConjuge":"xxxxxxxx",
"Profissao":"Professor",
"PPE":2,
"IDExternal":"sPM5lD8HJ66y",
"CnpjEmpresa":"XX.XXX.XXX/XXXX-XX",
"Sexo":1,
"Renda":1000.00,
"TipoProfissao":5,
"EstadoCivil":4,
"CategoriaTaxa":0,
"CategoriaCliente":"SemCategoria",
"Unidade":138,
"UidIntegracao":xxxxxxxx,
"Uf":"MA",
"Cep":"XX.XXX-XXX",
"Cidade":211130,
"Bairro":"JARDIM AMÉRICA",
"Endereco":"Alameda Ever Green",
"EnderecoNumero":"nº 17",
"Complemento":"Lorem ipsum...",
"Banco":332,
"Agencia":"0001",
"AgenciaDv":"",
"TipoConta":2,
"Conta":"xxxxxxxxxxx",
"ContaDv":"x",
"PlanoID":xxxxxxx,
"PlanoValidade":"2024-06-01T00:00:00",
"PlanoValido":true,
"PlanoCobranca":"CEAPE BRASIL/CEAPE BANK",
"LkpSexo":"MASCULINO",
"LkpTipoProfissao":"Funcionário Privado",
"LkpEstadoCivil":"Separado(a)",
"LkpFaixaRenda":"De R$ 10.000,00 a R$ 20.000,00",
"LkpPPE":"Não sou e não tenho vínculo com pessoa exposta politicamente",
"LkpUnidade":"CEAPE/MA - SÃO LUÍS",
"LkpMicrorregional":"M.R. GRANDE SÃO LUIS",
"LkpRegional":"NORTE"
}
Código HTTP da Requisição: 200
{
"Id":5000,
"CryptKey":"XXXXXXXXX",
"RazaoSocial":"EMPRESA LTDA",
"NomeFantasia":"EMPRESA LTDA",
"Cnpj":"XXXXXXXXX",
"TipoEmpresa":2,
"PorteEmpresa":3,
"DataAbertura":"2000-11-28T00:00:00",
"Email":"[email protected]",
"Telefone":"(99) 9 9999-9999",
"CategoriaTaxa":0,
"Unidade":138,
"UidIntegracao":xxxxxx,
"CategoriaCliente":"SemCategoria",
"FaixaRenda":8,
"Profissao":"",
"PPE":2,
"IDExternal":"sPM5lD8HJ66y",
"Uf":"MA",
"Cep":"XX.XXX-XXX",
"Cidade":211130,
"Bairro":"JARDIM AMÉRICA",
"Endereco":"Alameda Ever Green",
"EnderecoNumero":"nº 17",
"Complemento":"Lorem ipsum...",
"Banco":332,
"Agencia":"0001",
"AgenciaDv":"",
"TipoConta":2,
"Conta":"xxxxxxxxxxx",
"ContaDv":"x",
"PlanoID":xxxxxxx,
"PlanoValidade":"2024-06-01T00:00:00",
"PlanoValido":true,
"PlanoCobranca":"CEAPE BRASIL/CEAPE BANK",
"LkpFaixaRenda":"De R$ 10.000,00 a R$ 20.000,00",
"LkpPPE":"Não sou e não tenho vínculo com pessoa exposta politicamente",
"LkpUnidade":"CEAPE/MA SÃO LUÍS",
"LkpMicrorregional":"M.R. GRANDE SÃO LUIS"
"LkpRegional":"NORTE"
}
Código HTTP da Requisição: 200
Caso não seja possivel localizar o cadastro do cliente, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Não foi possível localizar este cliente em nossa base de dados."
}
Código HTTP da Requisição: 400
O endpoint Criar Cadastro Pessoa Física, irá criar um novo cadastro caso o CPF do mesmo não exista em nossa base de dados. E retornará as informações ao solicitante da requisição.
Detalhamento dos campos a serem enviados no body da requisição:
| Nome | Tipo | Obrigatório |
|---|---|---|
| Nome | String | SIM |
| Cpf | String | SIM |
| Telefone | String | SIM |
String | SIM | |
| DataNasc | DateTime | NÃO |
| NomeMae | String | NÃO |
| NumeroRg | String | NÃO |
| Sexo | Int | NÃO |
| EstadoCivil | Int | NÃO |
| TipoProfissao | Int | NÃO |
| Profissao | String | NÃO |
| FaixaRenda | Int | NÃO |
| Renda | Double | NÃO |
| PPE | Int | NÃO |
| IDExternal | String | NÃO |
| CnpjEmpresa | String | NÃO |
| Uf | String | NÃO |
| Cep | String | NÃO |
| Cidade | Int | NÃO |
| Bairro | String | NÃO |
| Endereco | String | NÃO |
| EnderecoNumero | String | NÃO |
| Complemento | String | NÃO |
| Banco | Int | NÃO |
| Agencia | String | NÃO |
| AgenciaDv | String | NÃO |
| TipoConta | Int | NÃO |
| Conta | String | NÃO |
| ContaDv | String | NÃO |
Segue a descrição dos campos para criar/atualizar um registro de Conta Bancária:
| Nome | Descrição |
|---|---|
| Banco | refere-se ao código do banco do cliente. Para obter a lista de código de banco consulte o Endpoint Resources |
| Agencia | refere-se ao número da agência do banco do cliente |
| AgenciaDv | refere-se ao dígito verificador do número da agência do banco do cliente |
| TipoConta | refere-se ao tipo da conta bancária do cliente (1 - Conta corrente, 2 - Conta Poupança, 3 - Conta Salário) |
| Conta | refere-se ao número da conta do banco do cliente |
| ContaDv | refere-se ao dígito verificador da conta do banco do cliente |
Segue a relação dos códigos para o campo Sexo:
| Codigo | Descrição |
|---|---|
| 1 | MASCULINO |
| 2 | FEMININO |
| 3 | OUTRO(S) |
Segue a relação dos códigos para o campo EstadoCivil:
| Codigo | Descrição |
|---|---|
| 1 | Amigado(a) |
| 2 | Casado(a) |
| 3 | Divorciado(a) |
| 4 | Separado(a) |
| 5 | Solteiro(a) |
| 6 | Viúvo(a) |
Segue a relação dos códigos para o campo TipoProfissao:
| Codigo | Descrição |
|---|---|
| 1 | Empreendedor/Prospecto |
| 2 | Funcionário do Empreendedor |
| 3 | Conjuge/Filho do Empreedendor |
| 4 | Funcionário Público |
| 5 | Funcionário Privado |
| 6 | Empreendedor com Renda Comprovada |
Segue a relação dos códigos para o campo FaixaRenda:
| Codigo | Descrição |
|---|---|
| 1 | Até R$ 1.000,00 |
| 2 | De R$ 1.000,00 a R$ 2.000,00 |
| 3 | De R$ 2.000,00 a R$ 3.000,00 |
| 4 | De R$ 3.000,00 a R$ 5.000,00 |
| 5 | De R$ 5.000,00 a R$ 10.000,00 |
| 6 | De R$ 10.000,00 a R$ 20.000,00 |
| 7 | Acima de R$ 20.000,00 |
| 20 | Até 50 mil |
| 21 | Mais de 50 mil até 100 mil |
| 22 | Mais de 100 mil até 250 mil |
| 23 | Mais de 250 mil até 500 mil |
| 24 | Mais de 500 mil até 1 milhão |
| 25 | Mais de 1 milhão até 2,5 milhões |
| 26 | Mais de 2,5 milhões até 5 milhões |
| 27 | Mais de 5 milhões até 10 milhões |
| 28 | Mais de 10 milhões até 25 milhões |
| 29 | Mais de 25 milhões até 50 milhões |
| 30 | Mais de 50 milhões até 100 milhões |
| 31 | Mais de 100 milhões até 250 milhões |
| 32 | Mais de 250 milhões até 500 milhões |
| 33 | Mais de 500 milhões |
| 34 | Não declarado |
| 35 | Empresa isenta |
| 36 | Empresa Inativa |
Segue a relação dos códigos para o campo PPE (Pessoa politicamente exposta):
| Codigo | Descrição |
|---|---|
| 1 | Não sou e não tenho vínculo com pessoa exposta politicamente |
| 2 | Sou pessoa politicamente exposta |
| 3 | Tenho vínculo familiar, sociedade ou sou estreito colaborador de pessoa exposta politicamente |
Caso o cliente possua uma empresa, você poderá informar o CNPJ da empresa no campo CnpjEmpresa. Esse campo por sua vez não é obrigatório.
Segue abaixo um exemplo do JSON a ser enviado na requisição
{
"Nome":"EDEM FERNANDO BASTOS CASTRO",
"Cpf":"XXX.XXX.XXX-XX",
"NumeroRG":"XXXXXXXXX",
"NomeMae":"FULANO DE TAL",
"Email":"[email protected]",
"Telefone":"(99) 9 9999-9999",
"Apelido":"ECASTRO",
"DataNasc":"2000-11-28T00:00:00",
"FaixaRenda":6,
"Profissao":"Professor",
"PPE":2,
"IDExternal":"sPM5lD8HJ66y",
"CnpjEmpresa":"XX.XXX.XXX/XXXX-XX",
"Sexo":1,
"Renda":1000.00,
"TipoProfissao":5,
"EstadoCivil":4,
"Uf":"MA",
"Cep":"XX.XXX-XXX",
"Cidade":211130,
"Bairro":"JARDIM AMÉRICA",
"Endereco":"Alameda Ever Green",
"EnderecoNumero":"nº 17",
"Complemento":"Lorem ipsum...",
"Banco":332,
"Agencia":"0001",
"AgenciaDv":"",
"TipoConta":2,
"Conta":"xxxxxxxxxxx",
"ContaDv":"x",
}
Caso o registro seja criado com sucesso, a API retornará o JSON da mesma maneira demonstrada no tópico Obter Cadastro
Código HTTP da Requisição: 200
Caso não seja possivel realizar o cadastro do cliente, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Não foi possível realizar o cadastro do cliente, verifique se os dados obrigatórios estão preenchidos!"
}
{
"Message":"O CPF deste cliente já consta na base de dados! Utilize o método Editar Cadastro"
}
Código HTTP da Requisição: 400
O endpoint Criar Cadastro Pessoa Jurídica, irá criar um novo cadastro caso o CNPJ do mesmo não exista em nossa base de dados. E retornará as informações ao solicitante da requisição. Para que se possa realizar o cadastro da Pessoa Purídica será necessário que o sócio esteja previamente cadastrado em nosso sistema.
Detalhamento dos campos a serem enviados no body da requisição:
| Nome | Tipo | Obrigatório |
|---|---|---|
| CNPJ | String | SIM |
| RazaoSocial | String | SIM |
| NomeFantasia | String | SIM |
| Telefone | String | SIM |
String | SIM | |
| TipoEmpresa | Int | SIM |
| PorteEmpresa | Int | NÃO |
| DataNasc | DateTime | NÃO |
| IDExternal | String | NÃO |
| Uf | String | NÃO |
| Cep | String | NÃO |
| Cidade | Int | NÃO |
| Bairro | String | NÃO |
| Endereco | String | NÃO |
| EnderecoNumero | String | NÃO |
| Complemento | String | NÃO |
| Banco | Int | NÃO |
| Agencia | String | NÃO |
| AgenciaDv | String | NÃO |
| TipoConta | Int | NÃO |
| Conta | String | NÃO |
| ContaDv | String | NÃO |
Segue a descrição dos campos para criar/atualizar um registro de Conta Bancária:
| Nome | Descrição |
|---|---|
| Banco | refere-se ao código do banco do cliente. Para obter a lista de código de banco consulte o Endpoint Resources |
| Agencia | refere-se ao número da agência do banco do cliente |
| AgenciaDv | refere-se ao dígito verificador do número da agência do banco do cliente |
| TipoConta | refere-se ao tipo da conta bancária do cliente (1 - Conta corrente, 2 - Conta Poupança, 3 - Conta Salário) |
| Conta | refere-se ao número da conta do banco do cliente |
| ContaDv | refere-se ao dígito verificador da conta do banco do cliente |
Segue a relação dos Códigos para o campo TipoEmpresa
| Código | Descrição |
|---|
Segue a relação dos Códigos para o campo PorteEmpresa
| Código | Descrição |
|---|---|
| 1 | Microempresa |
| 2 | Empresa de pequeno porte |
| 3 | Empresa de médio porte |
| 4 | Empresa de grande porte |
Segue a relação dos códigos para o campo FaixaRenda:
| Codigo | Descrição |
|---|---|
| 1 | Até R$ 1.000,00 |
| 2 | De R$ 1.000,00 a R$ 2.000,00 |
| 3 | De R$ 2.000,00 a R$ 3.000,00 |
| 4 | De R$ 3.000,00 a R$ 5.000,00 |
| 5 | De R$ 5.000,00 a R$ 10.000,00 |
| 6 | De R$ 10.000,00 a R$ 20.000,00 |
| 7 | Acima de R$ 20.000,00 |
| 20 | Até 50 mil |
| 21 | Mais de 50 mil até 100 mil |
| 22 | Mais de 100 mil até 250 mil |
| 23 | Mais de 250 mil até 500 mil |
| 24 | Mais de 500 mil até 1 milhão |
| 25 | Mais de 1 milhão até 2,5 milhões |
| 26 | Mais de 2,5 milhões até 5 milhões |
| 27 | Mais de 5 milhões até 10 milhões |
| 28 | Mais de 10 milhões até 25 milhões |
| 29 | Mais de 25 milhões até 50 milhões |
| 30 | Mais de 50 milhões até 100 milhões |
| 31 | Mais de 100 milhões até 250 milhões |
| 32 | Mais de 250 milhões até 500 milhões |
| 33 | Mais de 500 milhões |
| 34 | Não declarado |
| 35 | Empresa isenta |
| 36 | Empresa Inativa |
Segue a relação dos códigos para o campo PPE (Pessoa politicamente exposta):
| Codigo | Descrição |
|---|---|
| 1 | Não sou e não tenho vínculo com pessoa exposta politicamente |
| 2 | Sou pessoa politicamente exposta |
| 3 | Tenho vínculo familiar, sociedade ou sou estreito colaborador de pessoa exposta politicamente |
Segue abaixo um exemplo do JSON a ser enviado na requisição
{
"RazaoSocial":"EMPRESA LTDA",
"NomeFantasia":"EMPRESA LTDA",
"Cnpj":"XXXXXXXXX",
"TipoEmpresa":2,
"PorteEmpresa":3,
"DataAbertura":"2000-11-28T00:00:00",
"Email":"[email protected]",
"Telefone":"(99) 9 9999-9999",
"FaixaRenda":8,
"Profissao":"",
"PPE":2,
"IDExternal":"sPM5lD8HJ66y",
"Uf":"MA",
"Cep":"XX.XXX-XXX",
"Cidade":211130,
"Bairro":"JARDIM AMÉRICA",
"Endereco":"Alameda Ever Green",
"EnderecoNumero":"nº 17",
"Complemento":"Lorem ipsum...",
"Banco":332,
"Agencia":"0001",
"AgenciaDv":"",
"TipoConta":2,
"Conta":"xxxxxxxxxxx",
"ContaDv":"x"
}
Caso o registro seja atualizado com sucesso, a API retornará o JSON da mesma maneira demonstrada no tópico Obter Cadastro
Código HTTP da Requisição: 200
Caso não seja possivel realizar a atualização do cadastro do cliente, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Não foi possível atualizar o cadastro, verifique se os dados obrigatórios estão preenchidos!"
}
Código HTTP da Requisição: 400
O endpoint Atualizar Cadastro, irá atualizar as informações do cliente caso o CPF do mesmo exista em nossa base de dados. E retornará as informações atualizadas ao solicitante da requisição.
Detalhamento dos campos a serem enviados no body da requisição:
| Nome | Tipo | Obrigatório |
|---|---|---|
| Nome | String | SIM |
| Cpf | String | SIM |
| Telefone | String | SIM |
String | SIM | |
| DataNasc | DateTime | NÃO |
| NomeMae | String | NÃO |
| NumeroRg | String | NÃO |
| Sexo | Int | NÃO |
| EstadoCivil | Int | NÃO |
| TipoProfissao | Int | NÃO |
| Profissao | String | NÃO |
| FaixaRenda | Int | NÃO |
| Renda | Double | NÃO |
| PPE | Int | NÃO |
| IDExternal | String | NÃO |
| CnpjEmpresa | String | NÃO |
| Uf | String | NÃO |
| Cep | String | NÃO |
| Cidade | Int | NÃO |
| Bairro | String | NÃO |
| Endereco | String | NÃO |
| EnderecoNumero | String | NÃO |
| Complemento | String | NÃO |
| Banco | Int | NÃO |
| Agencia | String | NÃO |
| AgenciaDv | String | NÃO |
| TipoConta | Int | NÃO |
| Conta | String | NÃO |
| ContaDv | String | NÃO |
Segue a descrição dos campos para criar/atualizar um registro de Conta Bancária:
| Nome | Descrição |
|---|---|
| Banco | refere-se ao código do banco do cliente. Para obter a lista de código de banco consulte o Endpoint Resources |
| Agencia | refere-se ao número da agência do banco do cliente |
| AgenciaDv | refere-se ao dígito verificador do número da agência do banco do cliente |
| TipoConta | refere-se ao tipo da conta bancária do cliente (1 - Conta corrente, 2 - Conta Poupança, 3 - Conta Salário) |
| Conta | refere-se ao número da conta do banco do cliente |
| ContaDv | refere-se ao dígito verificador da conta do banco do cliente |
Segue abaixo um exemplo do JSON a ser enviado na requisição
{
"Nome":"EDEM FERNANDO BASTOS CASTRO",
"Cpf":"XXX.XXX.XXX-XX",
"NumeroRG":"XXXXXXXXX",
"NomeMae":"FULANO DE TAL",
"Email":"[email protected]",
"Telefone":"(99) 9 9999-9999",
"Apelido":"ECASTRO",
"DataNasc":"2000-11-28T00:00:00",
"FaixaRenda":6,
"Profissao":"Professor",
"PPE":2,
"IDExternal":"sPM5lD8HJ66y",
"CnpjEmpresa":"XX.XXX.XXX/XXXX-XX",
"Sexo":1,
"Renda":1000.00,
"TipoProfissao":5,
"EstadoCivil":4,
"Uf":"MA",
"Cep":"XX.XXX-XXX",
"Cidade":211130,
"Bairro":"JARDIM AMÉRICA",
"Endereco":"Alameda Ever Green",
"EnderecoNumero":"nº 17",
"Complemento":"Lorem ipsum...",
"Banco":332,
"Agencia":"0001",
"AgenciaDv":"",
"TipoConta":2,
"Conta":"xxxxxxxxxxx",
"ContaDv":"x",
}
Caso o registro seja atualizado com sucesso, a API retornará o JSON da mesma maneira demonstrada no tópico Obter Cadastro
Código HTTP da Requisição: 200
Caso não seja possivel realizar a atualização do cadastro do cliente, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Não foi possível atualizar o cadastro, verifique se os dados obrigatórios estão preenchidos!"
}
Código HTTP da Requisição: 400
O endpoint Atualizar Cadastro Pessoa Jurídica, irá atualizar as informações do cliente PJ caso o CNPJ do mesmo exista em nossa base de dados. E retornará as informações atualizadas ao solicitante da requisição. Para que se possa realizar a atualização do cadastro da pessoa jurídica será necessário que o sócio esteja previamente cadastrado em nosso sistema.
Atenção para os parâmetro document na URL da requisição, nele deverá ser informado o CNPJ da empresa.
Atenção para os parâmetro costumer_id na URL da requisição, nele deverá ser informado o Id da empresa que deseja atualizar a informação, assim também vale para o campo cryptKey
Detalhamento dos campos a serem enviados no body da requisição:
| Nome | Tipo | Obrigatório |
|---|---|---|
| CNPJ | String | SIM |
| RazaoSocial | String | SIM |
| NomeFantasia | String | SIM |
| Telefone | String | SIM |
String | SIM | |
| TipoEmpresa | Int | SIM |
| PorteEmpresa | Int | NÃO |
| DataNasc | DateTime | NÃO |
| IDExternal | String | NÃO |
| Uf | String | NÃO |
| Cep | String | NÃO |
| Cidade | Int | NÃO |
| Bairro | String | NÃO |
| Endereco | String | NÃO |
| EnderecoNumero | String | NÃO |
| Complemento | String | NÃO |
| Banco | Int | NÃO |
| Agencia | String | NÃO |
| AgenciaDv | String | NÃO |
| TipoConta | Int | NÃO |
| Conta | String | NÃO |
| ContaDv | String | NÃO |
Segue a descrição dos campos para criar/atualizar um registro de Conta Bancária:
| Nome | Descrição |
|---|---|
| Banco | refere-se ao código do banco do cliente. Para obter a lista de código de banco consulte o Endpoint Resources |
| Agencia | refere-se ao número da agência do banco do cliente |
| AgenciaDv | refere-se ao dígito verificador do número da agência do banco do cliente |
| TipoConta | refere-se ao tipo da conta bancária do cliente (1 - Conta corrente, 2 - Conta Poupança, 3 - Conta Salário) |
| Conta | refere-se ao número da conta do banco do cliente |
| ContaDv | refere-se ao dígito verificador da conta do banco do cliente |
Segue abaixo um exemplo do JSON a ser enviado na requisição
{
"RazaoSocial":"EMPRESA LTDA",
"NomeFantasia":"EMPRESA LTDA",
"Cnpj":"XXXXXXXXX",
"TipoEmpresa":2,
"PorteEmpresa":3,
"DataAbertura":"2000-11-28T00:00:00",
"Email":"[email protected]",
"Telefone":"(99) 9 9999-9999",
"FaixaRenda":8,
"Profissao":"",
"PPE":2,
"IDExternal":"sPM5lD8HJ66y",
"Uf":"MA",
"Cep":"XX.XXX-XXX",
"Cidade":211130,
"Bairro":"JARDIM AMÉRICA",
"Endereco":"Alameda Ever Green",
"EnderecoNumero":"nº 17",
"Complemento":"Lorem ipsum...",
"Banco":332,
"Agencia":"0001",
"AgenciaDv":"",
"TipoConta":2,
"Conta":"xxxxxxxxxxx",
"ContaDv":"x"
}
Caso o registro seja atualizado com sucesso, a API retornará o JSON da mesma maneira demonstrada no tópico Obter Cadastro
Código HTTP da Requisição: 200
Caso não seja possivel realizar a atualização do cadastro do cliente, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Não foi possível atualizar o cadastro, verifique se os dados obrigatórios estão preenchidos!"
}
Código HTTP da Requisição: 400
Este endpoint retornará uma lista de propostas pré-aprovadas de acordo com o perfil do cliente. Propostas pré-aprovadas, neste contexto, são resultados de uma avaliação de crédito personalizada para uma pessoa.
Atenção para o parâmetro OfferId no retorno da requisição, pois ele será necessário para Aceitar Proposta ou Recusar Proposta, sendo informado na URL da Requisições como parâmetro (offer_id).
Atenção para o parâmetro Token no retorno da requisição, pois ele será necessário para Aceitar Proposta ou Recusar Proposta, sendo informado no corpo (body) da Requisição no parâmetro (TokenProposta).
Descrição dos campos no retorno da requisição
| Nome | Descrição |
|---|---|
| OfferId | Código da proposta na base de dados do Ceape Brasil |
| Token | Token exclusivo para uma proposta pré-aprovada |
| ValorCredito | Valor que o cliente receberá em sua conta digital |
| ValorFinanciado | Valor bruto do crédito + valor dos seguros adicionados ao crédito + Valor do IOF |
| ValorOperacaoTotal | Valor bruto que será pago pelo cliente |
| ValorDescontado | Valor líquido que será pago pelo cliente, levando em consideração os devidos descontos |
| Carencia | Intervalo de dias para o vencimento da primeira parcela do crédito |
| TaxaJuros | Taxa de Juros aplicada a operação de crédito |
| ValorParcela | Valor bruto da parcela |
| ValorParcelaDesc | Valor líquido da parcela, levando em consideração os devidos descontos |
| ValorJuros | Valor bruto dos juros aplicado ao crédito |
| ValorTac | Valor bruto referente a Taxa de Abertura de Crédito |
| ValorIOF | Valor bruto referente ao Imposto sobre Operações Financeiras |
| CheckSeguroAp1 | Referente ao Seguro Ap Plano 01 |
| CheckSeguroAp2 | Referente ao Seguro Ap Plano 02 |
| CheckSeguroAp3 | Referente ao Seguro Ap Plano 03 |
| CheckSeguroAp4 | Referente ao Seguro Ap Plano 04 |
| CheckSeguroAp5 | Referente ao Seguro Ap Plano 05 |
| CheckSeguroLar1 | Referente ao Seguro LAR Protegido 01 |
| CheckSeguroLar2 | Referente ao Seguro LAR Protegido 02 |
| CheckSeguroLar3 | Referente ao Seguro LAR Protegido 03 |
| CheckSeguroTele1 | Referente ao Seguro Tele Medicina 01 |
| CheckSeguroTele2 | Referente ao Seguro Tele Medicina 02 |
A API Ceape Brasil retornará um JSON semelhante ao descrito no exemplo abaixo.
[
{
"OfferId":80850,
"Token":"854501"
"Produto":51
"NomeProduto":"GIRO GRUPO"
"ValorCredito":5000.00,
"ValorFinanciado":5019.0,
"ValorOperacaoTotal":5718.15,
"ValorDescontado":0.00,
"Parcelas":3,
"Categoria":2,
"Carencia":30,
"Intervalo":30,
"Vencimento":"2022-06-10T00:00:00-03:00",
"TaxaJuros":4.6,
"ValorParcela": 1906.05,
"ValorParcelaDesc":1889.38,
"ValorJuros": 474.15,
"ValorTac": 150.0,
"ValorIof":19.0,
"CheckSeguroAp1":1,
"CheckSeguroAp2":0,
"CheckSeguroAp3":0,
"CheckSeguroAp4":0,
"CheckSeguroAp5":0,
"CheckSeguroLar1":0,
"CheckSeguroLar2":0,
"CheckSeguroLar3":0,
"CheckSeguroTele1":0,
"CheckSeguroTele2":0,
},
{
"OfferId":80850,
"Token":"854501"
"Produto":51
"NomeProduto":"GIRO GRUPO"
"ValorCredito":5000.00,
"ValorFinanciado":5019.0,
"ValorOperacaoTotal":5718.15,
"ValorDescontado":0.00,
"Parcelas":3,
"Categoria":2,
"Carencia":30,
"Intervalo":30,
"Vencimento":"2022-06-10T00:00:00-03:00",
"TaxaJuros":4.6,
"ValorParcela": 1906.05,
"ValorParcelaDesc":1889.38,
"ValorJuros": 474.15,
"ValorTac": 150.0,
"ValorIof":19.0,
"CheckSeguroAp1":1,
"CheckSeguroAp2":0,
"CheckSeguroAp3":0,
"CheckSeguroAp4":0,
"CheckSeguroAp5":0,
"CheckSeguroLar1":0,
"CheckSeguroLar2":0,
"CheckSeguroLar3":0,
"CheckSeguroTele1":0,
"CheckSeguroTele2":0,
},
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar nenhuma prosposta pré-aprovada para o cliente, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Não foi possível localizar propostas pré-aprovadas para o cliente informado!"
}
Código HTTP da Requisição: 400
Este Endpoint realizará a confirmação da proposta pré-aprovada indicando que o cliente está de acordo com os termos, condições de parcelamento e taxas apresentadas no corpo da proposta.
Para garantir a autenticidade desta operação, é obrigatório informar o token correspondente a proposta de crédito no corpo desta solicitação. Após a validação deste token, uma resposta de sucesso é enviada após o processamento. Caso contrário, uma resposta de falha é enviada após o processamento.
O campo Canal não é obrigatório, quando não informado assumirá o valor 4. Para ter acesso aos códigos de canais acesse o endpoint Obter Lista de Canais presente na aba Resources desta documentação.
Segue abaixo um exemplo do JSON a ser enviado na requisição
{
"TokenProposta":"8878505",
"Canal":8
}
Após o aceite da prospota, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"CRM":999999,
"Codigo":258878,
"Atendente":"NOME DO OPERADOR DO CEAPE BRASIL",
"Data":"2021-09-28T11:29:19.083",
"StatusAtual":"Em Atendimento",
"Canal":"Call Center",
"TipoServico":"RENOVAÇÃO AUTOMÁTICA",
"ProcessoAtual":"Supervisão Cadastral",
"Setor":"RENOVAÇÃO AUTOMÁTICA",
"MotivoPendencia":"",
"Resumo":""
}
Código HTTP da Requisição: 200
Caso não seja possivel localizar a prosposta pré-aprovada pelo Token, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Não foi possível localizar a proposta para o cliente informado!"
}
Código HTTP da Requisição: 400
Este Endpoint realizará a recusa da proposta de crédito pré-aprovado. A recusa implica em duas situações:
De maneira semelhante ao aceite, e obrigatório informar o token correspondente a proposta, que uma vez validado devolve uma resposta de sucesso ou de falha caso o token esteja incorreto.
Segue abaixo um exemplo do JSON a ser enviado na requisição
{
"TokenProposta":"8878505"
}
Após recusar a prospota, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Proposta rejeitada com sucesso."
}
Código HTTP da Requisição: 200
Caso não seja possivel recusar a prosposta pré-aprovada, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Não foi possível localizar a proposta para o cliente informado!"
}
Código HTTP da Requisição: 400
Este Endpoint retornará uma lista com todos os tipos de documentos associados a um cliente, porém, não retorna o documento propriamente dito.
Atenção para o parâmetro DocId, após o retorno da requisição, pois ele será necessário para Baixar um documento sendo informado como parêmetro document_id na URL.
Caso sejam localizados os documentos ligados ao cliente, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
[
{
"DocId":20,
"TipoDoc":45
"LkpTipoDoc":"COMPROVANTE BANCÁRIO"
"Extensao":"PNG",
"NomeDoc":""
},
{
"DocId":20,
"TipoDoc":45
"LkpTipoDoc":"COMPROVANTE BANCÁRIO"
"Extensao":"PNG",
"NomeDoc":""
},
{
"DocId":20,
"TipoDoc":45
"LkpTipoDoc":"COMPROVANTE BANCÁRIO"
"Extensao":"PNG",
"NomeDoc":""
},
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar documentos ligados ao cliente, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Não foi possível localizar documentos asssociados ao cliente informado!"
}
Código HTTP da Requisição: 400
Este Endpoint retorna o arquivo relacionado ao documento do cliente. Para isso é necessário que você já possua o document_id do documento que deseja baixar.
Em caso de dúvida para obter o document_id, veja o Endpoint Obter lista de documentos
Caso seja localizado o documento informado, a API Ceape Brasil retornará o documento no cabeçalho da Requisição (Header), semelhante aos exemplos abaixo
Content-Disposition: attachment; filename="Comprovante bancário Ex.PNG"
Código HTTP da Requisição: 200
Caso não seja possivel localizar o documento informado, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Documento não encontrado."
}
Código HTTP da Requisição: 400
Os documentos cadastrais são obrigatórios para confirmar a identidade de um cliente. São exemplos de documentos cadastrais: CPF, RG, COMPROVANTE DE RESIDÊNCIA, EXTRATOS DE DEPÓSITOS BANCÁRIOS, etc. Os formatos atualmente aceitos nesta API são: JPEG, PNG ou PDF. Porém, recomendamos fortemente que você faça o envio dos mesmos no formato JPEG ou PNG.
Para que se possa realizar a requisição será necessário configurar o Content-Type da sua Requisição para multipart/form-data. Além disso você deverá informar o código do tipo de documento. Esse código refere-se ao tipo do documento que está sendo enviado.
Segue a descrição dos códigos dos tipos de documentos:
| Código | Descrição |
|---|---|
| 45 | Foto perfil |
| 104 | RG Frente |
| 105 | RG Verso |
| 101 | Comprovante de residência |
Caso o documento seja enviado com sucesso, a API Ceape Brasil retornará um JSON semelhante ao descrito no Endpoint Obter lista documentos
Código HTTP da Requisição: 200
Caso não seja possivel realizar o envio documento, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Não foi possível processar a sua requisição."
}
Código HTTP da Requisição: 400
Este método retornará a lista de produtos de forma personalizada. Por tanto será necessário informar o parâmetro costumer_id na URL da requisição.
Caso não saiba como obter o parâmetro costumer_id, recomendamos que você dê uma lida na documentação do Endpoint Clientes no tópico Obter cadastro
Após a requisição, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
[
{
"Codigo":20,
"Apelido":"GIRO GRUPO",
"Nome":"GIRO GRUPO",
"Data":"2022-05-12 00:00:00.000",
"Modalidade":5,
"Perfil":4680,
"MinParcelas":3,
"MaxParcelas":15,
"MinCarencia":25,
"MaxCarencia":60,
"MinValor":2000.00,
"MaxValor":10000.00,
"Taxa":100.00,
"TaxaIOF":100.00,
"Status":1,
"Categoria":2,
"UrlBanner":"https://www.ceapebrasil.org.br/assets/img/CapitalDeGiro.jpg"
"UrlIcone":"https://www.ceapebrasil.org.br/assets/img/capital-de-giro-ic-1.jpg"
},
{
"Codigo":20,
"Apelido":"GIRO GRUPO",
"Nome":"GIRO GRUPO",
"Data":"2022-05-12 00:00:00.000",
"Modalidade":5,
"Perfil":4680,
"MinParcelas":3,
"MaxParcelas":15,
"MinCarencia":25,
"MaxCarencia":60,
"MinValor":2000.00,
"MaxValor":10000.00,
"Taxa":100.00,
"TaxaIOF":100.00,
"Status":1,
"Categoria":2,
"UrlBanner":"https://www.ceapebrasil.org.br/assets/img/CapitalDeGiro.jpg"
"UrlIcone":"https://www.ceapebrasil.org.br/assets/img/capital-de-giro-ic-1.jpg"
},
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar os produtos para o cliente, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Não foi possível localizar a lista de produtos para o cliente informado!"
}
Código HTTP da Requisição: 400
{
"Message":"Desculpe mas não há registro para o cliente informado!"
}
Código HTTP da Requisição: 400
Este método retorna um objeto produto através do seu id. Por tanto, será necessário passar o parâmetro costumer_id e product_id na URL da requisição.
Caso não saiba como obter o parâmetro costumer_id, recomendamos que você dê uma lida na documentação do Endpoint Clientes no tópico Obter cadastro
Após a requisição, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Codigo":20,
"Apelido":"GIRO GRUPO",
"Nome":"GIRO GRUPO",
"Data":"2022-05-12 00:00:00.000",
"Modalidade":5,
"Perfil":4680,
"MinParcelas":3,
"MaxParcelas":15,
"MinCarencia":25,
"MaxCarencia":60,
"MinValor":2000.00,
"MaxValor":10000.00,
"Taxa":100.00,
"TaxaIOF":100.00,
"Status":1,
"Categoria":2,
"UrlBanner":"https://www.ceapebrasil.org.br/assets/img/CapitalDeGiro.jpg"
"UrlIcone":"https://www.ceapebrasil.org.br/assets/img/capital-de-giro-ic-1.jpg"
},
Código HTTP da Requisição: 200
Caso não seja possivel localizar os produtos para o cliente, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Não foi possível localizar o produto de Id 0!"
}
Código HTTP da Requisição: 400
Este Endpoint retornará o dados do Assessor de Crédito que atende determinado cliente.
Atenção para o parâmetro costumer_id, na URL da chamada, através dele nós localizaremos o Assessor de Crédito que atende o cliente pertencente ao costumer_id
Caso seja localizado o Assessor de Crédito, a API do Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Assessor":1220,
"Fone":"xxxxxxxxxxx",
"UrlWhatsApp":"https://api.whatsapp.com/send/?phone=55xxxxxxxxxxx4&text=Oi&type=phone_number&app_absent=0",
"LkpAssessor":"EDEM FERNANDO BASTOS CASTRO"
}
Código HTTP da Requisição: 200
Caso não seja possivel localizar a API Ceape do Brasil retornará um JSON semelhante aos exemplos abaixo:
{
"Message":"Não foi possível localizar o seu Assessor de Crédito!"
}
Código HTTP da Requisição: 400
{
"Message":"Não foi possível localizar o cliente pelo CPF: xxxxxxxxx"
}
Código HTTP da Requisição: 400