Background Checking PF
O background check é um complemento de dados e permite a geração completa de um dossiê com informações relevantes tanto para PF (Pessoa Física) quanto PJ (Pessoa Jurídica).
Código de status
As fontes de dados retornam um código responsável por detalhar a situação da consulta. Este código é identificado como statusCode
e auxilia na interpretação dos resultados.
Valor | Descrição |
---|---|
01 | Consulta realizada com sucesso |
02 | Dados inválidos ou insuficientes |
05 | Aguardando processamento |
50 ou 70 | Não foi possível realizar a consulta |
55 | Indisponível |
Query
As fontes de dados retornam um objeto responsável por informar alguns parâmetros utilizados na consulta. Estes parâmetros ficam dentro do objeto query
e auxiliam na interpretação dos resultados.
Valor | Tipo | Descrição |
---|---|---|
firstStartAt | Date | Data e hora do início da primeira execução da fonte |
startAt | Date | Data e hora do início da última execução da fonte |
endDate | Date | Data e hora do término da execução da fonte |
data | Object | Objeto que contém parâmetros utilizados na consulta |
Dados cadastrais
Consulta Receita Federal (PF1)
Retorna se o CPF consultado está Regular, Irregular, Óbito e demais informações da Receita Federal.
Seção: cpf
Parâmetros obrigatórios: cpf, birthDate
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta. 00: Consulta realizada com sucesso; 01: CPF não informado ou inválido; 02: Data de nascimento inválida. |
data | Object | Dados de retorno |
data.baseStatus | String | Status base retornado pela certidão |
data.name | String | Nome de acordo com a certidão |
data.socialName | String | Nome social de acordo com a certidão |
data.digit | String | Dígito da Receita Federal |
data.registrationDate | String | Data de registro na Receita Federal |
data.isDead | String | Indicação de óbito |
data.deathYear | String | Ano de óbito |
Consulta de CPF na Receita Federal (PF2)
Reúne informações básicas de um CPF.
Seção: pfData
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.name | String | Nome |
data.birthDate | String | Data de nascimento |
data.taxIdStatus | String | Situação do CPF em relação a Receita Federal |
data.issueDate | String | Data de emissão do CPF |
Dados básicos (PF1.1)
Reúne informações básicas de um CPF.
Seção: pfBasicData
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.name | String | Nome |
data.gender | String | Gênero |
data.birthDate | String | Data de nascimento |
data.motherName | String | Nome da mãe |
data.fatherName | String | Nome do pai |
data.taxIdNumber | String | Número do CPF |
data.taxIdCountry | String | País do documento |
data.alternativeIdNumbers | Object | Números alternativos de documento |
data.alternativeIdNumbers.SocialSecurityNumber | String | Número do Seguro Social |
data.taxIdStatus | String | Situação do CPF em relação a Receita Federal |
data.taxIdOrigin | String | Origem do CPF |
data.hasObitIndication | Boolean | Indicação de óbito |
data.obitIndicationOrigin | String | Origem da indicação de óbito |
data.obitIndicationYear | String | Ano da indicação de óbito |
data.taxIdStatusDate | String | Data da consulta de status |
data.creationDate | String | Data de criação |
data.lastUpdateDate | String | Última atualização |
Emails (PF11)
Retorna uma lista com os e-mails da pessoa.
Seção: pfEmails
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Array | Dados de retorno |
data[x].email | String | Endereço de email |
data[x].type | String | Tipo de email |
data[x].firstPassageDate | String | Data da primeira passagem |
data[x].lastPassageDate | String | Data da última passagem |
Endereços (PF12)
Retorna uma lista com os endereços da pessoa.
Seção: pfAddresses
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
message | String | Descritivo da situação da consulta |
data | Array | Dados de retorno |
data[x].typology | String | Tipo do Logradouro |
data[x].title | String | Título/Definição |
data[x].addressMain | String | Nome |
data[x].number | String | Número |
data[x].complement | String | Complemento |
data[x].neighborhood | String | Bairro |
data[x].zipCode | String | CEP |
data[x].city | String | Cidade |
data[x].state | String | Estado |
data[x].country | String | País |
data[x].type | String | Relação do Endereço |
data[x].complementType | String | Tipo de Endereço calculado a partir do complemento do endereço |
data[x].householdCode | Number | Código de household do endereço |
data[x].buildingCode | Number | Código de building do endereço |
data[x].householdTotalPassages | Number | Número de vezes que esse código de household foi visto para essa entidade |
data[x].householdBadPassages | Number | Número de vezes que esse código de household foi visto para essa entidade em uma situação suspeita |
data[x].householdCrawlingPassages | Number | Quantidade de passagens do household com a entidade que tem como origem uma captura |
data[x].householdValidationPassages | Number | Quantidade de passagens do household com a entidade que tem como origem uma validação |
data[x].householdQueryPassages | Number | Quantidade de passagens do household com a entidade que tem como origem uma consulta |
data[x].householdMonthAveragePassages | Number | Média de vezes que o household foi visto com a entidade por mês |
data[x].householdNumberOfEntities | Number | Quantidade de entidades distintas associadas a esse household |
data[x].buildingTotalPassages | Number | Número de vezes que esse código de building foi visto para essa entidade |
data[x].buildingBadPassages | Number | Número de vezes que esse código de building foi visto para essa entidade em uma situação suspeita |
data[x].buildingCrawlingPassages | Number | Quantidade de passagens do building com a entidade que tem como origem uma captura |
data[x].buildingValidationPassages | Number | Quantidade de passagens do building com a entidade que tem como origem uma validação |
data[x].buildingQueryPassages | Number | Quantidade de passagens do building com a entidade que tem como origem uma consulta |
data[x].buildingMonthAveragePassages | Number | Média de vezes que o building foi visto com a entidade por mês |
data[x].buildingNumberOfHouseholds | Number | Quantidade de households distintos associadas a esse building |
data[x].last3MonthsPassages | Number | Número de passagens da entidade nos últimos 3 meses |
data[x].last6MonthsPassages | Number | Número de passagens da entidade nos últimos 6 meses |
data[x].last12MonthsPassages | Number | Número de passagens da entidade nos últimos 12 meses |
data[x].last18MonthsPassages | Number | Número de passagens da entidade nos últimos 18 meses |
data[x].priority | Number | Indica a prioridade do endereço |
data[x].isMain | Boolean | Indica se o endereço é o principal |
data[x].isRecent | Boolean | Indica se esse endereço é recente |
data[x].isActive | Boolean | Indica se esse endereço está ativo |
data[x].isRatified | Boolean | Indica se o endereço foi ratificado junto a base de referência dos correios (DNE ou similar) |
data[x].firstPassageDate | String | Data da primeira passagem desse household com essa entidade |
data[x].lastPassageDate | String | Data da última passagem desse household com essa entidade |
data[x].creationDate | String | Data do primeiro registro relacionado |
data[x].lastUpdateDate | String | Última atualização do endereço |
data[x].hasOptIn | Boolean | Aceita receber encomendas e propagandas |
data[x].ibgeCode | String | Código do IBGE |
data[x].latitude | Number | Latitude |
data[x].longitude | Number | Longitude |
Validação de endereço residencial ou de trabalho
Retorna a probabilidade do CPF consultado morar ou trabalhar no endereço fornecido, com score de 0 a 1000 (quanto mais alto o score, mais provável deste ser o endereço) junto de informações sobre o endereço. Utiliza as localizações da rede móvel para fornecer um score para validação de endereço.
Seção: pfAddressAuthentication
Parâmetro obrigatório: cpf, phoneNumber, cep
Parâmetros adicionais: address, addressNumber
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo da situação da consulta |
data.cpf | String | CPF |
data.phoneNumber | String | Número de telefone |
data.zipCode | String | CEP |
data.score | String | Pontuação obtida a partir dos dados informados |
data.flagScore | String | Indicador da pontuação |
data.flagScoreDescription | String | Descrição do indicador da pontuação |
data.referenceId | String | Identificador de referência da consulta |
Telefones (PF13)
Retorna uma lista com os telefones da pessoa.
Seção: pfPhones
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Array | Dados de retorno |
data[x].number | String | Número de telefone |
data[x].areaCode | String | Código de área |
data[x].countryCode | String | Código do país |
data[x].type | String | Categoria do número |
data[x].lastPassageDate | String | Data de último uso |
data[x].portabilityHistory | Array | Histórico de portabilidade |
data[x].hasOptIn | Boolean | Aceita receber ligações para marketing |
Pessoas Relacionadas (PF39)
Retorna o nome e o grau de parentesco de pessoas possivelmente relacionadas a esta pessoa.
Seção: pfPersonalRelationships
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Array | Dados de retorno |
data[x].relatedEntityTaxIdNumber | String | Número do documento de identificação |
data[x].relatedEntityTaxIdType | String | Tipo do documento de identificação |
data[x].relatedEntityName | String | Nome da pessoa relacionada |
data[x].relationshipType | String | Tipo de relacionamento |
data[x].relationshipLevel | String | Nível de relacionamento |
Telefones de Pessoas Relacionadas (PF38)
Retorna o telefone e o grau de parentesco de pessoas possivelmente relacionadas a esta pessoa.
Seção: pfRelatedPeoplePhones
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Array | Dados de retorno |
data[x].number | String | Número do telefone |
data[x].areaCode | String | Código de área |
data[x].countryCode | String | Código do país |
data[x].type | String | Tipo |
data[x].lastPassageDate | String | Data da última validação |
data[x].portabilityHistory | Array | Histórico de portabilidade |
data[x].hasOptIn | Boolean | Aceita receber ligações para marketing |
DENATRAN Condutor
Consulta de dados do condutor e possíveis violações de trânsito do CPF junto ao Denatran.
Seção: denatranDriverViolations
Parâmetros obrigatórios: cpf, tenantId
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo da situação da consulta |
data.driver | Object | Contém as informações do motorista |
data.driver.isDriver | Boolean | Caso tenha um condutor para o documento informado (T/F) |
data.driver.cnhNumber | String | Número da CNH |
data.driver.cnhIssuerAgency | String | Orgáo emissor da CNH |
data.driver.driverName | String | Nome do condutor |
data.driver.driverGender | String | Sexo do condutor |
data.driver.driverBirthDate | String | Data de nascimento do condutor |
data.driver.documentType | String | Tipo do documento |
data.driver.documentNumber | String | Número do documento |
data.driver.driverNationality | String | Nacionalidade |
data.driver.driverMotherName | String | Nome da mãe |
data.driver.driverFatherName | String | Nome do pai |
data.driver.driverFirstLicenseDate | String | Data da primeira habilitação de condutor |
data.driver.pguId | String | Código PGU |
data.driver.cnhCategory | String | Categoria da CNH |
data.driver.addressUsedCnhRequest | String | Endereço cadastral utilizado na CNH |
data.driver.cnhStatus | String | Status da CNH |
data.driver.previousCnhStatus | String | Status anterior da CNH |
data.driver.cnhExpirationDate | String | Data de vencimento da CNH |
data.driver.ufDomain | String | Domínio da UF |
data.driver.renachFormNumber | Number | Número do formulário Renach |
data.driver.cnhFormNumber | Number | Número do formulário da CNH |
data.driver.impedimentListNumber | Number | Número da lista de impedimento |
data.driver.ufDocumentIssuer | String | UF do expeditor do Documento |
data.driver.placeOfBirth | String | Localidade de nascimento |
data.driver.requestReason1 | String | Motivo do requerimento 1 |
data.driver.requestReason2 | String | Motivo do requerimento 2 |
data.driver.requestReason3 | String | Motivo do requerimento 3 |
data.driver.requestReason4 | String | Motivo do requerimento 4 |
data.driver.ufFirstDriverLicense | String | UF da primeira habilitação |
data.driver.relegatedCategory | String | Categoria Rebaixada |
data.driver.authorizedCategory | String | Categoria Autorizada |
data.driver.ufCurrentDriverLicense | String | UF da habilitação atual |
data.driver.cnhRemarksTable | String | Quadro de observações atual |
data.driver.ufTransferApplicant | String | UF do solicitante de transferência |
data.driver.permitHolder | Number | Permissionario |
data.driver.cancellation | String | Cancelamento |
data.driver.lastRecordEmissionDate | String | Data de emissão de histórico |
data.driver.lastTransitionUpdateId | String | Código de transação da última atualização |
data.driver.lastTransitionUpdateDate | String | Data de transação da última atualização |
data.driver.courseTppRating | String | Classificação do curso TPP |
data.driver.ufCourseTpp | String | UF do curso TPP |
data.driver.courseTeRating | String | Classificação do curso TE |
data.driver.ufCourseTe | String | UF do curso TE |
data.driver.courseTcpRating | String | Classificação do curso TCP |
data.driver.ufCourseTcp | String | UF do curso TCP |
data.driver.courseTveRating | String | Classificação do curso TVE |
data.driver.ufCourseTve | String | UF do curso TVE |
data.driver.courseTciRating | String | Classificação do curso TCI |
data.driver.ufCourseTci | String | UF do curso TCI |
data.driver.courseTmtRating | String | Classificação do curso TMT |
data.driver.ufCourseTmt | String | UF do curso TMT |
data.driver.courseTmfRating | String | Classificação do curso TMF |
data.driver.ufCourseTmf | String | UF do curso TMF |
data.driver.ufRecyclingCourseViolator | String | UF do curso de reciclagem de infrator |
data.driver.modalityRecyclingCourseViolator | String | Modalidade do curso de reciclagem de infrator |
data.driver.ufRefreshCourseCnh | String | UF do curso de renovação da CNH |
data.driver.refreshCourseCnh | String | Modalidade do curso de renovação da CNH |
data.driver.nationalRegistrationForeigner | String | Registro nacional de estrangeiro |
data.driver.countryOriginDriverLicense | String | País de origem da habilitação estrangeira |
data.driver.foreignDriverLicenseId | String | Identificação da habilitação estrangeira |
data.driver.expirationDatePid | String | Data de validade do PID |
data.driver.ufExpeditionPid | String | UF de expedição do PID |
data.driver.numberFormCnhBasedPid | String | Número do formulário da CNH com base no PID |
data.driver.requestReasonPid1 | String | Motivo do requerimento do PID 1 |
data.driver.requestReasonPid2 | String | Motivo do requerimento do PID 2 |
data.driver.requestReasonPid3 | String | Motivo do requerimento do PID 3 |
data.driver.requestReasonPid4 | String | Motivo do requerimento do PID 4 |
data.driver.statusPid | String | Situação do PID |
data.driver.medicalRestrictions | String | Restrições médicas |
data.driver.quantityIncidentsImpediments | String | Quantidade de ocorrências e/ou Impedimentos |
data.violations | Array | Lista de violações de trânsito |
data.violations[x].violationId | String | Código da Infração |
data.violations[x].violationBreakdownId | String | Código de Desdobramento da Infração |
data.violations[x].violationDescription | String | Descrição da Infração |
data.violations[x].renainfId | String | Código Renainf |
data.violations[x].violationRegistrationDate | String | Data de cadastro da Infração |
data.violations[x].actuatorAgencyState | String | UF do Órgão Autuador |
data.violations[x].plate | String | Placa |
data.violations[x].renavamId | String | Código Renavam |
data.violations[x].modelBrandId | String | Código da marca e modelo do veículo |
data.violations[x].modelBrandDescription | String | Descrição da marca e modelo do veículo |
data.violations[x].vehicleTypeId | Number | Código do tipo de veículo |
data.violations[x].vehicleTypeDescription | String | Descrição do tipo de veículo |
data.violations[x].vehicleColorId | Number | Código da cor do veículo |
data.violations[x].vehicleColorDescription | String | Decrição da cor do veículo |
data.violations[x].vehicleKindId | Number | Código da espécie de veículo |
data.violations[x].vehicleKindDescription | String | Descrição da espécie de veículo |
data.violations[x].vehicleBodyworkId | Number | Código da carroceria do veículo |
data.violations[x].vehicleBodyworkDescription | String | Descrição da carroceria do veículo |
data.violations[x].vehicleCategoryId | Number | Código da categoria do veículo |
data.violations[x].vehicleCategoryDescription | String | Descrição da categoria do veículo |
data.violations[x].vehicleJurisdictionState | String | UF da jurisdição do veículo |
data.violations[x].informedRegistrationState | String | UF de emplacamento do veículo |
data.violations[x].registrationCityId | Number | Código do município de emplacamento do veículo |
data.violations[x].registrationCityDescription | String | Descrição do município de emplacamento do veículo |
data.violations[x].vehicleCoutryId | Number | Código do país do veículo |
data.violations[x].vehicleCoutryDescription | String | Descrição do país do veículo |
data.violations[x].restrictionId1 | Number | Código de restrição 1 |
data.violations[x].restrictionDescription1 | String | Descrição de restrição 1 |
data.violations[x].restrictionId2 | Number | Código de restrição 2 |
data.violations[x].restrictionDescription2 | String | Descrição de restrição 2 |
data.violations[x].restrictionId3 | Number | Código de restrição 3 |
data.violations[x].restrictionDescription3 | String | Descrição de restrição 3 |
data.violations[x].restrictionId4 | Number | Código de restrição 4 |
data.violations[x].restrictionDescription4 | String | Descrição de restrição 4 |
data.violations[x].restrictionIndicatorRenajud | Boolean | Indicador de restrição Renajud |
data.violations[x].restrictionIndicatorRenavam | Boolean | Indicador de restrição Renavam |
data.violations[x].burglaryTheftIndicatorRenavam | Boolean | Indicador de furto ou roubo Renavam |
data.violations[x].actuatorAgencyId | String | Código do Órgão autuador |
data.violations[x].actuatorAgencyDescription | String | Descrição do Órgão autuador |
data.violations[x].autoInfractionNumber | String | Número do auto de infração |
data.violations[x].autoSignatureId | Number | Indicador de assinatura do auto de infração |
data.violations[x].autoSignatureDescription | String | Descrição de assinatura do auto de infração |
data.violations[x].driverCnhModelId | Number | Código do modelo de CNH do condutor |
data.violations[x].driverCnhModelDescription | String | Descrição do modelo de CNH do condutor |
data.violations[x].driverCnhRegistrationNumber | String | Código do número de registro da CNH do condutor |
data.violations[x].driverCnhExpeditionState | String | Descrição do número de registro da CNH do condutor |
data.violations[x].violationDate | String | Data da infração |
data.violations[x].violationTime | String | Hora da infração |
data.violations[x].violationOccurrencePlace | String | Local de ocorrência da infração |
data.violations[x].violationCityId | String | Código da cidade da infração |
data.violations[x].violationCityDescription | String | Descrição da cidade da infração |
data.violations[x].autoTypeId | Number | Código do tipo de auto |
data.violations[x].autoTypeDescription | String | Descrição do tipo de auto |
data.violations[x].notLicensedDriverDocumentNumber | String | Número do documento do condutor não habilitado |
data.violations[x].notLicensedDriverDocumentTypeId | Number | Código do número do documento do condutor não habilitado |
data.violations[x].notLicensedDriverDocumentTypeDescription | String | Descrição do número do documento do condutor não habilitado |
data.violations[x].actualMeasurement | String | Medição real |
data.violations[x].allowedLimit | String | Limite Permitido |
data.violations[x].measurementConsidered | String | Medição considerada |
data.violations[x].measurementUnitId | Number | Código da unidade de medida |
data.violations[x].measurementUnitDescription | String | Descrição da unidade de medida |
data.violations[x].violationFullValue | String | Valor integral da infração |
data.violations[x].vehicleOwnerOriginId | Number | Código da origem do possuidor |
data.violations[x].vehicleOwnerOriginDescription | String | Descrição da origem do possuidor |
data.violations[x].ownerDocumentTypeId | Number | Código do tipo do documento do possuidor |
data.violations[x].ownerDocumentTypeDescription | String | Descrição do tipo do documento do possuidor |
data.violations[x].ownerIdentificationNumber | String | Número de identificação do possuidor |
data.violations[x].ownerName | String | Nome do possuidor |
data.violations[x].notificationNoticeIssueDate | String | Data de emissão da notificação de autuação |
data.violations[x].defenseNoticeLimitDate | String | Data limite de defesa da autuação |
data.violations[x].notificationNoticeIndicator | Boolean | Indicador da notificação do edital de autuação |
data.violations[x].numberNotificationPenalty | String | Número da notificação de penalidade |
data.violations[x].penaltyNotificationIssueDate | String | Data da emissão da notificação de penalidade |
data.violations[x].penaltyNotificationExpirationDate | String | Data de vencimento da notificação de penalidade |
data.violations[x].penaltyType | Number | Tipo da penalidade |
data.violations[x].penaltyDescription | String | Descrição da penalidade |
data.violations[x].violatorActualName | String | Nome do real infrator |
data.violations[x].violatorActualCnhModelId | Number | Código do modelo da CNH do real infrator |
data.violations[x].violatorActualCnhModelDescription | String | Descrição do modelo da CNH do real infrator |
data.violations[x].violatorActualCnhRegistrationNumber | String | Número de registro da CNH do real infrator |
data.violations[x].driverActualCnhExpeditionState | String | UF de emissão da CNH do real condutor |
data.violations[x].scoreAnalysisStatusId | String | Indicador do status da análise de pontuação |
data.violations[x].scoreAnalysisStatusDescription | String | Descrição do status da análise de pontuação |
data.violations[x].scoredCnhModelId | Number | Código do modelo da CNH pontuada |
data.violations[x].scoredCnhModelDescription | String | Descrição do modelo da CNH pontuada |
data.violations[x].scoredCnhRegistrationNumber | String | Número de registro da CNH pontuada |
data.violations[x].scoredCnhExpeditionState | String | UF de expedição da CNH pontuada |
data.violations[x].enforceabilityId | Number | Indicador de exigibilidade |
data.violations[x].enforceabilityDescription | String | Descrição do indicador de exigibilidade |
data.violations[x].paymentState | String | Uf do pagamento |
data.violations[x].violationPaymentDate | String | Data de pagamento da infração |
data.violations[x].violationPaidValue | String | Valor pago da infração |
data.violations[x].paymentRegistrationDate | String | Data de registro do pagamento da infração |
data.violations[x].paymentsAmount | Number | Total de pagamentos |
data.violations[x].occurrenceTypeId | Number | Código do tipo de ocorrência |
data.violations[x].occurrenceTypeDescription | String | Descrição do tipo de ocorrência |
data.violations[x].occurrenceOriginDescription | String | Descrição da origem da ocorrência |
data.violations[x].proccessNumber | String | Número do processo |
DENATRAN Veículo
Consulta de dados gerais da placa e possíveis violações de trânsito do veículo junto ao Denatran.
Seção: denatranVehicleViolations
Parâmetros obrigatórios: plate, tenantId
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo da situação da consulta |
data.vehicle | Object | Contém as informações do veículo |
data.vehicle.hasVehicle | Boolean | Caso tenha um veículo para a placa informada (T/F) |
data.vehicle.manufactureYear | Number | Ano de fabricação |
data.vehicle.modelYear | Number | Ano do modelo |
data.vehicle.cmc | Number | CMC |
data.vehicle.cmt | Number | CMT |
data.vehicle.bodyworkTypeId | String | Código do tipo de carroceria |
data.vehicle.bodyworkTypeDescription | String | Descrição do tipo de carroceria |
data.vehicle.categoryId | String | Código da cetegoria |
data.vehicle.categoryDescription | String | Descrição da categoria |
data.vehicle.chassiSerial | String | Número de série do chassi |
data.vehicle.engineCapacity | Number | Cilindradas |
data.vehicle.fuelId | String | Código do combustível |
data.vehicle.fuelDescription | String | Descrição do tipo de combustível |
data.vehicle.colorId | String | Código da cor |
data.vehicle.colorDescription | String | Descrição da cor |
data.vehicle.speciesId | String | Código da espécie |
data.vehicle.speciesDescription | String | Descrição da espécie |
data.vehicle.alarmIndication | Boolean | Indicador de alarme |
data.vehicle.burglaryTheftIndicator | Boolean | Indicador de roubo ou furto |
data.vehicle.vehicleCapacity | Number | Lotação |
data.vehicle.modelBrandId | String | Código de marca e modelo |
data.vehicle.modelBrandDescription | String | Descrição de marca e modelo |
data.vehicle.licensePlateMunicipalityId | String | Código do município de emplacamento |
data.vehicle.licensePlateMunicipalityDescription | String | Descrição do município de emplacamento |
data.vehicle.quantityAxles | Number | Quantidade de eixos |
data.vehicle.pbt | Number | PBT |
data.vehicle.plate | String | Placa |
data.vehicle.power | Number | Potência |
data.vehicle.situation | String | Situação |
data.vehicle.vehicleTypeType | String | Código do tipo de veículo |
data.vehicle.vehicleTypeDescription | String | Descrição do tipo de veículo |
data.vehicle.stateJurisdiction | String | UF de jurisdição |
data.vehicle.limitDate | String | Data limite |
data.vehicle.salesCommunicationIndicator | Boolean | Indicador de comunicação de venda |
data.vehicle.publicSaleIndicator | Boolean | Indicador de leilão |
data.vehicle.trafficTicketRenainfIndicator | Boolean | Indicador de multa Renainf |
data.vehicle.pendingIssueIndicator | Boolean | Indicador de pendência de emissão |
data.vehicle.recallIndicator1 | Boolean | Indicador de recall 1 |
data.vehicle.recallIndicator2 | Boolean | Indicador de recall 2 |
data.vehicle.recallIndicator3 | Boolean | Indicador de recall 3 |
data.vehicle.manufacturerRecallIndicator | Boolean | Indicador de recall da montadora |
data.vehicle.restriction1Id | String | Código de restrição 1 |
data.vehicle.restriction1Description | String | Descrição de restrição 1 |
data.vehicle.restriction2Id | String | Código de restrição 2 |
data.vehicle.restriction2Description | String | Descrição de restrição 2 |
data.vehicle.restriction3Id | String | Código de restrição 3 |
data.vehicle.restriction3Description | String | Descrição de restrição 3 |
data.vehicle.restriction4Id | String | Código de restrição 4 |
data.vehicle.restriction4Description | String | Descrição de restrição 4 |
data.vehicle.restrictionIndicatorRenajud | Boolean | Indicador de restrição Renajud |
data.vehicle.rfbRestrictionId | String | Código de restrição RFB |
data.vehicle.rfbRestrictionDescription | String | Descrição de restrição RFB |
data.vehicle.origin | String | Procedência |
data.vehicle.tenantTypeId | String | Código do tipo de arrendatário |
data.vehicle.tenantTypeDescription | String | Descrição do tipo de arrendatário |
data.vehicle.bodyworkNumber | String | Número da carroceria |
data.vehicle.chassisMarkupId | String | Código de remarcação do chassi |
data.vehicle.chassisMarkupDescription | String | Descrição de remarcação do chassi |
data.vehicle.dischargeDate | String | Data de baixa |
data.vehicle.crvIssueDate | String | Data de emissão do CRV |
data.vehicle.lastUpdateDate | String | Data da última atualização |
data.vehicle.mreUpdateDate | String | Data de atualização do MRE |
data.vehicle.importDistDate | String | Data Dist Importação |
data.vehicle.rfbPartId | String | Código do órgão RFB |
data.vehicle.rfbPartDescription | String | Descrição do órgão RFB |
data.vehicle.auxiliaryAxeNumber | String | Número do eixo auxiliar |
data.vehicle.rearAxeNumber | String | Número do eixo traseiro |
data.vehicle.billOrigin | String | Natureza do faturado |
data.vehicle.stateBilling | String | UF do faturado |
data.vehicle.importerOrigin | String | Natureza do importador |
data.vehicle.documentImporterDescription | String | Descrição do importador |
data.vehicle.transferCountryId | String | Código do país de transferência |
data.vehicle.transferCountryDescription | String | Descrição do país de transferência |
data.vehicle.ownerDocumentIndicatorId | String | Tipo do documento do proprietário indicado |
data.vehicle.ownerDocumentIndicatorDescription | String | Descrição do documento do proprietário indicado |
data.vehicle.ownerTypeId | String | Código do tipo do proprietário |
data.vehicle.ownerTypeDescription | String | Descrição do tipo do proprietário |
data.violations | Array | Lista de violações de trânsito |
data.violations[x].violationId | String | Código da Infração |
data.violations[x].violationBreakdownId | String | Código de Desdobramento da Infração |
data.violations[x].violationDescription | String | Descrição da Infração |
data.violations[x].renainfId | String | Código Renainf |
data.violations[x].violationRegistrationDate | String | Data de cadastro da Infração |
data.violations[x].actuatorAgencyState | String | UF do Órgão Autuador |
data.violations[x].plate | String | Placa |
data.violations[x].renavamId | String | Código Renavam |
data.violations[x].modelBrandId | String | Código da marca e modelo do veículo |
data.violations[x].modelBrandDescription | String | Descrição da marca e modelo do veículo |
data.violations[x].vehicleTypeId | Number | Código do tipo de veículo |
data.violations[x].vehicleTypeDescription | String | Descrição do tipo de veículo |
data.violations[x].vehicleColorId | Number | Código da cor do veículo |
data.violations[x].vehicleColorDescription | String | Decrição da cor do veículo |
data.violations[x].vehicleKindId | Number | Código da espécie de veículo |
data.violations[x].vehicleKindDescription | String | Descrição da espécie de veículo |
data.violations[x].vehicleBodyworkId | Number | Código da carroceria do veículo |
data.violations[x].vehicleBodyworkDescription | String | Descrição da carroceria do veículo |
data.violations[x].vehicleCategoryId | Number | Código da categoria do veículo |
data.violations[x].vehicleCategoryDescription | String | Descrição da categoria do veículo |
data.violations[x].vehicleJurisdictionState | String | UF da jurisdição do veículo |
data.violations[x].informedRegistrationState | String | UF de emplacamento do veículo |
data.violations[x].registrationCityId | Number | Código do município de emplacamento do veículo |
data.violations[x].registrationCityDescription | String | Descrição do município de emplacamento do veículo |
data.violations[x].vehicleCoutryId | Number | Código do país do veículo |
data.violations[x].vehicleCoutryDescription | String | Descrição do país do veículo |
data.violations[x].restrictionId1 | Number | Código de restrição 1 |
data.violations[x].restrictionDescription1 | String | Descrição de restrição 1 |
data.violations[x].restrictionId2 | Number | Código de restrição 2 |
data.violations[x].restrictionDescription2 | String | Descrição de restrição 2 |
data.violations[x].restrictionId3 | Number | Código de restrição 3 |
data.violations[x].restrictionDescription3 | String | Descrição de restrição 3 |
data.violations[x].restrictionId4 | Number | Código de restrição 4 |
data.violations[x].restrictionDescription4 | String | Descrição de restrição 4 |
data.violations[x].restrictionIndicatorRenajud | Boolean | Indicador de restrição Renajud |
data.violations[x].restrictionIndicatorRenavam | Boolean | Indicador de restrição Renavam |
data.violations[x].burglaryTheftIndicatorRenavam | Boolean | Indicador de furto ou roubo Renavam |
data.violations[x].actuatorAgencyId | String | Código do Órgão autuador |
data.violations[x].actuatorAgencyDescription | String | Descrição do Órgão autuador |
data.violations[x].autoInfractionNumber | String | Número do auto de infração |
data.violations[x].autoSignatureId | Number | Indicador de assinatura do auto de infração |
data.violations[x].autoSignatureDescription | String | Descrição de assinatura do auto de infração |
data.violations[x].driverCnhModelId | Number | Código do modelo de CNH do condutor |
data.violations[x].driverCnhModelDescription | String | Descrição do modelo de CNH do condutor |
data.violations[x].driverCnhRegistrationNumber | String | Código do número de registro da CNH do condutor |
data.violations[x].driverCnhExpeditionState | String | Descrição do número de registro da CNH do condutor |
data.violations[x].violationDate | String | Data da infração |
data.violations[x].violationTime | String | Hora da infração |
data.violations[x].violationOccurrencePlace | String | Local de ocorrência da infração |
data.violations[x].violationCityId | String | Código da cidade da infração |
data.violations[x].violationCityDescription | String | Descrição da cidade da infração |
data.violations[x].autoTypeId | Number | Código do tipo de auto |
data.violations[x].autoTypeDescription | String | Descrição do tipo de auto |
data.violations[x].notLicensedDriverDocumentNumber | String | Número do documento do condutor não habilitado |
data.violations[x].notLicensedDriverDocumentTypeId | Number | Código do número do documento do condutor não habilitado |
data.violations[x].notLicensedDriverDocumentTypeDescription | String | Descrição do número do documento do condutor não habilitado |
data.violations[x].actualMeasurement | String | Medição real |
data.violations[x].allowedLimit | String | Limite Permitido |
data.violations[x].measurementConsidered | String | Medição considerada |
data.violations[x].measurementUnitId | Number | Código da unidade de medida |
data.violations[x].measurementUnitDescription | String | Descrição da unidade de medida |
data.violations[x].violationFullValue | String | Valor integral da infração |
data.violations[x].vehicleOwnerOriginId | Number | Código da origem do possuidor |
data.violations[x].vehicleOwnerOriginDescription | String | Descrição da origem do possuidor |
data.violations[x].ownerDocumentTypeId | Number | Código do tipo do documento do possuidor |
data.violations[x].ownerDocumentTypeDescription | String | Descrição do tipo do documento do possuidor |
data.violations[x].ownerIdentificationNumber | String | Número de identificação do possuidor |
data.violations[x].ownerName | String | Nome do possuidor |
data.violations[x].notificationNoticeIssueDate | String | Data de emissão da notificação de autuação |
data.violations[x].defenseNoticeLimitDate | String | Data limite de defesa da autuação |
data.violations[x].notificationNoticeIndicator | Boolean | Indicador da notificação do edital de autuação |
data.violations[x].numberNotificationPenalty | String | Número da notificação de penalidade |
data.violations[x].penaltyNotificationIssueDate | String | Data da emissão da notificação de penalidade |
data.violations[x].penaltyNotificationExpirationDate | String | Data de vencimento da notificação de penalidade |
data.violations[x].penaltyType | Number | Tipo da penalidade |
data.violations[x].penaltyDescription | String | Descrição da penalidade |
data.violations[x].violatorActualName | String | Nome do real infrator |
data.violations[x].violatorActualCnhModelId | Number | Código do modelo da CNH do real infrator |
data.violations[x].violatorActualCnhModelDescription | String | Descrição do modelo da CNH do real infrator |
data.violations[x].violatorActualCnhRegistrationNumber | String | Número de registro da CNH do real infrator |
data.violations[x].driverActualCnhExpeditionState | String | UF de emissão da CNH do real condutor |
data.violations[x].scoreAnalysisStatusId | String | Indicador do status da análise de pontuação |
data.violations[x].scoreAnalysisStatusDescription | String | Descrição do status da análise de pontuação |
data.violations[x].scoredCnhModelId | Number | Código do modelo da CNH pontuada |
data.violations[x].scoredCnhModelDescription | String | Descrição do modelo da CNH pontuada |
data.violations[x].scoredCnhRegistrationNumber | String | Número de registro da CNH pontuada |
data.violations[x].scoredCnhExpeditionState | String | UF de expedição da CNH pontuada |
data.violations[x].enforceabilityId | Number | Indicador de exigibilidade |
data.violations[x].enforceabilityDescription | String | Descrição do indicador de exigibilidade |
data.violations[x].paymentState | String | Uf do pagamento |
data.violations[x].violationPaymentDate | String | Data de pagamento da infração |
data.violations[x].violationPaidValue | String | Valor pago da infração |
data.violations[x].paymentRegistrationDate | String | Data de registro do pagamento da infração |
data.violations[x].paymentsAmount | Number | Total de pagamentos |
data.violations[x].occurrenceTypeId | Number | Código do tipo de ocorrência |
data.violations[x].occurrenceTypeDescription | String | Descrição do tipo de ocorrência |
data.violations[x].occurrenceOriginDescription | String | Descrição da origem da ocorrência |
data.violations[x].proccessNumber | String | Número do processo |
ANTT
Consulta no site da ANTT para identificar se o transportador esta habilitado para realizar atividades.
Seção: antt
Parâmetro obrigatório: cpf, plate
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.hasRegister | Boolean | Status informando se contém registro |
data.transporter | String | Transportadora |
data.rntrc | String | Número RNTRC |
data.rntrcSituation | String | Status |
data.memberSince | String | Data da primeira relação |
data.expirationDate | String | Data de expiração |
data.city | String | Cidade |
data.message | String | Mensagem presente no cadastro |
Dados de Sites (PF32)
Retorna informações dos sites e domínios que estão associados com o CPF consultado, seja através do registro de domínios ou através de informações contidas dentro do próprio conteúdo do site.
Seção: pfDomains
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Array | Dados de retorno |
data[x].hostName | String | Nome do Host |
data[x].domainName | String | Nome do domínio |
data[x].domainClass | String | Classificação do site |
data[x].registrationStatus | String | Status de registro |
data[x].registrationDate | String | Data de criação do site |
data[x].expirationDate | String | Data de expiração do site |
Servidor Público (PF34)
Retorna informações agregadas e detalhadas dos funcionários públicos. Esta consulta retorna dados tais como Indicador e detalhes de Servidor Público.
Seção: pfProfessionData
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
query | Object | Parâmetros utilizados na consulta (detalhes) |
query.data.cpf | String | CPF utilizado na consulta |
data | Object | Dados de retorno |
data.professions | Array | Lista de objetos com os detalhes de cada trabalho encontrado |
data.professions[x].source | String | Fonte da informação |
data.professions[x].sector | String | Setor da empresa |
data.professions[x].state | String | Estado da empresa |
data.professions[x].country | String | País em que a profissão é exercida |
data.professions[x].companyIdNumber | String | Número de identificação da companhia (cnpj) |
data.professions[x].companyName | String | Nome da empresa |
data.professions[x].area | String | Área da empresa aonde a pessoa trabalha |
data.professions[x].level | String | Cargo ou posição (quando disponível) |
data.professions[x].status | String | Situação empregatícia. |
data.professions[x].incomeRange | String | Faixa salarial estimada para esse trabalho |
data.professions[x].income | Number | Renda estimada proporcionada por esse trabalho |
data.professions[x].startDate | Date | Data de início ou admissão no trabalho |
data.professions[x].endDate | Date | Data de término ou desligamento do trabalho |
data.professions[x].situation | String | Situação do funcionario |
data.professions[x].isDead | String | Funcionário é falecido |
data.professions[x].companyAdmissionDate | String | Data de admissão na empresa |
data.professions[x].jobFunction | String | Função do trabalho |
data.professions[x].jobRole | String | Cargo |
data.professions[x].servantType | String | Tipo de empregado |
data.professions[x].workload | String | Carga de trabalho |
data.professions[x].organType | String | Tipo do órgão |
data.professions[x].headBranch | String | Vara superior |
data.professions[x].incomeHistory | Array | Histórico de pagamentos |
data.professions[x].incomeHistory[x].income | String | Valor recebido |
data.professions[x].incomeHistory[x].referenceDate | Date | Data de referência |
data.professions[x].averageIncome | Number | Média salarial |
data.professions[x].maxIncome | Number | Maior valor recebido |
data.professions[x].minIncome | Number | Menor valor recebido |
data.professions[x].registrationNumber | String | Número de registro |
data.professions[x].creationDate | Date | Data de criação |
data.professions[x].lastUpdateDate | Date | Data da última atualização |
data.professions[x].totalProfessions | Number | Número total de profissões exercidas |
data.professions[x].totalActiveProfessions | Number | Número total de profissões exercidas ativas |
data.professions[x].totalIncomeRange | String | Faixa de renda renda |
data.professions[x].totalIncome | Number | Total de renda |
data.professions[x].isEmployed | Boolean | Indica se a pessoa está empregada ou não |
Risco
Antecedentes Criminais - Polícia Federal (PF3)
Emissão de uma certidão de antecedentes criminais junto a Polícia Federal.
Seção: pfBackgroundCheckFederalPolice
pfCriminalBackground
Parâmetro obrigatório: cpf
Parâmetros adicionais recomendados: name, birthDate
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
query | Object | Parâmetros utilizados na consulta (detalhes) |
query.data.cpf | String | CPF utilizado na consulta |
query.data.name | String | Nome utilizado na consulta |
query.data.birthDate | String | Data de nascimento utilizada na consulta |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.idNumber | String | CPF da pessoa |
data.status | String | Status da certidão (CONSTA / NÃO CONSTA) |
data.certificateNumber | String | Número da certidão |
data.certificateText | String | Descrição da certidão (conteúdo) |
data.emissionDate | String | Data de emissão da certidão |
data.validity | String | Validade da certidão |
Mandado de privação de liberdade do CNJ (PF90)
Retorna informações sobre a existência de mandados (Prisão, Internação) junto ao Conselho Nacional de Justiça (CNJ).
Seção: pfArrestWarrant
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.status | String | Status relacionado a existência ou não de mandados (CONSTA / NÃO CONSTA) |
data.warrants | Array | Lista de mandados |
data.warrants[x].warrantNumber | String | Número do mandado |
data.warrants[x].name | String | Nome |
data.warrants[x].status | String | Situação |
data.warrants[x].date | String | Data |
data.warrants[x].issuingAuthority | String | Órgão expedidor |
Processos Judiciais e Administrativos (PF48)
Retorna informações sobre ações judiciais que a pessoa tenha, seja de qualquer tipo (criminal, civil, trabalhista, ...).
Seção: pf_processes_alt
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
available | Boolean | Disponibilidade da fonte |
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.total | Number | Quantidade total de processos |
data.results | Array | Lista de processos retornada |
data.results[x].id | String | Identificador da consulta |
data.results[x].criminalCategory | String | Categoria do processo |
data.results[x].lawsuitClass | String | Classe |
data.results[x].distributionDate | String | Data da distribuição |
data.results[x].statusDate | String | Data do status |
data.results[x].lawsuitDegree | String | Grau do processo |
data.results[x].physicalLocation | String | Local físico |
data.results[x].oldLawsuitNumber | String | Número antigo do processo |
data.results[x].judgingBody | String | Órgão julgador |
data.results[x].lawsuitId | String | Número do processo |
data.results[x].isDigitalLawsuit | Boolean | Se o processo é digital |
data.results[x].lawBranch | String | Ramo do Direito |
data.results[x].segment | String | Segmento |
data.results[x].isJusticeSecret | Boolean | Se é segredo de justiça |
data.results[x].complementaryStatus | String | Status complementar |
data.results[x].observationStatus | String | Status da observação |
data.results[x].court | String | Tribunal |
data.results[x].state | String | UF |
data.results[x].sourceUnit | String | Unidade de origem |
data.results[x].lawsuitUrl | String | URL do processo |
data.results[x].lawsuitValue | Object | Retorno do valor do processo |
data.results[x].lawsuitValue.currency | String | Moeda (R$, U$, etc) |
data.results[x].lawsuitValue.value | Number | Valor |
data.results[x].subjects | String Array | Lista de assuntos |
data.results[x].moves | Array | Lista de movimentações do processo |
data.results[x].moves[x].date | String | Data da movimentação |
data.results[x].moves[x].description | String | Descrição da movimentação |
data.results[x].actives | Array | Lista dos ativos |
data.results[x].actives[x].cnpj | String | CNPJ |
data.results[x].actives[x].cpf | String | CPF |
data.results[x].actives[x].name | String | Nome |
data.results[x].actives[x].type | String | Tipo |
data.results[x].actives[x].lawyers | Array | Lista de Advogados |
data.results[x].actives[x].lawyers[x].oab | String | Número da OAB |
data.results[x].actives[x].lawyers[x].name | String | Nome |
data.results[x].actives[x].lawyers[x].cpf | String | CPF |
data.results[x].passives | Array | Lista de passivos |
data.results[x].passives[x].cnpj | String | CNPJ |
data.results[x].passives[x].cpf | String | CPF |
data.results[x].passives[x].name | String | Nome |
data.results[x].passives[x].type | String | Tipo |
data.results[x].passives[x].lawyers | Array | Lista de Advogados |
data.results[x].passives[x].lawyers[x].oab | String | Número da OAB |
data.results[x].passives[x].lawyers[x].name | String | Nome |
data.results[x].passives[x].lawyers[x].cpf | String | CPF |
data.results[x].authorType | String | Tipo do autor |
Processos com palavras-chave (PF49)
Retorna informações sobre ações judiciais que a pessoa tenha, seja de qualquer tipo (criminal, civil, trabalhista, ...).
Seção: pf_processes_with_keywords
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
available | Boolean | Disponibilidade da fonte |
statusCode | String | Situação da consulta (detalhes) |
query | Object | Parâmetros utilizados na consulta (detalhes) |
query.data.cpf | String | CPF utilizado na consulta |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.total | Number | Quantidade total de processos |
data.results | Array | Lista de processos retornada |
data.results[x].id | String | Identificador da consulta |
data.results[x].criminalCategory | String | Categoria do processo |
data.results[x].lawsuitClass | String | Classe |
data.results[x].distributionDate | String | Data da distribuição |
data.results[x].statusDate | String | Data do status |
data.results[x].lawsuitDegree | String | Grau do processo |
data.results[x].physicalLocation | String | Local físico |
data.results[x].oldLawsuitNumber | String | Número antigo do processo |
data.results[x].judgingBody | String | Órgão julgador |
data.results[x].lawsuitId | String | Número do processo |
data.results[x].isDigitalLawsuit | Boolean | Se o processo é digital |
data.results[x].lawBranch | String | Ramo do Direito |
data.results[x].segment | String | Segmento |
data.results[x].isJusticeSecret | Boolean | Se é segredo de justiça |
data.results[x].complementaryStatus | String | Status complementar |
data.results[x].observationStatus | String | Status da observação |
data.results[x].court | String | Tribunal |
data.results[x].state | String | UF |
data.results[x].sourceUnit | String | Unidade de origem |
data.results[x].lawsuitUrl | String | URL do processo |
data.results[x].otherFields | Object | Outros campos |
data.results[x].otherFields.juiz | Object | Juiz |
data.results[x].otherFields.juiz.nome | String | Nome do Juiz |
data.results[x].lawsuitValue | Object | Retorno do valor do processo |
data.results[x].lawsuitValue.currency | String | Moeda (R$, U$, etc) |
data.results[x].lawsuitValue.value | Number | Valor |
data.results[x].subjects | String Array | Lista de assuntos |
data.results[x].moves | Array | Lista de movimentações do processo |
data.results[x].moves[x].date | String | Data da movimentação |
data.results[x].moves[x].description | String | Descrição da movimentação |
data.results[x].actives | Array | Lista dos ativos |
data.results[x].actives[x].cnpj | String | CNPJ |
data.results[x].actives[x].cpf | String | CPF |
data.results[x].actives[x].name | String | Nome |
data.results[x].actives[x].type | String | Tipo |
data.results[x].actives[x].lawyers | Array | Lista de Advogados |
data.results[x].actives[x].lawyers[x].oab | String | Número da OAB |
data.results[x].actives[x].lawyers[x].name | String | Nome |
data.results[x].actives[x].lawyers[x].cpf | String | CPF |
data.results[x].passives | Array | Lista de passivos |
data.results[x].passives[x].cnpj | String | CNPJ |
data.results[x].passives[x].cpf | String | CPF |
data.results[x].passives[x].name | String | Nome |
data.results[x].passives[x].type | String | Tipo |
data.results[x].passives[x].lawyers | Array | Lista de Advogados |
data.results[x].passives[x].lawyers[x].oab | String | Número da OAB |
data.results[x].passives[x].lawyers[x].name | String | Nome |
data.results[x].passives[x].lawyers[x].cpf | String | CPF |
data.results[x].authorType | String | Tipo do autor |
KYC and Compliance (PF17)
Seção: pfKycCompliance
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
query | Object | Parâmetros utilizados na consulta (detalhes) |
query.data.cpf | String | CPF utilizado na consulta |
data | Object | Dados de retorno |
data.message | String | Descritivo da situação da consulta |
data.pepHistory | Array | Lista de objetos com histórico de exposição política |
data.pepHistory[x].level | String | Nível de PPE(Pessoa Politicamente Exposta) |
data.pepHistory[x].jobTitle | String | Cargo |
data.pepHistory[x].department | String | Departamento |
data.pepHistory[x].motive | String | Motivo |
data.pepHistory[x].cpf | String | CPF |
data.pepHistory[x].source | String | Fonte |
data.pepHistory[x].link | String | Link |
data.pepHistory[x].startDate | String | Data em que a pessoa tornou-se uma PPE |
data.pepHistory[x].endDate | String | Data em que a pessoa deixou de ser uma PPE |
data.pepHistory[x].creationDate | String | Data de criação |
data.pepHistory[x].lastUpdateDate | String | Data da última atualização |
data.sanctionsHistory | Array | Lista de objetos com o histórico de sanções e restrições |
data.sanctionsHistory[x].source | String | Fonte da sanção |
data.sanctionsHistory[x].type | String | Tipo de sanção |
data.sanctionsHistory[x].matchRate | String | Indicação do quão próximo o nome se assemelha |
data.sanctionsHistory[x].startDate | String | Data de início |
data.sanctionsHistory[x].endDate | String | Data de término |
data.sanctionsHistory[x].originalName | String | Nome original associado com o indivíduo |
data.sanctionsHistory[x].sanctionName | String | Nome registrado na lista de sanções internacionais |
data.sanctionsHistory[x].nationalities | String | Nacionalidades associadas com o indivíduo |
data.sanctionsHistory[x].image | String | Foto do indivíduo |
data.sanctionsHistory[x].height | String | Altura do indivíduo |
data.sanctionsHistory[x].eyes | String | Cor dos olhos |
data.sanctionsHistory[x].hair | String | Cor do cabelo |
data.sanctionsHistory[x].distinguishingMarks | String | Características |
data.sanctionsHistory[x].description | String | Descrição geral da sanção |
data.sanctionsHistory[x].considerations | String | Considerações da sanção |
data.isCurrentlyPEP | Boolean | Indica se a pessoa é atualmente uma PPE |
data.isCurrentlySanctioned | Boolean | Indica se a pessoa está atualmente sob alguma sanção |
data.last30DaysSanctions | Number | Quantidade de sanções e restrições encontradas nos últimos 30 dias |
data.last90DaysSanctions | Number | Quantidade de sanções e restrições encontradas nos últimos 90 dias |
data.last180DaysSanctions | Number | Quantidade de sanções e restrições encontradas nos últimos 180 dias |
data.last365DaysSanctions | Number | Quantidade de sanções e restrições encontradas nos últimos 365 dias |
data.lastYearPEPOccurence | Number | Quantidade de registros de PEP encontradas no último ano |
data.last3YearsPEPOccurence | Number | Quantidade de registros de PEP encontradas nos últimos 3 anos |
data.last5YearsPEPOccurence | Number | Quantidade de registros de PEP encontradas nos últimos 5 anos |
data.last5PlusYearsPEPOccurence | Number | Quantidade de registros de PEP encontradas nos últimos 5 ou mais anos |
data.firstPEPOccurenceDate | String | Data do primeiro registro de PEP encontrado para o indivíduo |
data.lastPEPOccurenceDate | String | Data do último registro de PEP encontrado para o indivíduo |
data.isCurrentlyElectoralDonor | Boolean | Indica se a pessoa realiza doações para campanhas políticas |
data.isHistoricalElectoralDonor | Boolean | Indica se a pessoa já doou para campanhas políticas |
data.totalElectoralDonationsLastTwoElections | Number | Quantidade de doações realizadas nos últimos dois ciclos eleitorais |
data.totalElectoralDonations | Number | Quantidade total de doações realizadas |
data.totalElectoralDonationAmountLastTwoElections | Number | Somatório do valor doado nos últimos dois ciclos eleitorais |
data.totalElectoralDonationAmount | Number | Somatório total do valor doado |
Notícias Relacionadas (PF25)
Retorna notícias públicas relacionadas a esta pessoa na internet. Lembrando que como a pesquisa é textual leva em consideração o nome, é necessário um cuidado adicional com homônimos.
Seção: pfMediaProfileAndExposure
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
available | Boolean | Disponibilidade da fonte |
statusCode | String | Situação da consulta (detalhes) |
query | Object | Parâmetros utilizados na consulta (detalhes) |
query.data.cpf | String | CPF utilizado na consulta |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.mediaExposureLevel | String | Nível de exposição à mídia |
data.celebrityLevel | String | Nível de celebridade |
data.unpopularityLevel | String | Nível de impopularidade |
data.newsItems | Array | Lista das notícias capturadas para a entidade |
data.newsItems[x].title | String | Título da notícia |
data.newsItems[x].sourceName | String | Nome da fonte responsável pela notícia |
data.newsItems[x].url | String | URL da notícia |
data.newsItems[x].sentimentAnalysis | Object | Análise de sentimento |
data.newsItems[x].sentimentAnalysis.label | String | Rótulo (positivo, negativo) atribuído ao conteúdo em geral |
data.newsItems[x].sentimentAnalysis.peopleCount | String | Número de pessoas identificadas no conteúdo |
data.newsItems[x].sentimentAnalysis.placesCount | String | Número de lugares identificados no conteúdo |
data.newsItems[x].sentimentAnalysis.organizationsCount | String | Número de empresas identificadas no conteúdo |
data.newsItems[x].sentimentAnalysis.entities | Object | Dicionário com os nomes das entidades e os rótulos do conteúdo |
data.newsItems[x].categories | Array | Lista de categorias da notícia |
data.newsItems[x].captureDate | String | Data em que a notícia foi capturada |
data.newsItems[x].publicationDate | String | Data de publicação da notícia |
data.creationDate | String | Data de criação |
data.lastUpdateDate | String | Data da última atualização |
Protocolos processuais no CADE
Consulta ao site do CADE (Conselho Administrativo de Defesa Econômica) e verifica se o CPF consultado possui protocolos processuais vinculados.
Seção: pfProcessOnCade
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.proceduralProtocols | Array | Lista de protocolos encontrados pra o cpf consultado |
data.proceduralProtocols[x].demandOrigin | String | Origem da consulta |
data.proceduralProtocols[x].protocolNumber | String | Número de protocolo |
data.proceduralProtocols[x].source | String | Unidade Geradora |
data.proceduralProtocols[x].emissionDate | String | Data de emissão |
data.proceduralProtocols[x].documentRequested | String | Documento requisitado |
data.proceduralProtocols[x].documentRequestedUrl | String | Url para o documento requisitado |
Lista de Sanções da OFAC
Consulta na Lista Cidadãos Especialmente Designados e Pessoas Bloqueadas (SDN) do Escritório de Controle de Ativos Estrangeiros (OFAC). A consulta é feita por nome e é uma consulta de âmbito internacional.
Seção: pfOfacSanctionsList
Parâmetro obrigatório: name
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.sanctionsList | Array | Lista de protocolos encontrados pra o cpf consultado |
data.sanctionsList[x].type | String | Tipo |
data.sanctionsList[x].firstName | String | Primeiro Nome |
data.sanctionsList[x].lastName | String | Último Nome |
data.sanctionsList[x].title | String | Título |
data.sanctionsList[x].dateOfBirth | String | Data de nascimento |
data.sanctionsList[x].placeOfBirth | String | Local de nascimento |
data.sanctionsList[x].list | String | Lista a qual o nome pertence |
data.sanctionsList[x].program | String | Programa a qual o nome pertence |
data.sanctionsList[x].remarks | String | Observações |
data.sanctionsList[x].nationality | String | Nacionalidade |
data.sanctionsList[x].citizenship | String | Cidadania |
data.sanctionsList[x].identifications | Array | Lista de indentifações conhecidas do nome informado |
data.sanctionsList[x].identifications[x].type | String | Tipo de identificação |
data.sanctionsList[x].identifications[x].number | String | Numero do documento |
data.sanctionsList[x].identifications[x].country | String | País de origem do documento |
data.sanctionsList[x].identifications[x].issueDate | String | Data de emissão do documento |
data.sanctionsList[x].identifications[x].expireDate | String | Data de expiração do documento |
data.sanctionsList[x].aliases | Array | Lista de apelidos pelos quais o nome informado também pode ser identificado |
data.sanctionsList[x].aliases[x].type | String | Tipo de apelidos |
data.sanctionsList[x].aliases[x].category | String | Categoria do apelidos |
data.sanctionsList[x].aliases[x].name | String | Nome ou apelido (pode ser documento falso) |
data.sanctionsList[x].addresses | Array | Lista de endereços conhecidos do nome informado |
data.sanctionsList[x].addresses[x].address | String | Endereço |
data.sanctionsList[x].addresses[x].city | String | Cidade |
data.sanctionsList[x].addresses[x].stateOrProvince | String | Estado ou provincia |
data.sanctionsList[x].addresses[x].postalCode | String | Código postal (CEP) |
data.sanctionsList[x].addresses[x].country | String | País |
Verificação de risco para números de telefone
Fornece um indicador do risco para o telefone consultado, bem como uma recomendação quanto ao risco, além de informações que podem ajudar na tomada de decisão.
Seção: phoneTrustScore
Parâmetro obrigatório: phoneNumber
Parâmetros adicionais opcionais: deviceId, accountId, email, originatingIp, accountLifecycleEvent,
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Mensagem de retorno |
data.risk | Object | Descreve a pontuação de risco para o número de telefone informado |
data.risk.level | String | Severidade do risco |
data.risk.recommendation | String | Ação recomendada com base na pontuação de risco |
data.risk.score | Number | O score de risco para o número de telefone informado |
data.riskInsights | Object | Contém o reason code com informações adicionais sobre o risco. |
data.riskInsights.status | Number | O status de processamento do pacote de insights de risco para a solicitação |
data.riskInsights.category | Array | Categoria |
data.riskInsights.a2p | Array | Códigos específicos para mensagens de application-to-person (a2p) |
data.riskInsights.p2p | Array | Códigos específicos para mensagens de person-to-person (p2p) |
data.riskInsights.numberType | Array | Códigos relacionados ao tipo do número |
data.riskInsights.ip | Array | Códigos relacionados à atividade do endereço IP fornecido para este número |
data.riskInsights.email | Array | Códigos relacionados à atividade do endereço de e-mail fornecido para o número de telefone |
Indicador para o risco de troca do cartão SIM
Verifica se o cartão SIM para um número de telefone foi trocado e em caso afirmativo, em que ponto. É avaliada a probabilidade de que a troca do SIM tenha sido por um motivo fraudulento, usando uma escala de 1-4.
Seção: simSwapAlert
Parâmetro obrigatório: phoneNumber (com DDI e DDD)
Observações: Adicionar DDI e DDD para o número de telefone.
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo da situação da consulta |
data.swapDate | String | Se o cartão SIM para o número de telefone foi modificado, este campo indica a data em que ocorreu a alteração. |
data.swapTime | String | Se o cartão SIM para o número de telefone foi modificado, este campo indica a hora da ocorrência. |
data.riskIndicator | Number | Indicador de risco da modificação do cartão SIM para o número de telefone |
data.riskIndicatorDescription | String | Descrição do indicador de risco |
data.referenceId | String | ID de referência da consulta. |
Cadastro em redes sociais e segurança do telefone
Retorna uma análise completa do telefone, inclusive sua presença em redes sociais e outras plataformas digitais, além de importantes informações de segurança sobre este telefone.
Seção: phoneAnalysis
Parâmetro obrigatório: phoneNumber (com DDI e DDD)
Observações: Adicionar DDI e DDD para o número de telefone.
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo da situação da consulta |
data.phoneNumber | Number | Número de telefone |
data.valid | Boolean | Indica se o telefone é válido |
data.disposable | Boolean | Indica se o telefone é descartável |
data.type | String | Indica o tipo de telefone |
data.country | String | O país do telefone |
data.carrier | String | A operadora do telefone |
data.score | Number | Um score de 0 a 100 que indica se o telefone do usuário é fraudulento |
data.accountDetails | Object | Dados de redes sociais associadas ao número de telefone consultado |
data.accountDetails.facebook | Object | Dados do perfil do Facebook associado ao número de telefone |
data.accountDetails.facebook.url | String | URL da foto do usuário nesta plataforma |
data.accountDetails.facebook.name | String | Nome do perfil |
data.accountDetails.facebook.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.facebook.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.google | Object | Dados do perfil do Google associado ao número de telefone |
data.accountDetails.google.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.google.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.instagram | Object | Dados do perfil de Instagram associado ao número de telefone |
data.accountDetails.instagram.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.twitter | Object | Dados do perfil do Twitter associado ao número de telefone |
data.accountDetails.twitter.registered | Boolean | Indica se este telefone esta registrado nesta plataforma |
data.accountDetails.yahoo | Object | Dados do perfil do Yahoo associado ao número de telefone |
data.accountDetails.yahoo.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.telegram | Object | Dados do perfil de Telegram associado ao número de telefone |
data.accountDetails.telegram.lastSeen | String | Data da última atividade nesta plataforma, em UNIX, UTC |
data.accountDetails.telegram.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.telegram.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.whatsapp | Object | Dados do perfil de WhatsApp associado ao número de telefone |
data.accountDetails.whatsapp.lastSeen | String | Data da última atividade nesta plataforma, em UNIX, UTC |
data.accountDetails.whatsapp.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.whatsapp.about | String | Texto "sobre" deste perfil |
data.accountDetails.whatsapp.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.viber | Object | Dados do perfil do Viber associado ao número de telefone |
data.accountDetails.viber.name | String | Nome do perfil |
data.accountDetails.viber.lastSeen | String | Data da última atividade nesta plataforma, em UNIX, UTC |
data.accountDetails.viber.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.viber.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.kakao | Object | Dados do perfil de Kakao associado ao número de telefone |
data.accountDetails.kakao.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.ok | Object | Dados do perfil de Ok associado ao número de telefone |
data.accountDetails.ok.city | String | Cidade do usuário |
data.accountDetails.ok.age | String | Idade do usuário |
data.accountDetails.ok.dateJoined | String | Data de adesão |
data.accountDetails.ok.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.zalo | Object | Dados do perfil de Zalo associado ao número de telefone |
data.accountDetails.zalo.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.line | Object | Dados do perfil de Line associado ao número de telefone |
data.accountDetails.line.name | String | Nome do perfil |
data.accountDetails.line.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.line.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.microsoft | Object | Dados do perfil da Microsoft associado ao número de telefone |
data.accountDetails.microsoft.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.snapchat | Object | Dados do perfil de Snapchat associado ao número de telefone |
data.accountDetails.snapchat.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.skype | Object | Dados do perfil de Skype associado ao número de telefone |
data.accountDetails.skype.country | String | País de relacionamento do perfil |
data.accountDetails.skype.city | String | Cidade do usuário |
data.accountDetails.skype.gender | String | Gênero do usuário |
data.accountDetails.skype.name | String | Nome do perfil |
data.accountDetails.skype.id | String | ID do perfil |
data.accountDetails.skype.handle | String | Identificador do perfil |
data.accountDetails.skype.bio | String | Biografia do perfil |
data.accountDetails.skype.age | String | Idade do usuário |
data.accountDetails.skype.language | String | Linguagem do perfil |
data.accountDetails.skype.state | String | Estado de relacionamento do perfil |
data.accountDetails.skype.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.skype.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.appliedRules | Array | Lista de regras configuradas para o motor de scores |
data.appliedRules[x].id | String | Identificador unico da regra |
data.appliedRules[x].name | String | Nome da regra |
data.appliedRules[x].operation | String | Operação da regra |
data.appliedRules[x].score | Number | Score da regra |
data.history | Object | Historico de requisições relacionados ao telefone |
data.history.hits | Number | O número de vezes que este telefone foi buscado |
data.history.customerHits | Number | O número de clientes únicos que buscaram este telefone |
data.history.firstSeen | Number | A data em que este número foi buscado pela primeira vez, em UNIX, UTC, sem milissegundos |
data.history.lastSeen | Number | A data em que este número foi buscado pela última vez, em UNIX, UTC, sem milissegundos |
data.flags | Array | Lista de flags |
data.flags[x].note | String | Nota com informações adicionais sobre a flag |
data.flags[x].date | Number | A data em que a flag foi criada, em UNIX, UTC, sem milissegundos |
data.flags[x].industry | String | Indústria de qual empresa criou a flag |
data.id | String | Um operador único para a chamada |
data.referenceId | String | Id de identificação |
Cadastro em redes sociais e segurança do email
Retorna uma análise do email - sua presença em redes sociais e outras plataformas digitais, além de importantes informações de segurança sobre o email consultado.
Seção: emailAnalysis
Parâmetro obrigatório: email
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo da situação da consulta |
data.email | String | |
data.score | Number | Um score que indica se o email é fraudulento |
data.deliverable | Boolean | Verifica se o endereço de email realmente existe |
data.domainDetails | Object | Detalhes sobre o Domínio do endereço de email |
data.domainDetails.domain | String | Domínio do email |
data.domainDetails.tld | String | Domínio de topo |
data.domainDetails.createdAt | String | Data de criação do Domínio |
data.domainDetails.updatedAt | String | Data de atualização do Domínio |
data.domainDetails.expireDate | String | Data de expiração do Domínio |
data.domainDetails.registered | Boolean | Indica se o Domínio está registrado |
data.domainDetails.registrant | String | Nome da empresa que gerencia o Domínio do email |
data.domainDetails.registeredTo | String | Nome da empresa para o qual o Domínio está registrado |
data.domainDetails.disposable | Boolean | Indica se o Domínio é fraudulento |
data.domainDetails.free | Boolean | Indica se o Domínio é de um provedor grátis(gmail, hotmail, ect.) |
data.domainDetails.custom | Boolean | Indica se este é um Domínio customizado |
data.domainDetails.dmarcEnforced | Boolean | Indica se o Domínio é autenticado por DMARC |
data.domainDetails.spfStrict | Boolean | Indica se o Domínio é o SPF é seguro |
data.domainDetails.validMX | Boolean | Indica se os registros MX do Domínio são validos |
data.domainDetails.acceptAll | Boolean | Indica se o servidor esta configurado para recebers todos os emails neste Domínio |
data.domainDetails.suspiciousTld | Boolean | Indica se o Domínio de topo é suspeito |
data.domainDetails.websiteExists | Boolean | Indica se o Domínio de email possui um website |
data.accountDetails | Object | Dados de redes sociais associadas ao email consultado |
data.accountDetails.facebook | Object | Dados do perfil do Facebook associado ao email |
data.accountDetails.facebook.url | String | URL da foto do usuário nesta plataforma |
data.accountDetails.facebook.name | String | Nome do perfil |
data.accountDetails.facebook.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.facebook.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.google | Object | Dados do perfil do Google associado ao email |
data.accountDetails.google.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.google.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.apple | Object | Dados do perfil da Apple associado ao email |
data.accountDetails.appleregistered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.twitter | Object | Dados do perfil do Twitter associado ao email |
data.accountDetails.twitter.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.microsoft | Object | Dados do perfil da Microsoft associado ao email |
data.accountDetails.microsoft.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.yahoo | Object | Dados do perfil do Yahoo associado ao email |
data.accountDetails.yahoo.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.ebay | Object | Dados do perfil de Skype associado ao email |
data.accountDetails.ebay.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.gravatar | Object | Dados do perfil do Gravatar associado ao email |
data.accountDetails.gravatar.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.instagram | Object | Dados do perfil de Instagram associado ao email |
data.accountDetails.instagram.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.spotify | Object | Dados do perfil de Spotify associado ao email |
data.accountDetails.spotify.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.tumblr | Object | Dados do perfil de Tumblr associado ao email |
data.accountDetails.tumblr.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.linkedin | Object | Dados do perfil de LinkedIn associado ao email |
data.accountDetails.linkedin.url | String | URL do perfil |
data.accountDetails.linkedin.name | String | Nome do perfil |
data.accountDetails.linkedin.company | String | Empresa de perfil |
data.accountDetails.linkedin.title | String | Cargo/título baseado no perfil |
data.accountDetails.linkedin.location | String | Localidade do perfil |
data.accountDetails.linkedin.website | String | Site pessoal do perfil |
data.accountDetails.linkedin.twitter | String | Twitter do perfil |
data.accountDetails.linkedin.photo | String | Url da foto de perfil |
data.accountDetails.linkedin.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.weibo | Object | Dados do perfil de Weibo associado ao email |
data.accountDetails.weibo.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.github | Object | Dados do perfil de Github associado ao email |
data.accountDetails.github.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.vimeo | Object | Dados do perfil de Vimeo associado ao email |
data.accountDetails.vimeo.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.flickr | Object | Dados do perfil de Flickr associado ao email |
data.accountDetails.flickr.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.foursquare | Object | Dados do perfil de Foursquare associado ao email |
data.accountDetails.foursquare.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.lastfm | Object | Dados do perfil de LastFM associado ao email |
data.accountDetails.lastfm.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.myspace | Object | Dados do perfil de MySpace associado ao email |
data.accountDetails.myspace.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.pinterest | Object | Dados do perfil de Pinterets associado ao email |
data.accountDetails.pinterest.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.skype | Object | Dados do perfil de Skype associado ao email |
data.accountDetails.skype.country | String | País de relacionamento do perfil |
data.accountDetails.skype.city | String | Cidade do usuário |
data.accountDetails.skype.gender | String | Gênero do usuário |
data.accountDetails.skype.name | String | Nome do perfil |
data.accountDetails.skype.id | String | ID do perfil |
data.accountDetails.skype.handle | String | Identificador do perfil |
data.accountDetails.skype.bio | String | Biografia do perfil |
data.accountDetails.skype.age | String | Idade do usuário |
data.accountDetails.skype.language | String | Linguagem do perfil |
data.accountDetails.skype.state | String | Estado de relacionamento do perfil |
data.accountDetails.skype.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.skype.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.discord | Object | Dados do perfil de Discord associado ao email |
data.accountDetails.discord.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.ok | Object | Dados do perfil de Ok associado ao email |
data.accountDetails.ok.city | String | Cidade do usuário |
data.accountDetails.ok.age | String | Idade do usuário |
data.accountDetails.ok.dateJoined | String | Data de adesão |
data.accountDetails.ok.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.kakao | Object | Dados do perfil de Kakao associado ao email |
data.accountDetails.kakao.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.booking | Object | Dados do perfil de Booking associado ao email |
data.accountDetails.booking.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.airbnb | Object | Dados do perfil de Airbnb associado ao email |
data.accountDetails.airbnb.about | String | Texto "sobre" do perfil |
data.accountDetails.airbnb.createdAt | String | Data de criação do perfil |
data.accountDetails.airbnb.firstName | String | Primeiro nome do perfil |
data.accountDetails.airbnb.identityVerified | String | Status de verificação do perfil |
data.accountDetails.airbnb.location | String | Localização do perfil |
data.accountDetails.airbnb.image | String | Url da foto de perfil |
data.accountDetails.airbnb.revieweeCount | String | Contagem de reviews do perfil |
data.accountDetails.airbnb.trips | String | Contagem de viagens do perfil |
data.accountDetails.airbnb.work | String | Nome da empresa do perfil |
data.accountDetails.airbnb.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.amazon | Object | Dados do perfil de Amazon associado ao email |
data.accountDetails.amazon.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.qzone | Object | Dados do perfil de Qzone associado ao email |
data.accountDetails.qzone.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.breachDetails | Object | Detalhes sobre vazamentos de dados do qual o email foi vítima |
data.accountDetails.breachDetails.breaches | Array | Lista de vazamentos |
data.accountDetails.breachDetails.breaches[x].name | String | Nome da plataforma onde os dados do email foram vazados |
data.accountDetails.breachDetails.breaches[x].domain | String | Domínio da plataforma onde o email foi vazado |
data.accountDetails.breachDetails.breaches[x].date | String | Data do vazamento do email |
data.accountDetails.breachDetails.haveIBeenPwnedListed | Boolean | Indica se o email foi vítima de um vazamento de dados |
data.accountDetails.breachDetails.numberOfBreaches | Number | Indica se o número de vezes em que o email foi vítima de vazamento de dados |
data.accountDetails.breachDetails.firstBreach | String | Data do primeiro vazamento de dados |
data.appliedRules | Array | Lista de regras configuradas para o motor de scores |
data.appliedRules[x].id | String | Identificador unico da regra |
data.appliedRules[x].name | String | Nome da regra |
data.appliedRules[x].operation | String | Operação da regra |
data.appliedRules[x].score | Number | Score da regra |
data.history | Object | Historico de requisições relacionados ao email |
data.history.hits | Number | O número de vezes que este email foi buscado |
data.history.customerHits | Number | O número de clientes únicos que buscaram este email |
data.history.firstSeen | Number | A data em que este email foi buscado pela primeira vez, em UNIX, UTC, sem milissegundos |
data.history.lastSeen | Number | A data em que este email foi buscado pela última vez, em UNIX, UTC, sem milissegundos |
data.flags | Array | Lista de flags |
data.flags[x].note | String | Nota com informações adicionais sobre a flag |
data.flags[x].date | Number | A data em que a flag foi criada, em UNIX, UTC, sem milissegundos |
data.flags[x].industry | String | Indústria de qual empresa criou a flag |
data.id | String | Um operador único para a chamada |
data.referenceId | String | Id de identificação |
Lista privada de restrições (PF78)
Consulta a presença na lista privada de restrições.
Seção: pfDenyListPrivate
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.recordFound | Boolean | Indicativo da presença na lista privada de restrições |
data.cpf | String | CPF |
data.name | String | Nome |
Financeiro
Lista de Devedores PGFN (PF94)
Retorna se o CPF consultado está inscrito em dívidas ativas junto à PGFN.
Seção: pfPgfnDebtors
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Mensagem decritiva do resultado da consulta |
data.hasDebts | Boolean | Status de divida (true/false) |
data.debtValue | String | Valor devido a PGFN |
Protestos em Cartórios (PF18)
Quando não existe protestos de título é emitida uma certidão negativa pela IETB. Quando há protestos, são retornadas informações dos títulos protestados: quem protestou e o valor.
Seção: pfProtesto
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
query | Object | Parâmetros utilizados na consulta (detalhes) |
query.data.cpf | String | CPF utilizado na consulta |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.baseStatus | String | Status do documento consultado com relação aos protestos. Indica se existe ou não protesto para a entidade |
data.totalProtests | Number | Número total de protestos encontrados |
data.notaries | Array | Lista de protestos |
data.notaries[x].state | String | Estado do cartório onde foi registrado o protesto |
data.notaries[x].city | String | Nome do município onde foi registrado o protesto |
data.notaries[x].description | String | Descrição do cartório onde foi registrado o protesto |
data.notaries[x].address | String | Endereço de cadastro no IEPTEC onde foi registrado o protesto |
data.notaries[x].phone | String | Telefone do cartório onde foi registrado o protesto |
data.notaries[x].numProtests | Number | Número de protestos |
data.notaries[x].protests | Array | Lista de protestos |
data.notaries[x].protests[x].debtorDocument | String | Documento devedor |
data.notaries[x].protests[x].date | String | Data do protesto |
data.notaries[x].protests[x].value | String | Valor do título protestado |
Estimativa de Patrimônio e Renda (PF24)
Retorna uma estimativa de renda e patrimônio da pessoa calculadas por diferentes variáveis de consultas públicas disponíveis.
Seção: pfFinantialData
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.totalAssets | String | Estimativa do patrimônio total do indivíduo |
data.taxReturns | Array | Lista de objetos com o histórico das restituições do imposto de renda |
data.taxReturns[x].year | String | Ano da declaração de imposto |
data.taxReturns[x].status | String | Status da declaração de imposto |
data.taxReturns[x].bank | String | Banco utilizado na declaração de imposto |
data.taxReturns[x].captureDate | String | Data da captura |
data.taxReturns[x].lastUpdateDate | String | Data da última atualização |
data.incomeEstimates | Array | Renda estimada |
data.incomeEstimates[x].mte | String | Renda estimada de acordo com o MTE |
data.incomeEstimates[x].ibge | String | Renda estimada de acordo com o IBGE |
data.incomeEstimates[x].bigData | String | Renda estimada de acordo com o BigData Corp |
data.incomeEstimates[x].companyOwnership | String | Renda estimada mesmo sem histórico profissional formal |
Quadro Geral de Inabilitados - Banco Central do Brasil (PF44)
Retorna, caso conste no Quadro Geral de Inabilitados do Banco Central do Brasil, informações sobre a inabilitação.
Seção: pfBacenQgi
Parâmetros obrigatórios: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.disabledList | Array | Lista de objetos com os dados da inabilitação |
data.disabledList[x].pas | String | PAS (Processo Administrativo Sancionador) |
data.disabledList[x].name | String | Nome |
data.disabledList[x].cpf | String | CPF |
data.disabledList[x].penalty | String | Penalidade |
data.disabledList[x].publicationDate | String | Data da publicação |
data.disabledList[x].penaltyDeadline | String | Prazo final da penalidade |
CVM Associado (PF47)
Retorna informações de CPF que tenham relação com instituições financeiras
Seção: pfAssociatedCvm
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.associates | Array | Descreve os dados dos tipos de cadastro na Comissão de Valores Mobiliarios |
data.associates[x].name | String | Nome da pessoa física |
data.associates[x].type | String | Tipo de cadastro |
data.associates[x].recordDate | String | Data de registro na função |
data.associates[x].situation | String | Situação do Cadastro |
data.associates[x].directors | Array | Lista de objetos que contém dados de diretores |
data.associates[x].directors[x].name | String | Nome da empresa no qual o CPF é diretor |
data.associates[x].directors[x].startDate | String | Data de inicio no cargo como diretor |
data.associates[x].directors[x].instruction | String | Instrução do diretor na empresa |
Renda Ibope (PF50)
Retorna informação sobre a renda house hold / renda ibope de uma pessoa
Seção: pfIbopeIncome
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.ibopeIncome | Float | Valor da renda ibope |
Renda Estimada (PF51)
Retorna a informação de estimativa de renda de uma pessoa
Seção: pfEstimatedIncome
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.estimatedIncome | Float | Valor da renda estimada |
SPC Restrições + Score (PF99)
Retorna uma coleção de dados sobre a empresa, entre eles: Score, Consultas ao CPF, etc
Seção: pfSpcRestrictionsScore
Parâmetros obrigatórios: cpf, PF
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.restriction | Boolean | Indica se a pessoa possui ou não alguma restrição |
data.customer | Object | Dados do consumidor consultado |
data.customer.birthday | String | Data de nascimento |
data.customer.email | String | |
data.customer.age | String | Idade |
data.customer.name | String | Nome |
data.customer.mothersName | String | Nome da mãe |
data.customer.idNumber | String | Numero do RG |
data.customer.voterTitle | String | Título de Eleitor |
data.customer.sex | String | Sexo |
data.customer.sign | String | Signo |
data.customer.cpf | Object | Dados de CPF |
data.customer.cpf.originRegion | String | Região/Origem do CPF |
data.customer.cpf.number | String | Número do CPF |
data.customer.statusCpf | Object | Dados de condição do CPF |
data.customer.statusCpf.statusDescription | String | Descrição |
data.customer.statusCpf.statusDate | String | Data |
data.customer.address | Object | Endereço |
data.customer.address.state | String | Estado |
data.customer.address.city | String | Cidade |
data.customer.address.street | String | Rua |
data.customer.address.number | String | Número |
data.customer.address.complement | String | Complemento |
data.customer.address.district | String | Bairro |
data.customer.address.zipCode | String | CEP |
data.customer.cellphone | Object | Informações de contato |
data.customer.cellphone.areaCode | String | Codigo de Area (DDD) |
data.customer.cellphone.number | String | Numero |
data.spc | Object | Registros de inadimplência - SPC |
data.spc.total | Integer | Quantidade de registros |
data.spc.dateLastOccurency | String | Data da última ocorrência |
data.spc.value | Float | Valor total acumulado |
data.spc.details | Array | Detalhes dos registros |
data.spc.details[x].associateName | String | Nome do associado responsável pela inclusão do registro |
data.spc.details[x].entityName | String | Nome da entidade |
data.spc.details[x].inclusionDate | String | Data de inclusão do registro |
data.spc.details[x].expirationDate | String | Data de vencimento do registro |
data.spc.details[x].contract | String | Contrato |
data.spc.details[x].financialInstitutionRegistration | String | Registro em instituição financeira |
data.spc.details[x].type | String | O consumidor é o responsável pela compra (comprador) ou fiador/avalista de terceiro |
data.spc.details[x].value | Float | Valor do débito |
data.spc.details[x].city | String | Cidade |
data.spc.details[x].state | String | Estado |
data.spc.details[x].phoneAreaCode | String | DDD do telefone |
data.spc.details[x].phoneNumber | String | Número do telefone |
data.lastAddressInformed | Object | Ultimo endereço Informado |
data.lastAddressInformed.details | Array | Lista com ultimos endereços informados |
data.lastAddressInformed.details[x].state | String | Estado |
data.lastAddressInformed.details[x].city | String | Cidade |
data.lastAddressInformed.details[x].street | String | Logradouro |
data.lastAddressInformed.details[x].number | String | Numero |
data.lastAddressInformed.details[x].district | String | Bairro |
data.lastAddressInformed.details[x].complement | String | Complemento |
data.lastAddressInformed.details[x].zipCode | String | CEP |
data.ccf | Object | Registros de cheques sem fundo |
data.ccf.total | Integer | Quantidade de registros |
data.ccf.details | Object | Detalhes dos registros |
data.ccf.details.origin | String | Origem da informação |
data.ccf.details.reasonCode | String | Motivo - Código |
data.ccf.details.reasonDescription | String | Motivo - Descrição |
data.ccf.details.lastCheck | Object | Detalhes do último cheque |
data.ccf.details.lastCheck.date | String | Data do último cheque |
data.ccf.details.lastCheck.name | String | Nome do banco |
data.ccf.details.lastCheck.agencyNumber | String | Número da agência |
data.ccf.details.lastCheck.code | String | Código |
data.countermand | Object | Registros de contra-ordem para os cheques consultados |
data.countermand.total | Integer | Quantidade de registros |
data.countermandDifferentDocument | Object | Registros de cheque/talão sustado com documento diferente do consultado |
data.countermandDifferentDocument.total | Integer | Quantidade total de registros |
data.consultedTelephone | Object | Registros de telefones consultados consultados |
data.consultedTelephone.total | Integer | Quantidade total de registros |
data.bindTelephoneSubscriberConsulted | Object | Registros telefones consultados associados ao inscrito consultados |
data.bindTelephoneSubscriberConsulted.total | Integer | Quantidade total de registros |
data.documentAlert | Object | Registros de alertas de documento consultados |
data.documentAlert.total | Integer | Quantidade total de registros |
data.shopkeeperCheck | Object | Registros de cheque de lojista consultados |
data.shopkeeperCheck.total | Integer | Quantidade total de registros |
data.contumacy | Object | Informações de contumacia |
data.contumacy.total | Integer | Quantidade total de registros |
data.contumacy.firstDayConsultedByBracket | String | Data inicial do período de consulta |
data.contumacy.lastDayConsultedByBracket | String | Data finalo do período de consulta |
data.contumacy.lastOccurenceDate | String | Data da última ocorrência |
data.contumacy.details | Array | Detalhes dos cheques |
data.contumacy.details[x].inclusionDate | String | Data da ocorrência |
data.contumacy.details[x].occurenceDate | String | Data da ocorrência |
data.contumacy.details[x].origin | String | Origem da ocorrência |
data.contumacy.details[x].reasonCode | String | Motivo da ocorrência |
data.contumacy.details[x].reasonDescription | String | Motivo da ocorrência |
data.contumacy.details[x].initialCheckNumber | String | Número do cheque incial |
data.contumacy.details[x].initialCheckBankAgencyNumber | String | Número da agência |
data.contumacy.details[x].initialCheckBankAccountNumber | String | Número da conta corrente |
data.contumacy.details[x].initialCheckBankName | String | Nome do banco |
data.contumacy.details[x].initialCheckBankCode | String | Codigo do banco |
data.contumacy.details[x].finalCheckNumber | String | Número do cheque final |
data.grantedCredit | Object | Registros de crédito concedido consultados |
data.grantedCredit.total | Integer | Quantidade total de registros |
data.queriesPerformed | Object | Informações de consultas realizadas anteriormente para o documento |
data.queriesPerformed.total | Integer | Total consultas realizadas |
data.queriesPerformed.details | Array | Detalhes das consultas realizadas |
data.queriesPerformed.details[x].associateName | String | Nome do associado que efetuou a consulta |
data.queriesPerformed.details[x].consultDate | String | Data de execução da consulta |
data.queriesPerformed.details[x].entityOriginName | String | Detalhes das consultas realizadas |
data.queriesPerformed.details[x].city | String | Cidade de origem do associado que efetuou a consulta |
data.queriesPerformed.details[x].state | String | Estado de origem do associado que efetuou a consulta |
data.judiciaryInformation | Object | Informações do poder judiciário |
data.judiciaryInformation.total | Integer | Quantidade de informações encontradas |
data.judiciaryInformation.lastOccurenceDate | String | Data da última ocorrência |
data.judiciaryInformation.value | Float | Valor total |
data.judiciaryInformation.details | Array | Detalhes das informações do poder judiciário |
data.judiciaryInformation.details[x].documentDate | String | Data do documento |
data.judiciaryInformation.details[x].inclusionDate | String | Data de inclusão do registro |
data.judiciaryInformation.details[x].originEntity | String | Origem da entidade |
data.judiciaryInformation.details[x].lawsuitNumber | String | Número do processo |
data.judiciaryInformation.details[x].value | Float | Valor total |
data.judiciaryInformation.details[x].court | String | Área judicial onde tramita a ação |
data.judiciaryInformation.details[x].courtRegion | String | Comarca onde tramita a ação |
data.judiciaryInformation.details[x].courtState | String | Estado onde tramita a ação |
data.onlineCheckQuerySrs | Object | Informações de cheques sustados, extraviados, roubados e cancelados contumaz |
data.onlineCheckQuerySrs.total | Integer | Total de cheques |
data.spcScore3Months | Object | Informações sobre o Score do SPC |
data.spcScore3Months.class | String | Classe do Score |
data.spcScore3Months.scoreMessage | String | Mensagem de escolha da entidade ou associado conforme a faixa de risco |
data.spcScore3Months.score | String | Score do SPC |
data.spcScore3Months.probability | String | Probabilidade de inadimplência |
data.spcScore3Months.scope | String | Horizonte de cálculo (meses) |
data.spcScore3Months.clientScoreType | String | Tipo de cliente (NOVO - novo no SPC Brasil; RESTRITO: possui restrições; NAO_RESTRITO: não possui restrições) |
data.spcScore12Months | Object | Informações sobre o Score do SPC |
data.spcScore12Months.class | String | Classe do Score |
data.spcScore12Months.scoreMessage | String | Mensagem de escolha da entidade ou associado conforme a faixa de risco |
data.spcScore12Months.score | String | Score do SPC |
data.spcScore12Months.probability | String | Probabilidade de inadimplência |
data.spcScore12Months.scope | String | Horizonte de cálculo (meses) |
data.spcScore12Months.clientScoreType | String | Tipo de cliente (NOVO - novo no SPC Brasil; RESTRITO: possui restrições; NAO_RESTRITO: não possui restrições) |
Sistema de Informações de Créditos (PF96)
Retorna as informações de crédito de uma pessoa.
Seção: pfCreditOperationSCR
Parâmetros obrigatórios: cpf, PF
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.clientCode | String | CPF |
data.registrationDate | Date | Data de registro |
data.baseDate | Date | Data base para consulta |
data.assumedCoobligation | Number | Coobrigação assumida em cessão de crédito pelo cliente |
data.receivedCoobligation | Number | Coobrigação recebida em cessão de crédito |
data.processedDocumentsPercentage | Number | Percentual dos documentos 3040 esperados para a data-base e que já foram incorporados a base de dados do SCR no Banco Central, desconsiderando as instituições financeiras dispensadas |
data.processedVolumePercentage | Number | Percentual do volume esperado para a data-base e que já está incorporado a base de dados do SCR no Banco Central, desconsiderando as instituições financeiras dispensadas |
data.totalOfInstituions | String | Quantidade de instituiçõs financeiras (IFs) nas quais o cliente possui operações |
data.totalOfTransactions | String | Quantidade de operações do cliente no SFN |
data.totalDisagreementTransactions | String | Quantidade de operações marcadas com manifestação de discordância |
data.totalSubJudiceTransactions | String | Quantidade de operações marcadas com sub judice |
data.fullLiabilityDisagreement | String | Responsabilidade total de operações marcadas com manifestação de discordância |
data.fullLiabilitySubJudice | String | Responsabilidade total de operações sub judice |
data.indirectVendorRisk | String | Risco indireto assumido pelo cliente em operações de vendor |
data.operationSumaryList | Array | Lista que contém resumo de operações |
data.operationSumaryList[x].modalityCategoryCode | String | Codigo de modalidade da operação |
data.operationSumaryList[x].modalityCategoryDescription | String | Descrição do código de modalidade da operação |
data.operationSumaryList[x].modalitySubCategoryCode | String | Código de subcategoria |
data.operationSumaryList[x].modalitySubCategoryDescription | String | Descrição do código de subcategoria |
data.operationSumaryList[x].listOfDebts | Array | Lista de vencimentos |
data.operationSumaryList[x].listOfDebts[x].expirationCode | String | Código de vencimento |
data.operationSumaryList[x].listOfDebts[x].expirationDescription | String | Descrição do código de vecimento |
data.operationSumaryList[x].listOfDebts[x].value | String | Valor do vencimento |
Penalidades Temporarias na CVM (PF93)
Consulta na lista de Penalidades Temporárias da CVM se o participante está temporariamente impedido de atuar no mercado de capitais em razão de decisão em Processo Administrativo Sancionador
Seção: pfPenaltiesOnCvm
Parâmetros obrigatórios: name
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.listOfSetences | Array | Lista de membros setenciados/punidos |
data.listOfSetences[x].processNumber | String | Número do Processo |
data.listOfSetences[x].name | String | Participante |
data.listOfSetences[x].decisionType | String | Tipo de Decisão |
data.listOfSetences[x].judgementDate | String | Data do Julgamento CVM |
data.listOfSetences[x].effectiveDate | String | Data de vigência da penalidade |
data.listOfSetences[x].timeOfWithdrawal | String | Tempo de afastamento |
Trabalhista
Histórico Profissional (PF10)
Retorna uma lista com as empresas que a pessoa provavelmente trabalha ou já trabalhou e o período de cada experiência profissional.
Seção: pfOccupationData
Parâmetro obrigatório: cpf
Os dados dos atributos abaixo são retornados em um Array de objetos
Atributo | Tipo | Descrição | |
---|---|---|---|
statusCode | String | Situação da consulta (detalhes) | |
query | Object | Parâmetros utilizados na consulta (detalhes) | |
query.data.cpf | String | CPF utilizado na consulta | |
data | Object | Dados de retorno | |
data.professions | Array | Lista de objetos com os detalhes de cada trabalho encontrado | |
data.professions[x].sector | String | Setor da companhia | |
data.professions[x].country | String | País em que a profissão é exercida | |
data.professions[x].companyIdNumber | String | Número de identificação da companhia (cnpj) | |
data.professions[x].companyName | String | Nome da companhia (razão social) | |
data.professions[x].area | String | Área de atuação da companhia | |
data.professions[x].level | String | Cargo ou posição (quando disponível) | |
data.professions[x].status | String | Situação empregatícia (ACTIVE | INACTIVE) |
data.professions[x].incomeRange | String | Faixa salarial | |
data.professions[x].income | Number | Renda estimada proporcionada por esse trabalho | |
data.professions[x].startDate | Date | Data de início ou admissão no trabalho | |
data.professions[x].endDate | Date | Data de término ou desligamento do trabalho | |
data.professions[x].creationDate | Date | Data de criação | |
data.professions[x].lastUpdateDate | Date | Data da última atualização | |
data.totalProfessions | Number | Número total de profissões exercidas | |
data.totalIncome | Number | Total de renda | |
data.isEmployed | Boolean | Indica se a pessoa está empregada ou não |
Relacionamentos Econômicos(PF36)
Retorna a lista de entidades relacionadas com o indivíduo consultado em um escopo econômico, que inclui tipos de relacionamento como a participação societária em empresas, e relacionamentos de emprego (para os quais os detalhes podem ser vistos no dataset de Dados Profissionais, dentre outros).
Seção: pfBusinessRelationships
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
query | Object | Parâmetros utilizados na consulta (detalhes) |
query.data.cpf | String | CPF utilizado na consulta |
query.data.birthDate | String | Data de nascimento utilizada na consulta |
data | Object | Dados de retorno |
data.businessRelationships | Array | Array de objetos com relacionamentos econômicos |
data.businessRelationships[x].relatedEntityTaxIdNumber | String | Número da relação de Entidade |
data.businessRelationships[x].relatedEntityTaxIdType | String | Tipo de relação de Entidade |
data.businessRelationships[x].relatedEntityTaxIdCountry | String | País |
data.businessRelationships[x].relatedEntityName | String | Nome |
data.businessRelationships[x].relationshipType | String | Tipo de relação |
data.businessRelationships[x].relationshipLevel | String | Nível de relação |
data.businessRelationships[x].relationshipStartDate | String | Data de incio da Relação |
data.businessRelationships[x].relationshipEndDate | String | Término da relação |
data.businessRelationships[x].creationDate | String | Data da criação |
data.businessRelationships[x].lastUpdateDate | String | Última atualização |
data.totalRelationships | String | Total de relações |
data.totalOwnerships | String | Custo total da posse |
data.totalEmployments | String | Total de empregos |
data.totalPartnes | String | Total de Assosciações |
data.totalClients | String | Total de Clientes |
data.totalSuppliers | String | Total de Fornecedores |
Assistência Social do Governo (PF16)
Retorna se a pessoa faz parte do Bolsa Família ou algum outro benefício do governo. Juntamente com o valor destes benefícios.
Seção: pfSocialAssistance
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.socialAssistances | Array | Lista de programas de assistência social |
data.socialAssistances[x].programName | String | Nome do programa |
data.socialAssistances[x].programState | String | Estado em que o programa é aplicado |
data.socialAssistances[x].assistanceAmount | String | Quantia recebida pelo programa de assistência |
data.totalAssistances | String | Total de assistências que a pessoa já recebeu |
data.isReceivingAssistance | Boolean | Indica se a pessoa está atualmente recebendo alguma assistência |
Conselhos de Classe (PF37)
Retorna se está pessoa está associada a algum conselho de classe como: OAB, CREA, CRA, ...
Seção: pfClassOrganization
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.organizationName | String | Nome da organização |
data.organizationCountry | String | País da organização |
data.organizationType | String | Tipo da organização |
data.organizationChapter | String | Estado onde a organização atua |
data.registrationId | String | Id de registro |
data.category | String | Categoria |
data.status | String | Status |
data.membershipStartDate | String | Data em que a pessoa se associou |
data.membershipEndDate | String | Data de término da associação |
data.creationDate | String | Data de criação |
Débitos Trabalhistas (PF98)
Retorna resultado da emissão de certidão negativa de débitos trabalhistas para um dado CPF
Seção: pfLaborDebts
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Mensagem de retorno |
data.status | String | Status (CONSTA/ NADA CONSTA) |
data.certificateNumber | String | Número da certidão |
data.certificateValidity | String | Validade da certidão |
Onboarding
Liveness de Documentos
Verifica se o documento enviado é fotocópia em preto e branco.
Seção: documentLiveness
Parâmetro obrigatório: bucket, images: { selectedFront, selectedBack } ou images: { front, back }
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Mensagem de retorno |
data.tenantId | String | tenantId |
data.executionId | String | executionId |
data.front | Object | Objeto contendo a descrição de resultado da imagem (frente) |
data.front.isPhotocopy | String | Se a imagem é fotocópia |
data.front.saturation | Number | Valor de saturação da imagem |
data.back | Object | Objeto contendo a descrição de resultado da imagem (verso) |
data.back.isPhotocopy | String | Se a imagem é fotocópia |
data.back.saturation | String | Valor de saturação da imagem |