Quickstart
The ObraXRAY API in 5 minutes
Risk profiles for Portuguese construction companies, by NIF, as JSON. For platforms, ERPs and internal tools that need contractor due diligence at scale.
1. Get a key
API keys are issued by our team: access on request, not self-service. Tell us the use case and volume and we handle onboarding, with a test environment.
Request API access2. Your first request
Authenticate with your key (obx_sk_…) in the Authorization header. One request per NIF.
curl https://obraxray.com/api/v1/contractors/514566680 \
-H "Authorization: Bearer $OBX_API_KEY"3. The response
An enriched risk profile: score, verdict and the signals behind it. While analysis is still running, status returns "partial" and the request can be retried.
{
"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
}
}Limits & support
Per-key rate limit and daily quota (HTTP 429 when exceeded). Support and a test environment are part of onboarding.