curl --request POST \
--url https://api.qa.nlbs.ai/api/analyses \
--header 'Content-Type: application/json' \
--data '
{
"document": "<string>",
"entity_id": 1,
"source": "<string>"
}
'import requests
url = "https://api.qa.nlbs.ai/api/analyses"
payload = {
"document": "<string>",
"entity_id": 1,
"source": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({document: '<string>', entity_id: 1, source: '<string>'})
};
fetch('https://api.qa.nlbs.ai/api/analyses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qa.nlbs.ai/api/analyses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document' => '<string>',
'entity_id' => 1,
'source' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.qa.nlbs.ai/api/analyses"
payload := strings.NewReader("{\n \"document\": \"<string>\",\n \"entity_id\": 1,\n \"source\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.qa.nlbs.ai/api/analyses")
.header("Content-Type", "application/json")
.body("{\n \"document\": \"<string>\",\n \"entity_id\": 1,\n \"source\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qa.nlbs.ai/api/analyses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"document\": \"<string>\",\n \"entity_id\": 1,\n \"source\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"links": {
"events": "<string>",
"explanation": "<string>",
"graph": "<string>",
"self": "<string>",
"signals": "<string>",
"snapshot": "<string>"
},
"signal_counts": {
"score_sum": 123,
"total": 123,
"by_pillar": {}
},
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"risk": {
"diffuse_score": 50,
"dispositive_floor": 50,
"escalation_required": true,
"review_recommended": true,
"review_required": true,
"score": 50,
"band_floors_applied": [
{
"floor_score": 50,
"reason": "<string>",
"source_code": "<string>"
}
],
"escalation_reasons": [],
"limitations": [
"<string>"
],
"meta_signals": [
{
"adjusted_score": 123,
"assessed_entity_id": 123,
"base_score": 123,
"code": "<string>",
"identified": true,
"name": "<string>",
"root_entity_id": 123,
"signal_multiplier": 123,
"version": "<string>",
"applied_aggravants": [
{
"code": "<string>",
"multiplier_delta": 123,
"name": "<string>",
"evidences": [
{
"content": "<unknown>",
"description": "<string>",
"key": "<string>",
"label": "<string>",
"metadata": {}
}
],
"limitations": [
{
"fields": [
"<string>"
],
"justification": ""
}
]
}
],
"applied_attenuants": [
{
"code": "<string>",
"multiplier_delta": 123,
"name": "<string>",
"evidences": [
{
"content": "<unknown>",
"description": "<string>",
"key": "<string>",
"label": "<string>",
"metadata": {}
}
],
"limitations": [
{
"fields": [
"<string>"
],
"justification": ""
}
]
}
],
"evidences": [
{
"content": "<unknown>",
"description": "<string>",
"key": "<string>",
"label": "<string>",
"metadata": {}
}
],
"graph_paths": [
"<unknown>"
],
"kind": "observable",
"limitations": [
{
"fields": [
"<string>"
],
"justification": ""
}
],
"observed_entity_ids": [
123
]
}
],
"pillar_breakdown": [
{
"base_points": 123,
"subscore": 50,
"weight": 0.5,
"weighted_score": 1,
"identified_signal_codes": [
"<string>"
]
}
]
},
"subject": {
"display_name": "<string>",
"entity_id": 123,
"normalized_name": "<string>",
"age_range_code": 4,
"age_years": 1,
"birth_country": "<string>",
"birth_date": "2023-12-25",
"birth_state": "<string>",
"capital_social": 123,
"citizenship": "<string>",
"city": "<string>",
"company_size": "<string>",
"country": "<string>",
"currency": "<string>",
"death_status": "<string>",
"document": "<string>",
"document_type": "<string>",
"employee_count": 1,
"father_name": "<string>",
"federal_entity_responsible": "<string>",
"headquarters_entity_id": 1,
"incorporation_date": "2023-12-25",
"is_headquarters": true,
"last_registry_update": "2023-11-07T05:31:56Z",
"legal_name": "<string>",
"legal_nature_code": "<string>",
"legal_nature_description": "<string>",
"main_cnae_code": "<string>",
"main_cnae_description": "<string>",
"mei_end_date": "2023-12-25",
"mei_option": true,
"mei_start_date": "2023-12-25",
"mother_name": "<string>",
"nationality": "<string>",
"partner_count": 1,
"place_of_birth": "<string>",
"postal_code": "<string>",
"primary_address": "<string>",
"registration_status_reason": "<string>",
"registration_status_reason_code": 123,
"secondary_cnae_codes": [
"<string>"
],
"simples_nacional_end_date": "2023-12-25",
"simples_nacional_option": true,
"simples_nacional_start_date": "2023-12-25",
"special_status": "<string>",
"special_status_date": "2023-12-25",
"state": "<string>",
"status": "<string>",
"status_date": "2023-12-25",
"title": "<string>",
"ubo_count": 1,
"unit_status_since": "2023-12-25"
},
"versions": {
"analysis_workflow_version": "<string>",
"regulatory_catalog_version": "<string>",
"rules_version": "<string>",
"scoring_engine_version": "<string>",
"operational_model": "<string>",
"operational_prompt_version": "<string>",
"snapshot_hash": "<string>"
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Create analysis
Run the deterministic analysis for a subject entity synchronously and return the verdict. Provide document (full CPF/CNPJ) and/or entity_id.
curl --request POST \
--url https://api.qa.nlbs.ai/api/analyses \
--header 'Content-Type: application/json' \
--data '
{
"document": "<string>",
"entity_id": 1,
"source": "<string>"
}
'import requests
url = "https://api.qa.nlbs.ai/api/analyses"
payload = {
"document": "<string>",
"entity_id": 1,
"source": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({document: '<string>', entity_id: 1, source: '<string>'})
};
fetch('https://api.qa.nlbs.ai/api/analyses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qa.nlbs.ai/api/analyses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document' => '<string>',
'entity_id' => 1,
'source' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.qa.nlbs.ai/api/analyses"
payload := strings.NewReader("{\n \"document\": \"<string>\",\n \"entity_id\": 1,\n \"source\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.qa.nlbs.ai/api/analyses")
.header("Content-Type", "application/json")
.body("{\n \"document\": \"<string>\",\n \"entity_id\": 1,\n \"source\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qa.nlbs.ai/api/analyses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"document\": \"<string>\",\n \"entity_id\": 1,\n \"source\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"links": {
"events": "<string>",
"explanation": "<string>",
"graph": "<string>",
"self": "<string>",
"signals": "<string>",
"snapshot": "<string>"
},
"signal_counts": {
"score_sum": 123,
"total": 123,
"by_pillar": {}
},
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"risk": {
"diffuse_score": 50,
"dispositive_floor": 50,
"escalation_required": true,
"review_recommended": true,
"review_required": true,
"score": 50,
"band_floors_applied": [
{
"floor_score": 50,
"reason": "<string>",
"source_code": "<string>"
}
],
"escalation_reasons": [],
"limitations": [
"<string>"
],
"meta_signals": [
{
"adjusted_score": 123,
"assessed_entity_id": 123,
"base_score": 123,
"code": "<string>",
"identified": true,
"name": "<string>",
"root_entity_id": 123,
"signal_multiplier": 123,
"version": "<string>",
"applied_aggravants": [
{
"code": "<string>",
"multiplier_delta": 123,
"name": "<string>",
"evidences": [
{
"content": "<unknown>",
"description": "<string>",
"key": "<string>",
"label": "<string>",
"metadata": {}
}
],
"limitations": [
{
"fields": [
"<string>"
],
"justification": ""
}
]
}
],
"applied_attenuants": [
{
"code": "<string>",
"multiplier_delta": 123,
"name": "<string>",
"evidences": [
{
"content": "<unknown>",
"description": "<string>",
"key": "<string>",
"label": "<string>",
"metadata": {}
}
],
"limitations": [
{
"fields": [
"<string>"
],
"justification": ""
}
]
}
],
"evidences": [
{
"content": "<unknown>",
"description": "<string>",
"key": "<string>",
"label": "<string>",
"metadata": {}
}
],
"graph_paths": [
"<unknown>"
],
"kind": "observable",
"limitations": [
{
"fields": [
"<string>"
],
"justification": ""
}
],
"observed_entity_ids": [
123
]
}
],
"pillar_breakdown": [
{
"base_points": 123,
"subscore": 50,
"weight": 0.5,
"weighted_score": 1,
"identified_signal_codes": [
"<string>"
]
}
]
},
"subject": {
"display_name": "<string>",
"entity_id": 123,
"normalized_name": "<string>",
"age_range_code": 4,
"age_years": 1,
"birth_country": "<string>",
"birth_date": "2023-12-25",
"birth_state": "<string>",
"capital_social": 123,
"citizenship": "<string>",
"city": "<string>",
"company_size": "<string>",
"country": "<string>",
"currency": "<string>",
"death_status": "<string>",
"document": "<string>",
"document_type": "<string>",
"employee_count": 1,
"father_name": "<string>",
"federal_entity_responsible": "<string>",
"headquarters_entity_id": 1,
"incorporation_date": "2023-12-25",
"is_headquarters": true,
"last_registry_update": "2023-11-07T05:31:56Z",
"legal_name": "<string>",
"legal_nature_code": "<string>",
"legal_nature_description": "<string>",
"main_cnae_code": "<string>",
"main_cnae_description": "<string>",
"mei_end_date": "2023-12-25",
"mei_option": true,
"mei_start_date": "2023-12-25",
"mother_name": "<string>",
"nationality": "<string>",
"partner_count": 1,
"place_of_birth": "<string>",
"postal_code": "<string>",
"primary_address": "<string>",
"registration_status_reason": "<string>",
"registration_status_reason_code": 123,
"secondary_cnae_codes": [
"<string>"
],
"simples_nacional_end_date": "2023-12-25",
"simples_nacional_option": true,
"simples_nacional_start_date": "2023-12-25",
"special_status": "<string>",
"special_status_date": "2023-12-25",
"state": "<string>",
"status": "<string>",
"status_date": "2023-12-25",
"title": "<string>",
"ubo_count": 1,
"unit_status_since": "2023-12-25"
},
"versions": {
"analysis_workflow_version": "<string>",
"regulatory_catalog_version": "<string>",
"rules_version": "<string>",
"scoring_engine_version": "<string>",
"operational_model": "<string>",
"operational_prompt_version": "<string>",
"snapshot_hash": "<string>"
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Body
Response
Successful Response
Deterministic analysis verdict returned by POST and GET /analyses/{uuid}.
Links para os sub-recursos desta análise (grafo, sinais, eventos, explicação, snapshot).
Show child attributes
Show child attributes
Contagem de sinais por pilar de risco.
Show child attributes
Show child attributes
Final risk result for the analyzed counterparty.
Show child attributes
Show child attributes
Presentation-ready profile of the analyzed counterparty.
Show child attributes
Show child attributes
Version identifiers for the rules, workflow, scoring, and explanation.
snapshot_hash is not a version per se, but is grouped here because it shares the same
availability window: both become known as soon as data_enrichment completes, well before
the analysis finishes. It is injected by the API layer from the persisted Analysis row,
not assembled by the workflow, since it isn't part of any step's output content.
Show child attributes
Show child attributes
