fincore / requests
Biblioteca PHP para integração e consultas na API Fincore.
Requires
- ext-json: *
- kriswallsmith/buzz: ^0.16
- vlucas/phpdotenv: ^3.4@dev
Requires (Dev)
- phpunit/phpunit: ^7.1
Suggests
- kriswallsmith/buzz: To use BuzzAdapter, require kriswallsmith/buzz:^0.16.
This package is auto-updated.
Last update: 2024-04-13 03:00:12 UTC
README
Biblioteca PHP para integração e consultas na API Fincore https://api.fincore.co/doc
Instalação
composer require fincore/requests
Variáveis de ambiente
Aqui, utilizamos a biblioteca vlucas/phpdotenv para facilitar os testes através de variáveis de ambiente que podem ser recuperadas por qualquer classe através de getenv.
É importante saber que não é recomendado utilizar o arquivo .env no seu ambiente de produção. Mas nada impede que você proteja ele da leitura de ambientes abertos quando ele estiver fora da pasta public_html - ou equivalente.
Para para iniciarmos essa configuração, renomeie ou copie o arquivo .env.example para .env na pasta protegida de acesso de sua preferência e insira as informações necessárias para integração com os nossos dados e sua conta, configurando uma única variável de ambiente no seu sistema operacional preferido como ENVIRONMENTS=/caminho/do/seu/arquivo/env.
Se você não necessita de acesso e configurações para ambientes administrativos, configure apenas os dados de aplicações ou vice-versa.
Acesso
Recuperação de Senha #
Nesta funcionalidade, apenas a ação de recuperação de senha é iniciada, sendo necessária a intervenção manual através do link enviado por e-mail para troca da senha de acesso.
<?php
require 'vendor/autoload.php';
$helper = new \Fincore\AccessHelper();
$helper->forgot('seu@email.com');
Conta de usuários
Atualização de dados #
<?php
require 'vendor/autoload.php';
$account = new \Fincore\Account();
$account->UpdatingRegistration(['password' => 'senhaSuperSecreta']);
Dados do usuário administrativo #
<?php
require 'vendor/autoload.php';
$account = new \Fincore\Account();
$account->RecoveringData();
Administrativo
Dados de uma aplicação #
<?php
require 'vendor/autoload.php';
$administrative = new \Fincore\Administrative();
$administrative->RetrieveApp($id);
Lista de aplicações #
<?php
require 'vendor/autoload.php';
$administrative = new \Fincore\Administrative();
$administrative->ListApps();
Criando uma nova aplicação #
<?php
require 'vendor/autoload.php';
$administrative = new \Fincore\Administrative();
$administrative->NewApp($url, $mongoDbDsn);
Atualizando os dados de uma aplicação #
<?php
require 'vendor/autoload.php';
$administrative = new \Fincore\Administrative();
$administrative->UpdatingApps($url, $mongoDbDsn, $id);
Desabilitando uma aplicação #
<?php
require 'vendor/autoload.php';
$administrative = new \Fincore\Administrative();
$administrative->DisableApps($id);
Reativando uma aplicação #
<?php
require 'vendor/autoload.php';
$administrative = new \Fincore\Administrative();
$administrative->ReactivatingApps($id);
Aplicações
Criando um múltiplos documentos #
<?php
require 'vendor/autoload.php';
$apps = new \Fincore\Apps();
$apps->DocumentsCreate($collection, $data);
Filtrando documentos #
<?php
require 'vendor/autoload.php';
$apps = new \Fincore\Apps();
$apps->filterData($collection, $headers = []);
Consultando um documento através do seu ID #
<?php
require 'vendor/autoload.php';
$apps = new \Fincore\Apps();
$apps->DocumentData($collection, $Id, $headers = []);
Atualizando um documento #
<?php
require 'vendor/autoload.php';
$apps = new \Fincore\Apps();
$apps->DocumentUpdate($collection, $Id, $data);
Atualizando múltiplos documentos #
<?php
require 'vendor/autoload.php';
$apps = new \Fincore\Apps();
$apps->DocumentsUpdate($collection, $data, $headers = []);
Excluindo múltiplos documentos #
<?php
require 'vendor/autoload.php';
$apps = new \Fincore\Apps();
$apps->DocumentsDelete($collection, $headers = []);
Excluindo um documento através do seu ID #
<?php
require 'vendor/autoload.php';
$apps = new \Fincore\Apps();
$apps->DocumentDelete($collection, $Id);
Listando suas coleções de dados #
<?php
require 'vendor/autoload.php';
$apps = new \Fincore\Apps();
$apps->Collections();
Agregação de documentos #
<?php
require 'vendor/autoload.php';
$apps = new \Fincore\Apps();
$apps->Aggregate($collection, $Instructions);
Background Check
Questionário baseado em um CPF #
<?php
require 'vendor/autoload.php';
$bc = new \Fincore\BackgroundCheck();
$bc->question($document);
Resposta do questionário identificada pelo ticket gerado no questionário #
<?php
require 'vendor/autoload.php';
$bc = new \Fincore\BackgroundCheck();
$bc->answers($ticket, $answers);
OCR de documentos [CNH, Identidade ou Passaporte] #
<?php
require 'vendor/autoload.php';
$bc = new \Fincore\BackgroundCheck();
$bc->documents($imageURL, $type, $side);
Facematch - Validando a foto do usuário com a selfie enviada #
<?php
require 'vendor/autoload.php';
$bc = new \Fincore\BackgroundCheck();
$bc->facematch($documentURL, $selfieURL);
Pessoa Física
PF - Anúncios online #
Busca por anúncios online vinculados ao número do CPF enviado
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->ads($document);
PF - Dados Cadastrais Básicos #
Dados básicos de um usuário como nome, filiação e outros documentos conhecidos, data de nascimento, signo e regularização na Receita Federal.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->basic($document);
PF - Dados Profissionais - Conselhos de Classe #
Dados de profissionais conhecidos em conselhos de classe.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->memberships($document);
PF - Dados Profissionais - Servidores Públicos #
Dados de profissionais conhecidos de funcionários públicos.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->publicProfessions($document);
PF - Dados Profissionais #
Dados de profissionais conhecidos.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->professions($document);
PF - Dados de Estudantes Universitários #
Dados de estudantes universitários.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->universityStudents($document);
PF - Dados de Sites #
Domínios de internet conhecidos para um CPF.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->domains($document);
PF - E-mails #
Endereços eletrônicos conhecidos para um CPF.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->email($document);
PF - Endereços físicos #
Endereços físicos conhecidos para um CPF com classificação para endereços de trabalho e casa.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->addresses($document);
PF - Exposição e Perfil na Mídia #
Exposição e perfil definidos em diversas mídias.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->mediaExposure($document);
PF - Indicadores e Características #
Indicadores e características de atividades financeiras pela WEB.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->flagsAndFeatures($document);
PF - Informações Financeiras #
Informações financeiras de IR.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->financial($document);
PF - Interesses e Comportamentos #
A consulta retorna informações relacionadas com comportamentos ou com o interesse em determinadas categorias de produtos e serviços.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->interests($document);
PF - Informações de KYC #
Dados de Interpol e Ofac para homônimos e similaridades.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->kyc($document);
PF - Passagens pela Web #
Dados de passagens reconhecidas pela WEB como passagens suspeitas.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->webPassages($document);
PF - Presença Online #
Informações de presença online que definem a utilização da internet.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->onlinePresence($document);
PF - Presença em Cobrança #
Dados de presença em cobranças por empresas, definindo os níveis de encontrabilidade por endereços, e-mails e telefones, por exemplo.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->recurrencyToCharging($document);
PF - Processos #
Dados de processos conhecidos através do CPF oriundos dos tribunais regionais.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->processes($document);
PF - Programas de Benefícios e Assistência Social #
Informações de participação em programas de benefícios como o bolsa-família.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->socialAssistences($document);
PF - Relacionamentos Econômicos #
Informações sobre relacionamentos econômicos.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->businessRelationships($document);
PF - Relacionamentos Pessoais #
Relacionamentos em torno do CPF como familiares, vizinhos e colegas de trabalho.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->nearbyRelationships($document);
PF - Telefones #
Dados de telefones associados ao CPF consultado.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->phones($document);
PF - Veículos #
Dados de veículos registrados para o CPF informado.
<?php
require 'vendor/autoload.php';
$pf = new \Fincore\PF();
$pf->vehicles($document);
Pessoa Jurídica
PJ - Anúncios Online #
Consulta com informações relacionadas dos anuncios postados pela empresa consultado nos principais marketplaces e portais de anúncios da internet.
<?php
require 'vendor/autoload.php';
$pj = new \Fincore\PJ();
$pj->ads($document);
PJ - Dados Cadastrais Básicos #
Consulta contém o conjunto mais simples de informações dentre todos os datasets, com informações cadastrais recuperadas de fontes oficiais .
<?php
require 'vendor/autoload.php';
$pj = new \Fincore\PJ();
$pj->basic($document)
PJ - Dados de Sites #
Consulta retorna informações dos sites e domínios que estão associados com a entidade consultada, seja através do registro de domínios ou através de informações contidas dentro do próprio conteúdo do site.
<?php
require 'vendor/autoload.php';
$pj = new \Fincore\PJ();
$pj->domains($document)
PJ - E-mails #
Consulta retorna não só os e-mails relacionados com a entidade consultada, como também uma série de qualificadores desse relacionamento, tais como quantas vezes o e-mail foi visto para aquela entidade, e quantas vezes foi visto associado com outras entidades.
<?php
require 'vendor/autoload.php';
$pj = new \Fincore\PJ();
$pj-> emails($document)
PJ - Endereços #
A consulta retorna não só os endereços relacionados com a entidade consultada, como também uma série de qualificadores desse relacionamento, tais como quantas vezes o endereço foi visto para aquela entidade, e quantas vezes foi visto associado com outras entidades.
<?php
require 'vendor/autoload.php';
$pj = new \Fincore\PJ();
$pj-> Addresses($document)
PJ - Exposição e Perfil na Mídia #
Exposição e perfil definidos em diversas mídias.
<?php
require 'vendor/autoload.php';
$pj = new \Fincore\PJ();
$pj->mediaExposure($document);
PJ - Grupos Econômicos #
Os dados retornam informações agrupadas e agregadas do grupo econômico relacionado com a empresa principal sendo consultada, em todas as direções.
<?php
require 'vendor/autoload.php';
$pj = new \Fincore\PJ();
$pj->EconomicGroups($document);
PJ - Indicadores de Atividade #
Indicadores e características de atividades financeiras pela WEB.
<?php
require 'vendor/autoload.php';
$pj = new \Fincore\PJ();
$pj-> activityIndicators($document);
PJ - Processos #
Os Processos Judiciais e Administrativos retorna informações, tanto atuais quanto históricas, do envolvimento da entidade consultada em ações judiciais de todos os tipos (civil, trabalhista, criminal, etc).
<?php
require 'vendor/autoload.php';
$pj = new \Fincore\PJ();
$pj-> Processes($document);
PJ - Relacionamentos #
Consulta retorna informações sobre outras entidades, sejam elas pessoas ou empresas, que estão relacionadas com a empresa consultada.
<?php
require 'vendor/autoload.php';
$pj = new \Fincore\PJ();
$pj->relationships($document);
PJ - Telefones #
Dados de telefones associados ao CNPJ consultado.
<?php
require 'vendor/autoload.php';
$pj = new \Fincore\PJ();
$pj->phones($document);
Utilitários
JSON para XLS #
A conversão de um objeto JSON para um arquivo XLS é importante para exportar dados já normalizados, transformando a sua leitura em uma planilha Excel. Esta rota é um download de arquivo XLS.
<?php
require 'vendor/autoload.php';
$json = new \Fincore\Utilities;
$json->JsonToXls($json);