Documentação da API do Zarv ID
Servers
https://services.zarv.comProdução
Login
POST
/api/v1/authentication
Autenticação para obter um token de acesso
Request Body
application/json
JSON
Responses
Autenticação realizada com sucesso
application/json
JSON "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "expiresIn": 300, "refreshExpiresIn": 3600, "tokenType": "Bearer"
{
}
Renovar token
POST
/api/v1/authentication/refresh
Troca um token de renovação válido por um novo par de tokens. Guarde sempre o novo refreshToken retornado.
Request Body
application/json
JSON "refreshToken": "string"
{
}
Responses
Token renovado com sucesso
application/json
JSON "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "expiresIn": 300, "refreshExpiresIn": 3600, "tokenType": "Bearer"
{
}
Consultar verificações
GET
/api/v2/verifications
Obtém todas as verificações com filtros opcionais
Authorizations
Authentication v2
For more details, see Authentication v2
Type
HTTP (bearer)
Parameters
Query Parameters
nationalId
Type
string
Example
"11111111111"Min Length
11Max Length
14status
Filtra pelo status da verificação.
Type
string
Valid values
"CREATED""PROCESSING""ANALYZING""COMPLETED""FAILED""CNH_EXTRACT"Example
"COMPLETED"search
Busca parcial e case-insensitive por CPF/CNPJ ou nome. Combina com os demais filtros.
Type
string
Example
"maria"feedbackStatus
Filtra pelo status do feedback (decisão de aprovação) mais recente da verificação. NOTSTARTED retorna verificações que ainda não receberam feedback.
Type
string
Valid values
"NOTSTARTED""APPROVED""REPROVED""STANDBY""WAIVED"Example
"APPROVED"incomplete
Quando true, retorna apenas verificações potencialmente travadas: em CREATED ou PROCESSING e criadas entre 15 minutos e 12 horas atrás.
Type
boolean
Example
truepage
Type
integer
Example
1Minimum
1limit
Type
integer
Example
10Minimum
1Maximum
25scoreGte
Filtra verificações com Zarv Score maior ou igual a este valor (inclusive, faixa 0–1000). Combine com scoreLte para um intervalo fechado.
Type
integer
Example
500Minimum
0Maximum
1000scoreLte
Filtra verificações com Zarv Score menor ou igual a este valor (inclusive, faixa 0–1000).
Type
integer
Example
800Minimum
0Maximum
1000Responses
Lista de verificações
application/json
JSON "verifications": [ { "id": "string", "workspaceId": "string", "userId": "string", "profileId": "string", "nationalId": "string", "name": "string", "status": "string", "verifications": { "entity": "string", "ia": { "resume": true }, "finance": { "restrictions": true, "advanced": true }, "faceRecognition": "string", "cnh": "string", "source": "string", "profileId": "string" }, "result": { "score": 0, "scoreFactor": 0, "rules": [ "string" ], "execution": { "startedAt": "string", "endedAt": "string", "durationMs": 0 }, "scoreDistribution": [ { "module": "string", "percent": 0 } ], "relatedCount": 0 }, "callback": { "url": "string", "method": "string" }, "person": { "profile": { "age": 0, "birthDate": "string", "blacklisted": { "client": true, "zarv": true, "clientType": "string", "zarvType": "string" }, "contacts": { "addresses": [ { "type": "string", "street": "string", "number": "string", "neighborhood": "string", "city": "string", "state": "string", "country": "string", "postalCode": "string", "preferencial": true, "createdAt": "string", "updatedAt": "string" } ], "emails": [ { "value": "string", "preferencial": true } ], "phones": [ { "type": "string", "number": "string", "area": "string", "country": "string", "preferencial": true, "createdAt": "string", "updatedAt": "string" } ] }, "fiscalStatus": "string", "gender": "string", "indicators": { "blacklisted": { "risky": true, "value": 0 }, "blacklistedCompanies": { "risky": true, "value": 0 }, "blacklistedRelated": { "risky": true, "value": 0 }, "irregularStatus": { "risky": true, "value": 0 }, "deathRecord": { "risky": true, "value": 0 } }, "motherName": "string", "isMotherNameCorrectly": true, "name": "string", "nationalId": "string", "obitFlag": true }, "finance": { "salary": 0, "income": "string", "totalAssets": "string", "taxReturns": [ { "year": "string", "status": "string", "bank": "string", "updatedAt": "string" } ], "collections": { "total": 0, "totalOrigins": 0, "updatedAt": "string" }, "assistancePrograms": { "programs": [ { "name": "string", "city": "string", "state": "string", "active": true, "amount": 0, "totalAmount": 0, "startedAt": "string", "endedAt": "string" } ], "total": 0, "totalActive": 0 }, "indicators": { "monthlyIncome": { "risky": true, "value": 0 }, "assistancePrograms": { "risky": true, "value": 0 }, "ltyTaxDeclarations": { "risky": true, "value": 0 }, "collections": { "risky": true, "value": 0 }, "activeRestrictions": { "risky": true, "value": 0 }, "reportedDefault": { "risky": true, "value": 0 }, "dishonoredChecks": { "risky": true, "value": 0 }, "protests": { "risky": true, "value": 0 } }, "restrictions": { "failed": true, "codeStatus": "string", "registerLogs": "string", "isNegative": true, "segment": "string", "totalAmount": 0, "hasData": true, "hasRegisterData": true, "hasLawsuits": true, "hasAppointments": true, "hasDishonoredChecks": true, "hasProtests": true, "consultationLogs": "string", "appointments": "string", "dishonoredChecks": "string", "lawsuits": "string", "protests": "string" }, "financeAdvanced": { "available": true, "score": { "value": 0, "segment": "string" }, "hasData": true, "debts": { "count": 0, "totalAmount": 0, "items": "string" }, "dishonoredChecks": { "count": 0, "items": "string" }, "protests": { "count": 0, "totalAmount": 0, "items": [ { "notary": "string", "city": "string", "count": 0, "amount": 0 } ] }, "lawsuits": { "judgementCount": 0, "bankruptcyCount": 0, "totalAmount": 0, "items": [ { "number": "string", "processType": "string", "amount": 0, "court": "string", "filedAt": "string" } ] } } }, "lawsuits": { "items": [ { "name": "string", "nationalId": "string", "number": "string", "type": "string", "mainSubject": "string", "cnjProcedureType": "string", "cnjSubject": "string", "court": { "name": "string", "level": "string", "type": "string", "district": "string", "state": "string" }, "status": "string", "stage": "string", "specificType": "string", "polarity": "string", "partType": "string", "relationship": "string", "debitAmount": 0, "parties": [ { "nationalId": "string", "name": "string", "polarity": "string", "partType": "string", "specificType": "string" } ], "level": "string", "ruleApplied": true, "ruleSeverity": "string", "indicators": [ { "name": "string", "dimension": "string", "involvement": 0 } ], "relatedLawsuits": [ "string" ], "distributionDate": "string", "lastUpdateDate": "string" } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 }, "person": "string", "company": "string", "proponent": { "items": [ { } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } }, "defendant": { "items": "string", "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 }, "person": [ { "nationalId": "string", "name": "string", "level": "string", "relationship": { "type": "string", "level": "string" }, "entityType": "string", "lawsuits": { "items": [ { "name": "string", "nationalId": "string", "number": "string", "type": "string", "mainSubject": "string", "cnjProcedureType": "string", "cnjSubject": "string", "court": { "name": "string", "type": "string", "district": "string", "state": "string" }, "status": "string", "stage": "string", "specificType": "string", "polarity": "string", "partType": "string", "relationship": "string", "debitAmount": 0, "parties": [ { "nationalId": "string", "name": "string", "polarity": "string", "partType": "string", "specificType": "string" } ], "level": "string", "indicators": [ { "name": "string", "dimension": "string", "involvement": 0 } ], "distributionDate": "string", "lastUpdateDate": "string" } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } } } ], "company": [ { "nationalId": "string", "name": "string", "level": "string", "relationship": { "type": "string", "level": "string" }, "entityType": "string", "lawsuits": { "items": "string", "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } } } ] }, "indicators": { "rentalRisk": { "risky": true, "value": 0 }, "creditRisk": { "risky": true, "value": 0 }, "passiveCivil": { "risky": true, "value": 0 }, "criminalRisk": { "risky": true, "value": 0 }, "executedTax": { "risky": true, "value": 0 }, "executedFiscal": { "risky": true, "value": 0 }, "bankruptcy": { "risky": true, "value": 0 }, "labourRisk": { "risky": true, "value": 0 } } }, "related": { "personal": [ { "nationalId": "string", "name": "string", "level": "string", "entityType": "string", "relationship": { "type": "string", "active": true, "level": "string" }, "lawsuits": { "items": "string", "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } } } ], "business": { "ownerships": [ { "activities": [ { "code": "string", "activity": "string", "isMain": true } ], "additionalInfo": { "capitalDescription": "string", "capitalValue": "string", "nire": "string", "comex": "string", "comexLastUpdate": "string" }, "blacklisted": { "client": true, "zarv": true }, "contacts": { }, "documentType": "string", "entityLevel": "string", "entityType": "string", "fiscalOrigin": "string", "fiscalRegime": "string", "fiscalStatus": "string", "fiscalType": "string", "foundedAt": "string", "headquarterState": "string", "isHeadQuarter": true, "lawsuits": { "items": [ { "name": "string", "nationalId": "string", "number": "string", "type": "string", "mainSubject": "string", "cnjProcedureType": "string", "cnjSubject": "string", "court": { "name": "string", "type": "string", "district": "string", "state": "string" }, "status": "string", "stage": "string", "specificType": "string", "polarity": "string", "partType": "string", "relationship": "string", "debitAmount": 0, "parties": [ { "nationalId": "string", "name": "string", "polarity": "string", "partType": "string", "specificType": "string" } ], "level": "string", "distributionDate": "string", "lastUpdateDate": "string" } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } }, "legalNature": { "code": "string", "activity": "string" }, "name": "string", "nationalId": "string", "officialName": "string", "relationship": { "name": "string", "type": "string", "active": true, "subtype": "string", "level": "string", "startedAt": "string" }, "tradeName": "string", "createdAt": "string", "updatedAt": "string" } ], "employments": [ { "additionalInfo": { "capitalDescription": "string", "capitalValue": "string", "nire": "string", "comex": "string", "comexLastUpdate": "string" }, "blacklisted": { "client": true, "zarv": true }, "contacts": { }, "documentType": "string", "entityLevel": "string", "entityType": "string", "fiscalType": "string", "isHeadQuarter": true, "lawsuits": { "items": "string", "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } }, "legalNature": { "code": "string", "activity": "string" }, "name": "string", "nationalId": "string", "relationship": { "type": "string", "active": true, "level": "string", "startedAt": "string", "endedAt": "string" } } ] }, "indicators": { "personal": { "personalRelationships": { "risky": true, "value": 0 }, "partnerRelationships": { "risky": true, "value": 0 }, "lawsuitRelationships": { "risky": true, "value": 0 }, "suspiciousLawsuits": { "risky": true, "value": 0 }, "criminalLawsuits": { "risky": true, "value": 0 } }, "business": { "activeOwnership": { "risky": true, "value": 0 }, "inactiveOwnership": { "risky": true, "value": 0 }, "activeEmployments": { "risky": true, "value": 0 }, "inactiveEmployments": { "risky": true, "value": 0 }, "suspiciousLawsuits": { "risky": true, "value": 0 }, "criminalLawsuits": { "risky": true, "value": 0 }, "bankruptcy": { "risky": true, "value": 0 } } }, "totals": { "relationships": 0, "relatives": 0, "neighbors": 0, "spouses": 0, "household": 0, "partners": 0, "collegeClass": 0 } }, "employments": [ { "nationalId": "string", "name": "string", "relationship": { "type": "string", "active": true, "level": "string", "startedAt": "string", "endedAt": "string" } } ], "relatedCompanies": [ { "activities": [ { "code": "string", "activity": "string", "isMain": true } ], "additionalInfo": { "capitalDescription": "string", "capitalValue": "string", "nire": "string", "comex": "string", "comexLastUpdate": "string" }, "blacklisted": { "client": true, "zarv": true }, "documentType": "string", "entityType": "string", "fiscalRegime": "string", "fiscalStatus": "string", "fiscalType": "string", "foundedAt": "string", "isHeadQuarter": true, "lawsuits": { "items": [ { "name": "string", "nationalId": "string", "number": "string", "type": "string", "mainSubject": "string", "cnjProcedureType": "string", "cnjSubject": "string", "court": { "name": "string", "type": "string", "district": "string", "state": "string" }, "status": "string", "stage": "string", "specificType": "string", "polarity": "string", "partType": "string", "relationship": "string", "debitAmount": 0, "parties": [ { "nationalId": "string", "name": "string", "polarity": "string", "partType": "string", "specificType": "string" } ], "level": "string", "distributionDate": "string", "lastUpdateDate": "string" } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } }, "name": "string", "nationalId": "string", "relationship": { "name": "string", "type": "string", "active": true, "subtype": "string", "level": "string", "startedAt": "string" }, "ruleApplied": true, "tradeName": "string" } ], "relatedPersons": [ { "name": "string", "nationalId": "string", "blacklisted": { "client": true, "zarv": true }, "ruleApplied": true, "types": [ { "type": "string", "active": true } ], "lawsuits": { "items": [ { "name": "string", "nationalId": "string", "number": "string", "type": "string", "mainSubject": "string", "cnjProcedureType": "string", "cnjSubject": "string", "court": { "name": "string", "type": "string", "district": "string", "state": "string" }, "status": "string", "stage": "string", "specificType": "string", "polarity": "string", "partType": "string", "relationship": "string", "debitAmount": 0, "parties": [ { "nationalId": "string", "name": "string", "polarity": "string", "partType": "string", "specificType": "string" } ], "level": "string", "ruleApplied": true, "ruleSeverity": "string", "indicators": [ { "name": "string", "dimension": "string", "involvement": 0 } ], "distributionDate": "string", "lastUpdateDate": "string" } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } } } ], "archetypes": [ { "name": "string", "score": 0, "stamp": true, "matchedRules": [ { } ], "totalRules": 0 } ] }, "version": "string", "executedAt": "string", "createdAt": "string", "updatedAt": "string" } ], "page": 1, "limit": 10, "total": 100
{
}
Criar uma verificação
POST
/api/v2/verifications
Cria uma nova verificação para um CPF ou CNPJ
Authorizations
Authentication v2
For more details, see Authentication v2
Type
HTTP (bearer)
Request Body
application/json
JSON "nationalId": "11111111111", "profileId": "22222222-0000-0000-0000-000000000001", "input": [ { "attribute": "renda_declarada", "value": "5000" } ], "verifications": { "ia": { "resume": true }, "finance": { "restrictions": true, "advanced": true }, "faceRecognition": { "imageURL": "string", "filename": "string" }, "cnh": { "imageURL": "string", "imageBase64": "string" }, "source": "API", "force": false, "modules": [ { "name": "lawsuits", "enabled": true } ] }
{
}
Responses
Verificação criada com sucesso
application/json
JSON "id": "string", "workspaceId": "string", "userId": "string", "profileId": "string", "nationalId": "string", "status": "string", "verifications": { "type": "string", "entity": "string", "ia": { }, "finance": "string", "faceRecognition": "string", "cnh": "string", "source": "string", "profileId": "string" }, "createdAt": "string", "updatedAt": "string"
{
}
Criar verificações em lote
POST
/api/v2/verifications/batch
Cria uma verificação para cada nationalId da lista, aplicando a mesma configuração de verifications a todos os itens. Cada item é validado e cobrado individualmente; o resultado de cada um vem em items, um mapa indexado pelo nationalId. Itens aceitos retornam id (verification ID) para polling posterior; itens rejeitados retornam error. Face recognition e CNH não são suportados em lote — se presentes no corpo, são ignorados.
Authorizations
Authentication v2
For more details, see Authentication v2
Type
HTTP (bearer)
Request Body
application/json
JSON "nationalId": [ "11111111111" ], "verifications": { "profileId": "22222222-0000-0000-0000-000000000001", "finance": { "restrictions": true } }, "callback": { "url": "https://example.com/webhooks/verifications", "method": "POST", "headers": { "additionalProperties": "string" } }, "metadata": { "additionalProperties": "string" }
{
}
Responses
Lote aceito para processamento. A resposta contém o resumo do lote e, em items, o status de cada nationalId enviado.
application/json
JSON "total": 0, "success": 0, "errors": 0, "items": { "additionalProperties": { "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "error": "There is not enough balance: insufficient balance" } }
{
}
Consultar verificação por ID
GET
/api/v2/verifications/{id}
Obtém uma verificação específica pelo ID
Authorizations
Authentication v2
For more details, see Authentication v2
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Example
"805181ca-2956-49e1-81bb-93d1792d269d"Format
"uuid"Responses
Detalhes da verificação
application/json
JSON "id": "string", "workspaceId": "string", "userId": "string", "profileId": "string", "nationalId": "string", "name": "string", "status": "string", "verifications": { "entity": "string", "ia": { "resume": true }, "finance": { "restrictions": true, "advanced": true }, "faceRecognition": "string", "cnh": "string", "source": "string", "profileId": "string" }, "result": { "score": 0, "scoreFactor": 0, "rules": [ "string" ], "execution": { "startedAt": "string", "endedAt": "string", "durationMs": 0 }, "scoreDistribution": [ { "module": "string", "percent": 0 } ], "relatedCount": 0 }, "callback": { "url": "string", "method": "string" }, "person": { "profile": { "age": 0, "birthDate": "string", "blacklisted": { "client": true, "zarv": true, "clientType": "string", "zarvType": "string" }, "contacts": { "addresses": [ { "type": "string", "street": "string", "number": "string", "neighborhood": "string", "city": "string", "state": "string", "country": "string", "postalCode": "string", "preferencial": true, "createdAt": "string", "updatedAt": "string" } ], "emails": [ { "value": "string", "preferencial": true } ], "phones": [ { "type": "string", "number": "string", "area": "string", "country": "string", "preferencial": true, "createdAt": "string", "updatedAt": "string" } ] }, "fiscalStatus": "string", "gender": "string", "indicators": { "blacklisted": { "risky": true, "value": 0 }, "blacklistedCompanies": { "risky": true, "value": 0 }, "blacklistedRelated": { "risky": true, "value": 0 }, "irregularStatus": { "risky": true, "value": 0 }, "deathRecord": { "risky": true, "value": 0 } }, "motherName": "string", "isMotherNameCorrectly": true, "name": "string", "nationalId": "string", "obitFlag": true }, "finance": { "salary": 0, "income": "string", "totalAssets": "string", "taxReturns": [ { "year": "string", "status": "string", "bank": "string", "updatedAt": "string" } ], "collections": { "total": 0, "totalOrigins": 0, "updatedAt": "string" }, "assistancePrograms": { "programs": [ { "name": "string", "city": "string", "state": "string", "active": true, "amount": 0, "totalAmount": 0, "startedAt": "string", "endedAt": "string" } ], "total": 0, "totalActive": 0 }, "indicators": { "monthlyIncome": { "risky": true, "value": 0 }, "assistancePrograms": { "risky": true, "value": 0 }, "ltyTaxDeclarations": { "risky": true, "value": 0 }, "collections": { "risky": true, "value": 0 }, "activeRestrictions": { "risky": true, "value": 0 }, "reportedDefault": { "risky": true, "value": 0 }, "dishonoredChecks": { "risky": true, "value": 0 }, "protests": { "risky": true, "value": 0 } }, "restrictions": { "failed": true, "codeStatus": "string", "registerLogs": "string", "isNegative": true, "segment": "string", "totalAmount": 0, "hasData": true, "hasRegisterData": true, "hasLawsuits": true, "hasAppointments": true, "hasDishonoredChecks": true, "hasProtests": true, "consultationLogs": "string", "appointments": "string", "dishonoredChecks": "string", "lawsuits": "string", "protests": "string" }, "financeAdvanced": { "available": true, "score": { "value": 0, "segment": "string" }, "hasData": true, "debts": { "count": 0, "totalAmount": 0, "items": "string" }, "dishonoredChecks": { "count": 0, "items": "string" }, "protests": { "count": 0, "totalAmount": 0, "items": [ { "notary": "string", "city": "string", "count": 0, "amount": 0 } ] }, "lawsuits": { "judgementCount": 0, "bankruptcyCount": 0, "totalAmount": 0, "items": [ { "number": "string", "processType": "string", "amount": 0, "court": "string", "filedAt": "string" } ] } } }, "lawsuits": { "items": [ { "name": "string", "nationalId": "string", "number": "string", "type": "string", "mainSubject": "string", "cnjProcedureType": "string", "cnjSubject": "string", "court": { "name": "string", "level": "string", "type": "string", "district": "string", "state": "string" }, "status": "string", "stage": "string", "specificType": "string", "polarity": "string", "partType": "string", "relationship": "string", "debitAmount": 0, "parties": [ { "nationalId": "string", "name": "string", "polarity": "string", "partType": "string", "specificType": "string" } ], "level": "string", "ruleApplied": true, "ruleSeverity": "string", "indicators": [ { "name": "string", "dimension": "string", "involvement": 0 } ], "relatedLawsuits": [ "string" ], "distributionDate": "string", "lastUpdateDate": "string" } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 }, "person": "string", "company": "string", "proponent": { "items": [ { } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } }, "defendant": { "items": "string", "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 }, "person": [ { "nationalId": "string", "name": "string", "level": "string", "relationship": { "type": "string", "level": "string" }, "entityType": "string", "lawsuits": { "items": [ { "name": "string", "nationalId": "string", "number": "string", "type": "string", "mainSubject": "string", "cnjProcedureType": "string", "cnjSubject": "string", "court": { "name": "string", "type": "string", "district": "string", "state": "string" }, "status": "string", "stage": "string", "specificType": "string", "polarity": "string", "partType": "string", "relationship": "string", "debitAmount": 0, "parties": [ { "nationalId": "string", "name": "string", "polarity": "string", "partType": "string", "specificType": "string" } ], "level": "string", "indicators": [ { "name": "string", "dimension": "string", "involvement": 0 } ], "distributionDate": "string", "lastUpdateDate": "string" } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } } } ], "company": [ { "nationalId": "string", "name": "string", "level": "string", "relationship": { "type": "string", "level": "string" }, "entityType": "string", "lawsuits": { "items": "string", "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } } } ] }, "indicators": { "rentalRisk": { "risky": true, "value": 0 }, "creditRisk": { "risky": true, "value": 0 }, "passiveCivil": { "risky": true, "value": 0 }, "criminalRisk": { "risky": true, "value": 0 }, "executedTax": { "risky": true, "value": 0 }, "executedFiscal": { "risky": true, "value": 0 }, "bankruptcy": { "risky": true, "value": 0 }, "labourRisk": { "risky": true, "value": 0 } } }, "related": { "personal": [ { "nationalId": "string", "name": "string", "level": "string", "entityType": "string", "relationship": { "type": "string", "active": true, "level": "string" }, "lawsuits": { "items": "string", "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } } } ], "business": { "ownerships": [ { "activities": [ { "code": "string", "activity": "string", "isMain": true } ], "additionalInfo": { "capitalDescription": "string", "capitalValue": "string", "nire": "string", "comex": "string", "comexLastUpdate": "string" }, "blacklisted": { "client": true, "zarv": true }, "contacts": { }, "documentType": "string", "entityLevel": "string", "entityType": "string", "fiscalOrigin": "string", "fiscalRegime": "string", "fiscalStatus": "string", "fiscalType": "string", "foundedAt": "string", "headquarterState": "string", "isHeadQuarter": true, "lawsuits": { "items": [ { "name": "string", "nationalId": "string", "number": "string", "type": "string", "mainSubject": "string", "cnjProcedureType": "string", "cnjSubject": "string", "court": { "name": "string", "type": "string", "district": "string", "state": "string" }, "status": "string", "stage": "string", "specificType": "string", "polarity": "string", "partType": "string", "relationship": "string", "debitAmount": 0, "parties": [ { "nationalId": "string", "name": "string", "polarity": "string", "partType": "string", "specificType": "string" } ], "level": "string", "distributionDate": "string", "lastUpdateDate": "string" } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } }, "legalNature": { "code": "string", "activity": "string" }, "name": "string", "nationalId": "string", "officialName": "string", "relationship": { "name": "string", "type": "string", "active": true, "subtype": "string", "level": "string", "startedAt": "string" }, "tradeName": "string", "createdAt": "string", "updatedAt": "string" } ], "employments": [ { "additionalInfo": { "capitalDescription": "string", "capitalValue": "string", "nire": "string", "comex": "string", "comexLastUpdate": "string" }, "blacklisted": { "client": true, "zarv": true }, "contacts": { }, "documentType": "string", "entityLevel": "string", "entityType": "string", "fiscalType": "string", "isHeadQuarter": true, "lawsuits": { "items": "string", "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } }, "legalNature": { "code": "string", "activity": "string" }, "name": "string", "nationalId": "string", "relationship": { "type": "string", "active": true, "level": "string", "startedAt": "string", "endedAt": "string" } } ] }, "indicators": { "personal": { "personalRelationships": { "risky": true, "value": 0 }, "partnerRelationships": { "risky": true, "value": 0 }, "lawsuitRelationships": { "risky": true, "value": 0 }, "suspiciousLawsuits": { "risky": true, "value": 0 }, "criminalLawsuits": { "risky": true, "value": 0 } }, "business": { "activeOwnership": { "risky": true, "value": 0 }, "inactiveOwnership": { "risky": true, "value": 0 }, "activeEmployments": { "risky": true, "value": 0 }, "inactiveEmployments": { "risky": true, "value": 0 }, "suspiciousLawsuits": { "risky": true, "value": 0 }, "criminalLawsuits": { "risky": true, "value": 0 }, "bankruptcy": { "risky": true, "value": 0 } } }, "totals": { "relationships": 0, "relatives": 0, "neighbors": 0, "spouses": 0, "household": 0, "partners": 0, "collegeClass": 0 } }, "employments": [ { "nationalId": "string", "name": "string", "relationship": { "type": "string", "active": true, "level": "string", "startedAt": "string", "endedAt": "string" } } ], "relatedCompanies": [ { "activities": [ { "code": "string", "activity": "string", "isMain": true } ], "additionalInfo": { "capitalDescription": "string", "capitalValue": "string", "nire": "string", "comex": "string", "comexLastUpdate": "string" }, "blacklisted": { "client": true, "zarv": true }, "documentType": "string", "entityType": "string", "fiscalRegime": "string", "fiscalStatus": "string", "fiscalType": "string", "foundedAt": "string", "isHeadQuarter": true, "lawsuits": { "items": [ { "name": "string", "nationalId": "string", "number": "string", "type": "string", "mainSubject": "string", "cnjProcedureType": "string", "cnjSubject": "string", "court": { "name": "string", "type": "string", "district": "string", "state": "string" }, "status": "string", "stage": "string", "specificType": "string", "polarity": "string", "partType": "string", "relationship": "string", "debitAmount": 0, "parties": [ { "nationalId": "string", "name": "string", "polarity": "string", "partType": "string", "specificType": "string" } ], "level": "string", "distributionDate": "string", "lastUpdateDate": "string" } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } }, "name": "string", "nationalId": "string", "relationship": { "name": "string", "type": "string", "active": true, "subtype": "string", "level": "string", "startedAt": "string" }, "ruleApplied": true, "tradeName": "string" } ], "relatedPersons": [ { "name": "string", "nationalId": "string", "blacklisted": { "client": true, "zarv": true }, "ruleApplied": true, "types": [ { "type": "string", "active": true } ], "lawsuits": { "items": [ { "name": "string", "nationalId": "string", "number": "string", "type": "string", "mainSubject": "string", "cnjProcedureType": "string", "cnjSubject": "string", "court": { "name": "string", "type": "string", "district": "string", "state": "string" }, "status": "string", "stage": "string", "specificType": "string", "polarity": "string", "partType": "string", "relationship": "string", "debitAmount": 0, "parties": [ { "nationalId": "string", "name": "string", "polarity": "string", "partType": "string", "specificType": "string" } ], "level": "string", "ruleApplied": true, "ruleSeverity": "string", "indicators": [ { "name": "string", "dimension": "string", "involvement": 0 } ], "distributionDate": "string", "lastUpdateDate": "string" } ], "counters": { "total": 0, "criminal": 0, "civil": 0, "labour": 0, "tax": 0, "fiscal": 0, "administrative": 0, "others": 0 } } } ], "archetypes": [ { "name": "string", "score": 0, "stamp": true, "matchedRules": [ { } ], "totalRules": 0 } ] }, "version": "string", "executedAt": "string", "createdAt": "string", "updatedAt": "string"
{
}
Obter PDF da verificação
GET
/api/v2/verifications/{id}/pdf
Retorna os bytes do arquivo PDF de uma verificação específica pelo ID. A resposta contém o conteúdo binário do arquivo e nao uma URL para download.
Authorizations
Authentication v2
For more details, see Authentication v2
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Example
"805181ca-2956-49e1-81bb-93d1792d269d"Format
"uuid"Responses
Bytes do arquivo PDF da verificação
application/pdf
Obter resumo por IA da verificação
GET
/api/v2/verifications/{id}/ai-summary
Retorna o resumo/veredito gerado por IA para uma verificação do motor novo (engine).
Quando o resumo é gerado. A IA NÃO roda em toda verificação. Ela é acionada quando o profile tem IA habilitada — pelo menos um módulo com AIModuleSummaryEnabled=true (o bloco ai do request pode sobrepor a config do profile por execução). Há dois caminhos:
- Automático: ao concluir o processamento (status
COMPLETED, com dados de módulo e semdeferAutopilot), o motor computa e persiste o resumo antes de finalizar. - Lazy (sob demanda): este endpoint computa o resumo na primeira chamada e persiste; chamadas seguintes retornam o resultado pronto.
Requer verificação do motor novo (com profileId) já concluída. Para profiles sem IA habilitada o resumo não é gerado.
Authorizations
Authentication v2
For more details, see Authentication v2
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Format
"uuid"Responses
Resumo por IA da verificação
application/json
JSON "verificationId": "string", "workspaceId": "string", "nationalId": "string", "entityType": "string", "generatedAt": "string", "promptsDurationMs": 0, "modules": { "profile": { "summary": "string", "confidence": 0, "highlights": [ "string" ], "autopilot": "string" }, "finance": { "summary": "string", "confidence": 0, "highlights": [ "string" ], "autopilot": "string" }, "lawsuits": { "summary": "string", "confidence": 0, "highlights": [ "string" ], "autopilot": "string" }, "related": { "personal": { "summary": "string", "confidence": 0, "highlights": [ "string" ], "autopilot": "string" }, "business": { "summary": "string", "confidence": 0, "highlights": [ "string" ], "autopilot": "string" } } }, "finalSummary": { "summary": "string", "shortDescription": "string", "recommendation": "string", "keyFactors": [ "string" ], "autopilot": "string" }
{
}
Criar feedback para uma verificação
POST
/api/v2/verifications/{id}/feedbacks
Criar feedback para uma verificação
Authorizations
Authentication v2
For more details, see Authentication v2
Type
HTTP (bearer)
Request Body
application/json
JSON "verificationId": "805181ca-2956-49e1-81bb-93d1792d269d", "status": "APPROVED", "comment": "Documentacao validada com sucesso"
{
}
Responses
Feedback criado com sucesso
application/json
JSON "status": "APPROVED", "verificationId": "805181ca-2956-49e1-81bb-93d1792d269d"
{
}
Consultar lista restritiva
GET
/api/v2/blacklist
Obtém os registros da lista restritiva com paginação por workspace
Authorizations
Authentication v2
For more details, see Authentication v2
Type
HTTP (bearer)
Parameters
Query Parameters
workspaceId*
Type
Requiredstring
Example
"fc31805a-9ac5-423b-b3cb-b626c769b27c"Format
"uuid"limit
Type
integer
Example
10Minimum
1Maximum
100page
Type
integer
Example
1Minimum
1Responses
Lista restritiva consultada com sucesso
application/json
JSON "blacklist": [ { "id": "53190a88-7866-4fc4-9986-5e24f7d8da97", "workspaceId": "fc31805a-9ac5-423b-b3cb-b626c769b27c", "userId": "a7e3545c-b7e1-4156-8363-7d3ecca8c8d9", "nationalId": "91439362025", "type": "FRAUD", "description": "Fraude", "createdAt": "2026-03-30T17:53:52Z" } ], "page": 1, "limit": 10, "total": 1
{
}
Adicionar item na lista restritiva
POST
/api/v2/blacklist
Cria um novo registro na lista restritiva para um workspace
Authorizations
Authentication v2
For more details, see Authentication v2
Type
HTTP (bearer)
Parameters
Query Parameters
workspaceId*
Type
Requiredstring
Example
"fc31805a-9ac5-423b-b3cb-b626c769b27c"Format
"uuid"Request Body
application/json
JSON "nationalId": "91439362025", "type": "fraud", "description": "Fraude"
{
}
Responses
Item adicionado na lista restritiva com sucesso
application/json
JSON "id": "53190a88-7866-4fc4-9986-5e24f7d8da97", "workspaceId": "fc31805a-9ac5-423b-b3cb-b626c769b27c", "userId": "a7e3545c-b7e1-4156-8363-7d3ecca8c8d9", "nationalId": "91439362025", "type": "FRAUD", "description": "Fraude", "createdAt": "2026-03-30T17:53:52Z"
{
}
Remover item da lista restritiva
DELETE
/api/v2/blacklist/{nationalId}
Remove um registro da lista restritiva por nationalId e workspace
Authorizations
Authentication v2
For more details, see Authentication v2
Type
HTTP (bearer)
Parameters
Path Parameters
nationalId*
Type
Requiredstring
Example
"91439362025"Min Length
11Max Length
14Query Parameters
workspaceId*
Type
Requiredstring
Example
"fc31805a-9ac5-423b-b3cb-b626c769b27c"Format
"uuid"Responses
Item removido da lista restritiva com sucesso