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

11

Max Length

14

status

Filtra pelo status da verificação.

Type

string

Valid values

"CREATED""PROCESSING""ANALYZING""COMPLETED""FAILED""CNH_EXTRACT"

Example"COMPLETED"

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

Exampletrue

page

Type

integer

Example1

Minimum

1

limit

Type

integer

Example10

Minimum

1

Maximum

25

scoreGte

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

Example500

Minimum

0

Maximum

1000

scoreLte

Filtra verificações com Zarv Score menor ou igual a este valor (inclusive, faixa 0–1000).

Type

integer

Example800

Minimum

0

Maximum

1000

Responses

Lista de verificações

Content-Type

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

}

Consultar verificações

Authorizations

Parameters

Query Parameters

Responses

Playground

Samples

Consultar verificações​

Authorizations​

Parameters​

Query Parameters

Responses​

Playground​

Samples​

Consultar verificações

Authorizations

Parameters

Responses

Playground

Samples