ObraXRAY Business · API
O risco de qualquer construtora, por NIF, dentro da sua aplicação.
Uma chamada ao nosso servidor devolve a pontuação de risco, o veredicto e os sinais que estão por trás, como insolvências, dívidas, alvarás, administradores e processos judiciais. É a mesma análise de obraxray.com, disponível dentro do seu produto.
Pedido
curl https://obraxray.com/api/v1/contractors/514566680 \
-H "Authorization: Bearer obx_sk_..."Resposta
{
"object": "contractor",
"nif": "514566680",
"status": "complete",
"score": 78,
"verdict": "low_risk",
"color": "safe",
"checks": {
"insolvencyDeclared": 0,
"taxDebtor": false,
"ssDebtor": false,
"alvaraStatus": "valid",
"directorsWithIssues": 0
}
}O que devolve
A resposta que precisa sobre uma construtora, em JSON.
Cada resposta traz a pontuação de 0 a 100, o veredicto, a cor de risco e mais de 20 sinais por trás da decisão, a mesma análise que o utilizador vê em obraxray.com, pronta a usar no seu sistema.
Pontuação e veredicto
A pontuação de 0 a 100, a cor de risco e um veredicto claro, de «sem registos» a «não avançar».
Sinais detalhados
Insolvências por fase, dívidas fiscais e à Segurança Social, alvará IMPIC, execuções, sanções ACT, processos cíveis.
Risco dos administradores
A ligação dos gerentes a outras empresas, insolvências anteriores e o padrão fénix.
Como funciona
A análise é feita por NIF.
Pede por NIF
GET /v1/contractors/{nif} com a sua chave. Se a empresa já foi analisada, a resposta é imediata.
Análise em segundo plano
Se a empresa for nova, começamos a análise e devolvemos «analyzing». A análise dos administradores pode levar alguns minutos.
Webhook quando termina
Quando o relatório fica pronto, recebe o evento analysis.completed, assinado por HMAC, sem precisar de andar a consultar a API em ciclo.
Onde encaixa
Feita para integrar o risco no fluxo que já tem.
É uma chamada do seu servidor para o nosso, que encaixa onde já toma decisões sobre empresas.
Acesso e limites
As chaves de acesso são emitidas por nós.
Cada cliente recebe a sua chave (obx_sk_…) emitida por nós, ainda não há registo automático. Cada chave tem limites de utilização e uma quota diária opcional, e todos os pedidos ficam registados. Fale connosco e configuramos o acesso ao seu caso.
Autenticação por cabeçalho
A chave vai no cabeçalho Authorization, nunca na query.
Limites por chave
Limites de utilização e quota diária configuráveis, com respostas de erro claras.
O que está por trás
9 fontes públicas oficiais, cruzadas.
A pontuação não vem de uma única fonte, resulta de cruzar mais de 20 verificações a partir de 9 bases de dados oficiais, com histórico acumulado e interpretação.
Quer testar a API no seu caso?
Explicamos como encaixa no seu caso, damos-lhe uma chave e ajudamos na integração, sem compromissos.
Prefere um selo visual no seu site, sem código de servidor? Veja o Embed