Consulta ao relatório

27 min

Consultar relatório

Buscar informações de um relatório

GET

https://gyra-core.gyramais.com.br/report/{id}/section/{sectionType}

curl --location --globoff 'https://gyra-core.gyramais.com.br/report/{id}' \
--header 'authorization: Bearer string'

Meu relatório

Para gerar uma análise, primeiro será necessário gerar seu token de acesso através do Autenticação, e também ter um relatório já criado, essa informação pode ser na criação em Criar um relatório ou numa consulta a todos os seus relatórios em Consulta a políticas

A informação disponível nessa consulta é o relatório completo com todos os dados que estão atualizados. As informações atualizadas são enviadas via rota de Webhooks assim que sincronizadas.

Sections

Section	Descrição
BASIC_INFORMATION	Informações básicas do documento, desde cadastro na receita federal até contatos e alterações cadastrais.
SUMMARY	Principais insights do documento análisado com os resumos da análise.
RELATIONS	Relacionamentos empresariais e sociais do documento.
PROCESSES	Dados de processos do documento e sócios quando empresa, trazendo as informações das partes e movimentações
PROTESTS	Dados de protestos com abrangência nacional para o documento analisado.
CERTIFICATES	Certidões emitidas em tempo real tanto federais como estaduais para o documento analisado.
PEP	Dados de exposição política do documento e dos sócios quando empresa, além do histórico de doações em eleições.
SANCTIONS	Avaliação do documento e dos sócios, quando empresa, para sanções nacionais e federais.
LOCATION	Informações sobre a localização do documento com street view e mapa
HISTORY	Informações de endividamento ano-mês do documento consultado, dados de SCR do Banco Central (Bacen)
CATEGORIES	Informações de endividamento por categoria de uso por ano-mês do documento consultado, dados de SCR do Banco Central (Bacen).
PEFIN	Informações de pendências financeiras do documento analisado.
BAD_CHECK	Informações de cheque sem fundo, sustados e roubados do documento analisado.
CRIMINAL_RECORD	Informações de antecedentes criminais do documento analisado, sempre CPF.
CREDIT_POLICY	Informações de todas as regras avaliadas pelo fluxo de decisão para a consulta realizada.
REFIN	Informações de pendências financeiras com Instituições Financeiras do documento analisado.

Dados entregues

Relatório

#	Variável	Descrição
1	id	Identificador do relatório
2	createdAt	Data de criação do relatório
3	updatedAt	Data da última atualização do relatório
4	document	Documento consultado
5	yearMonthDay	Data de referência dos dados
6	organizationId	Identicador da organização que fez a consulta
7	type	-
7.1	id	Identificador do tipo de informação
7.2	createdAt	Data de criação do tipo de informação
7.3	updatedAt	Data de atualização do tipo de informação
7.4	title	-
7.5	value	-
7.6	isPaid	Valida se a consulta é extra ou não (true/false)
8	commentary	Comentário da análise do relatório
9	status	Informações sobre o status do relatório
9.1	id	Identificador do status do relatório
9.2	value	Valor do status do relatóio: Pendente, Negado e Aprovado
9.3	sections	Detalhado abaixo

Seções do relatório

#	Variável	Descrição
9.3.1	id	Identificador da seção do relatório
9.3.2	type	Tipo de seção do relatório
9.3.2.1	id	Identificador do tipo de relatório
9.3.2.2	title	Nome da seção
9.3.2.3	tabs	-
9.3.3	comments	Comentários sobre a análise da seção do relatótio
9.3.4	completedAt	Data em que a seção foi completada
9.3.5	errors	Erros
9.3.6	details	Informações detalhadas da seção

Comentários do relatório

#	Variáveis	Descrição
8	commentary	Comentários sobre a análise do relatório
8.1	createdAt	Data de criação do comentário
8.2	id	Identificador do comentário
8.3	text	Comentário
8.4	authUserId	Identificador da autenticação do usuário
8.5	user	Usuárioque comentou
8.5.1	id	Identificador do usuário
8.5.2	organizationId	Identificador da organização do usuário
8.5.3	authUserId	Identificador da autenticação do usuário
8.5.4	email	E-mail do usuário
8.5.5	person	Cadastro do usuário
8.5.5.1	id	Identificador do cadastro do usuário
8.5.5.2	name	Nome do usuário
8.5.5.3	cpf	CPF do usuário

Resumo

#	Variável	Descrição
9.3.6	details	Informações detalhadas da seção
9.3.6.1	integrationCount	Quantidade de integrações usadas para validar os dados
9.3.6.2	companyPep \| personPep	Detallhado em Resumo PEP
9.3.6.3	pepSummary	Detalhado em Summary Padrão
9.3.6.4	serasaScoreSummary	Detalhado em Summary Padrão
9.3.6.5	protestsSummary	Detalhado em Summary Padrão
9.3.6.6	pefinsSummary	Detalhado em Summary Padrão
9.3.6.7	refinsSummary	Detalhado em Summary Padrão
9.3.6.8	checksSummary	Detalhado em Summary Padrão
9.3.6.9	economicGroupChanges	Detalhado em Resumo alterações
9.3.6.10	changesSummary	Detalhado em Summary Padrão
9.3.6.11	companyLawsuits	Detalhado em Resumo processos
9.3.6.12	lawsuitsSummary	Detalhado em Summary Padrão
9.3.6.13	ownersLawsuits	Detalhado em Resumo processos
9.3.6.14	addressesChanges	Detalhado em Resumo alterações
9.3.6.15	ownersPep	Detalhado em Resumo PEP
9.3.6.16	basicDataChanges	Detalhado em Resumo alterações
9.3.6.17	pgfnCertificate	Detalhado em Resumo certidões
9.3.6.18	totalCertificates	Quantidade total de certidões emitidas
9.3.6.19	certificatesSummary	Detalhado em Summary Padrão
9.3.6.20	debtLaborAbsenceCertificate	Detalhado em Resumo certidões
9.3.6.21	fgtsCertificate	Detalhado em Resumo certidões
9.3.6.22	debtAbsenceStateCertificate	Detalhado em Resumo certidões

Summary Padrão

#	Variável	Descrição
.1	order	Ordenação
.2	title	Título do resumo
.3	tooltip	Explicação sobre o resumo
.4	icon	Ícone de identificação
.5	dateText	Texto com data da atualização do componente
.6	error	Aponta se teve erro (true/false)
.7	value	Valor de análise
.8	subValue	Segundo valor para análise
.9	status	BAD, GOOD, ALERT, PENDING, ERROR

Resumo PEP

Pessoa Jurídica

Pessoa Física

#	Variável	Descrição
.1	pEPCountPrimary	Quantidade de PEP no QSA da empresa
.2	otherPepsCount	Quantidade de PEP nos relacionamentos da empresa, exceto QSA
.3	totalSanctionsCount	Quantidade total de sanções identificadas na empresa ou sócios
.4	totalDonations	Quantidade total de doações realizadas pela empresa ou sócios
.5	lastThreeElectionYears	Data das últimas 3 eleições

#	Variável	Descrição

Resumo alterações

#	Variável	Descrição
.1	id	Identificador da alteração
.2	date	Data da identificação da alteração

Resumo processos

#	Variável	Descrição
.1	count	Quantidade de processos
.2	amount	Valor total de processos

Resumo certidões

#	Variável	Descrição
.1	valid	Se está aprovada (true/false)
.2	error	Se teve erro na emissão (true/false)

Alertas

#	Variável	Descrição
9.3.6	details
9.3.6.1	integrationCount	Quantidade de integrações utilizadas
9.3.6.2	policyInfoGeneral	Informações gerais da política
9.3.6.2.1	references	Referências
9.3.6.2.2	id	Identificador das informações gerais da política
9.3.6.2.3	createdAt	Data de criação da política
9.3.6.2.4	updatedAt	Data da última atualização da política
9.3.6.2.5	document	Documento analisado
9.3.6.2.6	yearMonth	Ano mês da análise
9.3.6.2.7	organizationId	Identificador da organização
9.3.6.2.8	status	Decisão final da política: APPROVED, ALERT, DENIED
9.3.6.3	registrationChange	Detalhado em Alertas - Resultado dos grupos de regras
9.3.6.4	notaries	Detalhado em Alertas - Resultado dos grupos de regras
9.3.6.5	pefin	Detalhado em Alertas - Resultado dos grupos de regras
9.3.6.6	lawsuits	Detalhado em Alertas - Resultado dos grupos de regras
9.3.6.7	pep	Detalhado em Alertas - Resultado dos grupos de regras
9.3.6.8	companyOpeningTime	Detalhado em Alertas - Resultado dos grupos de regras
9.3.6.9	cnaeRestrictive	Detalhado em Alertas - Resultado dos grupos de regras
9.3.6.10	sanctions	Detalhado em Alertas - Resultado dos grupos de regras
9.3.6.11	refin	Detalhado em Alertas - Resultado dos grupos de regras
9.3.6.12	certificates	Detalhado em Alertas - Resultado dos grupos de regras
9.3.6.13	scr	Detalhado em Alertas - Resultado dos grupos de regras

Alertas - Resultado dos grupos de regras

#	Variável	Descrição
.1	policyResult	Resultado do grupo de regras
.1.1	status	Status do grupo: APPROVED, ALERT, DENIED
.1.2	rulesResults	Regras analisadas
.1.2.1	title	Regra analisada
.1.2.2	description	Descrição do cenário de aprovação
.1.2.3	status	Status: "Aprovado", "Alerta Brando", "Alerta Severo"

Informações Básicas

#		Descrição
1	document	Documento consultado
2	yearMonth	Ano-mês da consulta
#	person	Grupo de informações para CPF
#	historyNames	Grupo de alterações de nome
3	name	Nome completo
4	gender	Gênero
5	changedDate	Data de alteração identificada
6	createdAt	Data de criação
7	updatedAt	Data de atualização
#	historyStatuses	Grupo de alterações de regularidade com a receita federal
8	createdAt	Data de criação
9	updatedAt	Data de atualização
10	status	Situação na receita federal
11	changedDate	Data de alteração identificada
12	name	Nome completo
13	motherName	Nome completo da mãe
14	birthDate	Data de nascimento
15	gender	Gênero
16	document	Documento analisado
17	professionTitle	Profissão
18	socialClassName
19	address	Endereço completo
#	historyAddresses	Grupo de alterações de endereço
20	address	Endereço completo
21	changedState

Relacionamentos

#	Variável	Descrição
#	kinshipRelationships
1	document
2	documentType
3	name
4	relationshipLevel
5	relationship
6	formattedStartDate
7	startDate
8	relatedTo
#	relationships
9	document
10	documentType
11	name
12	relationshipLevel
13	relationship
14	formattedStartDate
15	endDate
16	relatedTo

Processos

#	Variável	Descrição
1	createdAt
2	updatedAt
3	document
4	yearMonth
#	lawsuits
#	courtTypeSummary
5	type
6	count
7	highestValue
8	totalValue
#	lawsuits

Certidões

#	Variável	Descrição
#	certificate
1	name
2	type
3	document
4	validityDate
5	formattedDocument
6	description
7	situation
8	url

PEP

#	Variável	Descrição
#	kyc	Grupo de dados de know your client
1	document	Documento consultado
#	pEPHistory	Grupo de exposição política
2	isCurrentlyPEP	True: é PEP False: não é PEP
#	sanctionsHistory	Grupo de sanções identificadas
3	isCurrentlySanctioned	True: possui sanção False: não possui sanção
4	wasPreviouslySanctioned	True: já teve sanção False: não teve sanção
5	last30DaysSanctioned	True: já teve sanção nos últimos 30 dias False: não teve sanção nos últimos 30 dias
6	last90DaysSanctions	True: já teve sanção nos últimos 90 dias False: não teve sanção nos últimos 90 dias
7	last180DaysSanctions	True: já teve sanção nos últimos 180 dias False: não teve sanção nos últimos 180 dias
8	last365DaysSanctions	True: já teve sanção nos últimos 365dias False: não teve sanção nos últimos 365 dias
9	lastYearPEPOccurence
10	last3YearsPEPOccurence
11	last5YearsPEPOccurence
12	last5PlusYearsPEPOccurence
13	firstSanctionDate
14	lastSanctionDate
15	isCurrentlyElectoralDonor
16	isHistoricalElectoralDonor
17	totalElectoralDonations
18	totalElectoralDonationAmount
#	electoralDonations
19	firstPEPOccurenceDate
20	lastPEPOccurenceDate
#	pep
21	donationsCount
22	amountDonated
23	highestDonationAmount
#	lastThreeElections
#	year
24	donationsCount
25	amountDonated

Antecedente Criminal

#	Variável	Descrição
1	document	Documento consultado
2	description	Descrição da situação da certidão
3	date	Data da consulta
4	url	Url da certidão emitida

Sanções

#	Variável	Descrição
#	nacional	Grupo de sanções nacionais
1	type	Órgão de checagem de sanção
2	formattedDocument	Documento consultado
3	description	Descrição da situação da sanção
4	situation	Situação da sanção
#	internacional	Grupo de sanções internacionais
5	type	Órgão de checagem da sanção
6	formattedDocument	Documento consultado
7	description	Descrição da situação da sanção
8	situation	Situação da sanção

Localização

#	Variável	Descrição
1	address	Endereço completo
2	latitude	Latitude
3	longitude	Longitude

Categorias SCR

#	Variável	Descrição
#	categories

Histórico SCR

#	Variável	Descrição
#	riskDetails	Tabela SCR
#	grouped	Agrupado ano-mês do SCR
1	totalRisk	Valor total de crédito usado e disponível nas IF's
2	formattedYearMonth	Ano-mês referência
3	date	Data da consulta
4	totalResponsabilityAmount	Valor total de crédito usado
5	creditLimitAmount	Valor total de crédito disponível
6	lossAmount	Valor total de perdas
7	expiredAmountMoreThan180Days	Valor total em atraso acima de 180 dias
8	expiredAmount91to180Days	Valor total em atraso entre 91 e 180 dias
9	expiredAmountLessThan90Days	Valor total em atraso até 90 dias
10	toExpire	Valor total a vencer

Protestos

#	Variável	Descrição
1	protestsQuantity	Quantidade total de protestos
2	protestsTotalValue	Valor total em protestos
#	protestsByRegion
3	lastProtestDate	Data do protesto mais recente
#	protestsTable

Cheque sem fundo

#	Variável	Descrição
1	checksQuantity	Quantidade de cheques sem fundo
2	checksBalance	Valor total em cheque sem fundo
#	checktable

Pendência financeira

#	Variável	Descrição
1	financialPendenciesQuantity	Quantidade total de pefin
2	financialPendenciesTotalValue	Valor total em pefin
#	pefinTable