Skip to content
ObraXRAY Business

Quickstart

A API ObraXRAY em 5 minutos

Perfil de risco de construtoras portuguesas, por NIF, em JSON. Para plataformas, ERPs e ferramentas internas que precisam de due diligence de construtoras à escala.

1. Obter uma chave

As chaves de API são emitidas pela nossa equipa: acesso por pedido, não self-service. Diz-nos o caso de uso e o volume e tratamos do onboarding, com ambiente de teste.

Pedir acesso à API

2. O primeiro pedido

Autentica com a tua chave (obx_sk_…) no header Authorization. Um pedido por NIF.

curl https://obraxray.com/api/v1/contractors/514566680 \
  -H "Authorization: Bearer $OBX_API_KEY"

3. A resposta

Perfil de risco enriquecido: score, veredito e os sinais por trás dele. Quando a análise ainda está a correr, status devolve "partial" e o pedido pode ser repetido.

{
  "object": "contractor",
  "nif": "514566680",
  "status": "complete",
  "name": "DIAGRAMAMOTRIZ - CONSTRUÇÃO UNIPESSOAL LDA",
  "score": 0,
  "verdict": "do_not_proceed",
  "color": "danger",
  "lastUpdated": "2026-05-08",
  "checks": {
    "insolvencyDeclared": 1,
    "taxDebtor": false,
    "ssDebtor": false,
    "alvaraStatus": "NONE",
    "civilProceedingsAsDefendant": 10,
    "directorsWithIssues": 0
  }
}

Limites e suporte

Rate limit e quota diária por chave (HTTP 429 quando excedidos). Suporte e ambiente de teste incluídos no onboarding.

Referência completa

Todos os campos, endpoints e códigos de erro abaixo.

Ir para o ObraXRAY Business