Visualizar relatório-resumo de um cliente
GET
/v2/report/clients/{clientId}
Requisição
Parâmetros de Caminho
Parâmetros Header
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v2/report/clients/' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Sucesso
{
"contacts": {
"addresses": [
{
"address": "string",
"city": "string",
"zip_code": "string",
"state": "string"
}
],
"phones": [
{
"area_code": "string",
"phone_number": "string"
}
],
"emails": [
{
"email": "string"
}
]
},
"basic_data": {
"id": "4005e4a6-08b5-4dea-b4f9-35a6630154ad",
"kind": "natural",
"taxId": "12345678909",
"groupId": "string",
"name": "JOÃO DA SILVA",
"gender": "string",
"birthDate": "1998-08-21T00:00:00Z",
"age": 52,
"motherName": "string",
"fatherName": "string",
"taxIdStatus": "string",
"hasObitIndication": false,
"lastUpdateDate": "2026-06-08T00:00:00Z",
"alternativeIdNumbers": {},
"detailScore": {
"score": 780,
"rating": "B",
"calculatedAt": "2026-09-02T17:23:41.829Z",
"message": "Solicite uma consulta completa para um score mais atualizado."
},
"maritalStatus": "CASADO"
},
"sintegra": {
"items": [
{
"secondaryActivity": [],
"city": "string",
"lastUpdate": "string",
"mainActivity": "string",
"name": "string",
"tradeName": "string",
"state": "string",
"status": "string",
"registerDate": "string",
"register": "string",
"statusDate": "string",
"taxRegime": "string"
}
]
},
"family_group": [
{
"level": "string",
"name": "string",
"taxId": "string",
"type": "string"
}
],
"economic_group": [
{
"taxId": "string",
"name": "string",
"type": "string",
"subType": "string",
"level": "string",
"clientId": "string",
"isExpanded": true,
"participation": {
"percent": 0,
"source": "string",
"updatedAt": "2025-10-02T12:34:28.457Z"
},
"relationshipName": "string",
"isCurrentlyActive": true
}
],
"credit_restrictive": {
"_id": "string",
"fifth_service": true,
"score": 0,
"score_exception": null,
"probability_default": 0,
"riskIndex": "string",
"past_queries": [
{
"date": "2026-01-19",
"informer": "string"
}
],
"judicial_recovery": false,
"summary": {
"last_date_appointment": null,
"dependencies_control_cred_qty": 0,
"dependencies_control_cred_amount": 0
},
"appointments": [],
"bad_checks": [],
"national_protests": [],
"administrators": [],
"corporate_board": [],
"partner_participation": [
{
"_id": "string",
"name": "string",
"participation_percentage": 0,
"start_date_participation": "2022-08-04",
"tax_id": "string",
"relationship_type": "string"
}
]
},
"quod": {
"score": {
"rating": 0,
"credit_risk": {
"rank": "string",
"description": "string"
},
"payment_probability": {
"perc": 0,
"description": "string"
}
},
"loans": null,
"appointments": [],
"indicators": {
"punctuality": {
"perc": 0,
"rank": "string",
"description": "string"
},
"payment_capacity": {
"perc": 0,
"rank": "string",
"description": "string"
}
},
"negative": null
},
"bvs": {
"id": "string",
"clientId": "string",
"queryId": "string",
"essential": {
"scoreClassifications": [
{
"score": "string",
"alphabeticClassification": "string",
"probability": 0,
"text": 0
}
],
"returnScoreIncomeAndBilling": {
"presumedIncome": "string"
},
"debtsOccurrencesSummary": {
"firstDebtDate": null
},
"debts": [],
"past90DaysQueriesSummary": {
"total": 0,
"queries": [
{
"total": 0,
"date": "2026-08-01"
}
]
},
"pastQueries": [
{
"date": "2026-08-20",
"informer": "string"
}
]
},
"createdAt": "2026-08-31T21:05:14.594Z",
"updatedAt": "2026-08-31T21:05:14.594Z"
},
"protest": {
"totalsCities": 1,
"valueTotalOfProtests": 1520.35,
"totalProtests": 2,
"totalCompanies": 1,
"date": "2026-06-17T14:17:56.200Z",
"items": []
},
"compliance": {
"environmental": [
{
"name": "string",
"content": [
{
"name": "string",
"job_id": null,
"file_url": {
"serviceCode": "string",
"isFile": true
},
"document_type": "string",
"result": "string",
"status": "string",
"details": {
"type": "string",
"content": []
}
}
]
}
],
"fiscal": [
{
"uf": "string",
"status": "string",
"job_id": null,
"result": "string",
"file_url": {
"serviceCode": "string",
"isFile": true
},
"document_type": "string"
}
],
"labour": [
{
"name": "string",
"content": [
{
"name": "string",
"job_id": null,
"file_url": {
"serviceCode": "string",
"isFile": true
},
"document_type": "string",
"result": "string",
"status": "string",
"details": []
}
]
}
],
"criminal": [
{
"name": "string",
"content": [
{
"name": "string",
"job_id": null,
"file_url": {
"serviceCode": "string",
"isFile": false
},
"document_type": "string",
"result": "string",
"status": "string",
"details": []
}
]
}
],
"pep": [
{
"name": "string",
"content": [
{
"name": "string",
"job_id": null,
"file_url": "string",
"document_type": "string",
"result": "string",
"status": "string",
"details": null
}
]
}
],
"check_bioma": {
"job_id": null,
"status": "string",
"content": []
}
},
"lawsuit": {
"_id": "string",
"queryId": "string",
"taxId": "string",
"clientId": "string",
"clientName": "string",
"items": [],
"outros": null,
"nextPage": false,
"createdAt": "2026-06-17T14:17:24.677Z",
"updatedAt": "2026-06-17T14:17:24.677Z"
},
"registered_warehouse": [],
"rural_properties": {
"items": [
{
"propertyId": "string",
"name": "string",
"totalArea": 0,
"value": 0,
"state": "string",
"city": "string",
"isGEORef": false,
"areaOwned": 0,
"areaOwnedPercent": 0,
"type": "string"
}
],
"areas": {
"owned": 0,
"leased": 0,
"inSociety": 0,
"partnership": 0
},
"properties": {
"owned": 0,
"leased": 0,
"inSociety": 0,
"partnership": 0
},
"totalArea": 0,
"totalValue": 0
},
"car": {
"items": [],
"properties": 1,
"totalArea": 1251,
"productiveArea": 980,
"totalVti": 15400000.5
},
"vehicle_assets": {
"items": [],
"quantity": 0,
"totalValue": 0
},
"urban_properties": {
"items": [
{
"_id": "string",
"clientId": "string",
"type": "string",
"county": "string",
"state": "string",
"description": "string",
"totalArea": 0,
"value": 0,
"year": "string",
"trashed": false,
"situationAt": []
}
],
"totalProperties": 0,
"totalValueProperties": 0
},
"mobile_properties": {
"items": [
{
"_id": "string",
"clientId": "string",
"type": "string",
"description": "string",
"situationAt": [],
"value": 0,
"year": "string",
"trashed": false
}
],
"totalAssets": 0,
"totalValueAssets": 0,
"totalVehicles": 0,
"totalMachinery": 0
},
"financial": {
"items": [
{
"_id": "string",
"clientId": "string",
"type": "string",
"description": "string",
"situationAt": [],
"value": 0,
"year": "string",
"trashed": false
}
],
"next": false,
"totalValue": 0
},
"liabilities": {
"items": [
{
"totalValue": 0,
"year": "string",
"items": [
{
"_id": "string",
"type": "string",
"value": 0,
"year": "string",
"description": "string",
"situationAt": []
}
]
}
]
},
"revenue_expenses": {
"items": [
{
"calendarYear": "string",
"expenses": "string",
"month": "string",
"revenue": "string"
}
],
"totalRevenue": 0,
"totalExpenses": 0
}
}Modificado em 2026-10-13 09:47:06