Voltar para Pessoa Física
Relatório Avançado PF
Relatório Avançado Top Score PF + Feature Opcional O nome do relatório e os nomes das features opcionais nas imagens são para as explicações deste manual. Utilize as seguintes informações para realizar as chamadas corretamente: Relatório: Nome Descrição RELATORIO_AVANCADO_TOP_SCORE_PF Dados Cadastrais, Consultas à Serasa, Score Positivo, Participação Societária,Documentos Roubados e Dados Negativos.
Produto
RELATORIO_AVANCADO_TOP_SCORE_PF
Endpoint
POST /client/person-information
Tipo
Pessoa Física
Formato
JSON
Guia de Implementação
Documentação completa, exemplos e informações complementares
RETORNO DO RELATÓRIO
Possíveis campos de retorno para dados de anotações negativas (Pendência Financeira, Restrição Financeira, Dívida Vencida, Cheque sem Fundo, Protestos, Ações Judiciais e Participações em Falência):
Dados Cadastrais
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| registration | ||
| documentNumber | string | Número do documento da pessoa física |
| alternativeDocumentNumber | string | Número do documento alternativo da pessoa física |
| alternativeDocumentCode | string | Código para identificar o tipo de documento |
| alternativeDocumentDescription | string | Descrição do documento alternativo |
| alternativeDocumentDate | string($date) | Data da emissão do documento |
| issuingAgency | string | Órgão emissor do documento |
| issuingAgencyState | string | Estado onde o documento foi emitido |
| consumerName | string | Nome da pessoa física |
| motherName | string | Nome da mãe |
| consumerGender | string | Sexo da pessoa física |
| maritalStatus | string | Código do estado civil da pessoa física |
| maritalStatusDescription | string Descrição do estado civil da pessoa física | |
| birthSquareCity | string | Cidade de nascimento da pessoa física |
| birthSquareState | string | Estado de nascimento da pessoa física |
| birthDate | string($date) | Data de nascimento do documento consultado |
| profession | string | Profissão da pessoa física |
| professionCode | string | Código da profissão da pessoa física |
| occupation | string | Ocupação da pessoa física |
| occupationCode | string | Código da ocupação da pessoa física |
| jobDescription | string | Descritivo do emprego da pessoa física |
| educationLevelCode | string | Código da escolaridade da pessoa física |
| educationLevelDescription | string | Descrição da escolaridade da pessoa física |
| dependentsNumber | string | Número de dependentes da pessoa física |
| statusRegistration | string | Situação da pessoa física |
| statusDate | string($date) | Data da situação do documento da pessoa física |
| address | ||
| addressLine | string | Rua da residência da pessoa física |
| district | string | Distrito da residência da pessoa física |
| zipCode | Número do CEP da pessoa física | |
| country | string | País da residência da pessoa física |
| city | string | Cidade da residência da pessoa física |
| state | string | Estado da residência da pessoa física |
| addresses | ||
| addressLine | string | Logradouro da residência |
| addressTypeCode | string | Código do tipo de endereço |
| addressTypeDescription | string | Descrição do tipo de endereço |
| addressNumber | string | Número do endereço |
| discrict | string | Bairro |
| zipCode | string | CEP |
| country | string | País |
| city | string | Cidade |
| state | string | Estado |
| addressComplement | string | Complemento do endereço |
| updateDate | string($date) | Data de modificação |
| phones | ||
| regionCode | string | Código nacional(55) |
| areaCode | string | DDD da cidade |
| phoneNumber | string | Número do telefone |
| phoneType | string | Tipo do telefone |
| phoneTypeCode | string | Código do tipo de telefone |
Anotações Negativas - Pendências Financeiras Avançado PF (PEFIN)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| spefinResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| legalNatureId | string | Identificador da natureza da dívida |
| legalNature | string | Natureza da dívida |
| contractId | string | Identificador do contrato |
| creditorName | string | Nome do credor |
| amount | number($double) | Valor da dívida |
| federalUnit | string | Estado |
| legalSquare | string | Código da cidade (praça) |
| principal | boolean | Principal (true) ou Avalista (false) |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de pendências financeiras |
| balance | number($double) Valor total de pendências financeiras |
Anotações Negativas - Restrições Financeiras Avançado PF (REFIN)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| refinResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| legalNatureId | string | Identificador da natureza da dívida |
| legalNature | string | Natureza da dívida |
| contractId | string | Identificador do contrato |
| creditorName | string | Nome do credor |
| amount | number($double) | Valor da dívida |
| federalUnit | string | Estado |
| legalSquare | string | Código da cidade (praça) |
| principal | boolean | Principal (true) ou Avalista (false) |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de restrições financeiras |
| balance | number($double) | Valor total de restrições financeiras |
Anotações Negativas – Protestos
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| notaryResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| amount | number($double) | Valor da dívida |
| officeNumber | string | Número do cartório |
| city | string | Cidade |
| federalUnit | string | Estado |
| legalSquare | string | Código da cidade (praça) |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de protestos |
| balance | number($double) | Valor total dos protestos |
Anotações Negativas – Cheques Sem Fundo (CCF)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| checkResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| alinea | integer($int32) | Identificador do motivo da devolução do cheque |
| bankId | integer($int32) | Identificador do banco |
| bankName | string | Nome do banco |
| bankAgencyId | integer($int32) | Número da agência |
| checkNumber | string | Número do cheque |
| checkCount | integer($int32) | Quantidade de cheques |
| city | string | Cidade |
| federalUnit | string | Estado |
| legalSquare | string | Código da cidade (praça) |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de cheques sem fundo |
| balance | number($double) | Valor total de cheques sem fundo |
Anotações Negativas – Dívidas Vencidas
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| collectionRecordsResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| legalNatureId | string | Identificador da natureza da dívida |
| legalNature | string | Natureza da dívida |
| contractId | string | Identificador do contrato |
| creditorName | string | Nome do credor |
| amount | number($double) | Valor da dívida |
| city | string | Cidade |
| federalUnit | string | Estado |
| legalSquare | string | Código da cidade (praça) |
| principal | boolean | Principal (true) ou Avalista (false) |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de dívidas vencidas |
| balance | number($double) | Valor total de dívidas vencidas |
Anotações Negativas – Participação em Falência
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| bankruptsResponse | ||
| **occurrenceDate | string($date) | Data da participação da falência** |
| companyDocumentId | string | CNPJ da empresa em falência |
| companyName | string | Razão social da empresa em falência |
| companyLegalNatureID | string | Tipo de falência |
| companyLegalNature | string | Descrição do tipo de falência |
| legalSquare | string | Código da cidade (praça) |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de falências |
| balance | number($double) | Valor total das falências |
Anotações Negativas – Ações Judiciais
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| judgementFilingsResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| legalNatureId | string | Identificador da natureza da dívida |
| legalNature | string | Natureza da dívida |
| amount | number($double) | Valor da dívida |
| distributor | string | Número do distribuidor |
| civilCourt | string | Identificador da vara judicial |
| city | string | Cidade |
| state | string | Estado |
| legalSquare | string | Código da cidade (praça) |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de ações judiciais |
| balance | number($double) | Valor total das ações judiciais |
Participação Societária
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| partnershipResponse | ||
| businessDocument | string | Documento da empresa participada |
| companyName | string | Razão social da empresa participada |
| participationInitialDate | string($date) | Data inicial da participação |
| participationPercentage | number($double) | Percentual de participação |
| companyStatus | string | Situação da empresa participada |
| companyStatusCode | string | Código da situação da empresa participada |
| companyState | string | Estado da empresa participada |
| companyStatusDate | string($date) | Data da situação da empresa participada |
| updateDate | string($date) | Data de atualização da empresa participada |
| summary | ||
| count | number($int32) | Quantidade de empresas participadas |
| balance | number($double) | “Não se aplica” |
Consultas à Serasa
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| Inquiry>inquiryResponse | ||
| occurrenceDate | sring($date) | Data da ocorrência |
| segmentDescription | string | Segmento da empresa |
| daysQuantity | integer | Quantidade de dias da última consulta |
**<p style="color:Red"**>summary
| string | Situação da empresa participada |
| count | integer | Quantidade total de itens |
| inquirySummary > inquiryQuantity | ||
| actual | integer | Quantidade de consultas no mês atual por produtos Serasa Experian |
| checkActual | integer | Quantidade de consultas no mês atual por produtos Serasa Experian referentes a cheques |
| creditInquiriesQuantity | ||
| inquiryDate | string | AAAA-MM da consulta |
| occurrences | integer | Quantidade de ocorrências do período |
| checkInquiriesQuantity | ||
| inquiryDate | string | AAAA-MM da consulta |
| occurrences | integer | Quantidade de ocorrências do período referente a cheques |
| summary | ||
| count | integer | Quantidade total de itens |
| creditCount | integer | Quantidade total de consultas por produtos Serasa Experian |
| checkCount | integer | Quantidade total de consultas por produtos Serasa Experian referentes a cheques |
Documentos Roubados
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| stolenDocuments | ||
| occurrenceDate | String(date) | Data da ocorrência |
| documentType | String | Pessoa física ou jurídica |
| documentNumber | String | Número do documento |
| detailedReason | String | Razão detalhada |
| phone | ||
| regionCode | Integer | Código da região (DDD) |
| areaCode | Integer | Código de área (do país) |
| phoneNumber | Integer | Telefone |
| summary | ||
| count | Integer | Quantidade total dos itens |
Cheques Sustados (Contumácia)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| checkFilingsHistorical | ||
| bankNumber | Integer | Número do banco |
| bankName | String | Nome do banco |
| agencyNumber | Integer | Agência |
| accountNumberCheck | Integer | Número da conta |
| initialCheckNumber | Integer | Número do cheque inicial |
| finalCheckNumber | Integer | Número do cheque inicial |
| holderNameAccount | string | Nome do titular da conta |
| checkAmount | number($double) | Valor do cheque |
| agencySquareCode | string | Praça da agência bancaria |
| agencyZipCode | Integer | CEP da agência bancária |
| briefDescriptionReason | string | Descrição do recheque |
| dateTimeInclusion | string | Data e hora da inclusão |
| quantityCheck | Integer | Quantidade de recheque |
| messageDescription | string | Mensagem descritiva |
RETORNO DAS FEATURES OPCIONAIS
Score Positivo
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| score | ||
| score | integer | Pontuação do score |
| scoreModel | string | Modelo do score |
| range | string | Faixa do score |
| defaultRate | string | Probabilidade de Inadimplência |
| codeMessage | integer | Código da mensagem de score |
| message | string | Mensagem do score |
Score Customizado
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scores> scoreResponse | ||
| score | integer | Pontuação do score |
| scoreModel | string | Modelo do score |
| range | string | Faixa do score |
| defaultRate | string | Probabilidade de Inadimplência |
| codeMessage | integer | Código da mensagem de score |
| message | string | Mensagem do score |
Renda Estimada
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| attributes > attributesResponse | ||
| scoring | integer | Pontuação do score |
| attributeModel | string | Modelo do score |
| codeMessage | integer | Código da mensagem |
| message | string | Mensagem informativa |
Observação:
Também é possível adicionar features adicionais na consulta do relatório. Basta selecionar o campo <**optionalFeatures**> e adicionar o nome da feature em <**value**> na aba <**Params**>:
Ao realizar a consulta no relatório, as informações de features adicionais são exibidas no bloco <**optionalFeatures**>:
Anotações e Consultas SPC
| Anotações SPC |
|---|
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| negativeData > spcNegative > spcNegativeResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| contractId | string | Identificador do contrato |
| creditorName | string | Nome do credor da anotação |
| creditorCity | string | Cidade do credor da anotação |
| creditorFederalUnit | string | Estado do credor da anotação |
| amount | number($double) | Valor da dívida |
| city | string | Cidade |
| federalUnit | string | Estado |
| summary | ||
| count | integer($int32) | Quantidade total das anotações |
| balance | number($double) | Valor total das anotações |
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| Consultas SPC |
|---|
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| spcInquires > spcInquiresResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| segmentDescription | string | Segmento da empresa |
| summary | string | |
| count | integer | Quantidade total de itens |
| spcInquirySummary > spcInquiryQuantity | ||
| actual | Integer | Quantidade de consulta do mês atual |
| creditInquiriesQuantity | ||
| inquiryDate | string($date) | Data dos últimos 6 meses |
| occurrences | integer | Quantidade de consulta dos últimos 6 meses |
Score Positivo
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| score | ||
| score | integer | Pontuação do score |
| scoreModel | string | Modelo do score |
| range | string | Faixa do score |
| defaultRate | string | Probabilidade de Inadimplência |
| codeMessage | integer | Código da mensagem de score |
| message | string | Mensagem do score |
Score Customizado
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scores> scoreResponse | ||
| score | integer | Pontuação do score |
| scoreModel | string | Modelo do score |
| range | string | Faixa do score |
| defaultRate | string | Probabilidade de Inadimplência |
| codeMessage | integer | Código da mensagem de score |
| message | string | Mensagem do score |
Comprometimento de Renda (HCOR)
Possíveis campos de retorno para o score Comprometimento de Renda, modelo HCOR.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scores> attributes > incomeCommitment | ||
| scoring | integer | Pontuação do score |
| attributeModel | string | Modelo do score |
| codeMessage | integer | Código da mensagem |
| message | string | Mensagem informativa |
Capacidade de Pagamento (HCPA)
Possíveis campos de retorno para o score Capacidade de Pagamento, modelo HCPA.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| cattributes > affordability | ||
| scoring | integer | Pontuação do score |
| attributeModel | string | Modelo do score |
| codeMessage | integer | Código da mensagem |
| message | string | Mensagem informativa |
Histórico de Pagamento
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| paymentshistory>paymentsHistoryResponse | ||
| initialDayRange | Integer | Inicio do intervalo de atraso de pagamento |
| finalDayRange | Integer | Final do intervalo de atraso de pagamento |
| range | String | Pontuação atribuída ao histórico |
| score | String | Faixa de valor calculada com base no histórico de pagamento |
Achei Recheque Possíveis campos de retorno para informações de Achei Recheque, requisitadas por documento, banco ou CMC7.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| checkFilings > checkFilingsResponse | ||
| bankNumber | integer | Número do banco |
| bankName | string | Nome do banco |
| agencyNumber | integer | Agência |
| accountNumberCheck | integer | Número da conta |
| initialCheckNumber | integer | Número do cheque inicial |
| finalCheckNumber | integer | Número do cheque final |
| holderNameAccount | string | Nome do titular da conta |
| checkAmount | number($double) | Valor do cheque |
| agencySquareCode | string | Praça da agência bancaria |
| agencyZipCode | integer | CEP da agência bancaria |
| briefDescriptionReason | string | Descrição do recheque |
| dateTimeInclusion | string($datetime) | Data e hora da inclusão |
| messageDescription | string | Mensagem descritiva |
| checkFilingsHistorical > checkFilingsHistoricalResponse | ||
| bankNumber | integer | Número do banco |
| bankName | string | Nome do banco |
| agencyNumber | integer | Agência |
| accountNumberCheck | integer | Número da conta |
| initialCheckNumber | integer | Número do cheque inicial |
| finalCheckNumber | integer | Número do cheque final |
| holderNameAccount | string | Nome do titular da conta |
| checkAmount | number($double) | Valor do cheque |
| agencySquareCode | string | Praça da agência bancaria |
| agencyZipCode | integer | CEP da agência bancaria |
| briefDescriptionReason | string | Descrição do recheque |
| briefDescriptionReason | string | Descrição do recheque |
| dateTimeInclusion | string($datetime) | Data e hora da inclusão |
| quantityCheck | Integer | Quantiade de recheque |
| messageDescription | string | Mensagem descritiva |
Pontualidade de Pagamento (HIPP)
Possíveis campos de retorno para o score Pontualidade de Pagamento, modelo HIPP.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| attributes > onTimePaymentsIndex | ||
| scoring | integer | Pontuação do score |
| attributeModel | string | Modelo do score |
| codeMessage | integer | Código da mensagem |
| message | string | Mensagem informativa |
Possíveis campos de retorno para dados de Mais Anotações (Pendência Financeira, Restrição Financeira, Dívida Vencida, Cheque sem Fundo, Protesto Nacional, Ações e Participação em Falências):
Mais Anotações - Pendências Financeiras (PEFIN)
| Mais Anotações (Pendência Financeira - PEFIN) |
|---|
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| pefinResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| legalNature | string | Natureza da dívida |
| contractId | string | Identificador do contrato |
| creditorName | string | Nome do credor |
| amount | number($double) | Valor da dívida |
| legalSquare | string | Praça da ocorrência |
| principal | boolean | Principal (true) ou Avalista (false) |
| flagSubJudice | boolean | Indica se é Subjudice |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de pendências financeiras |
| balance | number($double) | Valor total de pendências financeiras |
Mais Anotações – Restrições Financeiras (REFIN)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| refinResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| legalNatureId | string | Identificador da natureza da dívida |
| legalNature | string | Natureza da dívida |
| contractId | string | Identificador do contrato |
| creditorName | string | Nome do credor |
| amount | number($double) | Valor da dívida |
| legalSquare | string | Praça da ocorrência |
| principal | boolean | Principal (true) ou Avalista (false) |
| flagSubJudice | boolean | Indica se é Subjudice |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de restrições financeiras |
| balance | number($double) | Valor total de restrições financeiras |
Mais Anotações – Dívidas Vencidas (Convem)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| collectionRecordsResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| legalNature | string | Natureza da dívida |
| contractId | string | Identificador do contrato |
| creditorName | string | Nome do credor |
| amount | number($double) | Valor da dívida |
| principal | boolean | Principal (true) ou Avalista (false) |
| flagSubjudice | boolean | Indica se é Subjudice |
| legalSquare | string | Praça da ocorrência |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de dívidas vencidas |
| balance | number($double) | Valor total de dívidas vencidas |
Mais Anotações - Cheques Sem Fundo (CCF)
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| collectionRecordsResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| alinea | integer($int32) | Identificador do motivo da devolução do cheque |
| bankId | integer($int32) | Identificador do banco |
| bankName | string | Nome do banco |
| bankAgencyId | integer($int32) | Número da agência |
| checkNumber | string | Número do cheque |
| checkCount | integer($int32) | Quantidade de cheques |
| city | string | Cidade |
| federalUnit | string | Estado |
| legalSquare | string | Praça da ocorrência |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de cheques sem fundo |
| balance | number($double) | Valor total de cheques sem fundo |
Mais Anotações – Protestos
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| notaryResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| amount | number($double) | Valor da dívida |
| officeNumber | string | Número do cartório |
| city | string | Cidade |
| federalUnit | string | Estado |
| legalSquare | string | Praça da ocorrência |
| summary | ||
| firstOcurrence | string($date) | Data da negativação mais recente |
| lastOcurrence | string($date) | Data da negativação mais antiga |
| count | integer($int32) | Quantidade total de protestos |
| balance | number($double) | Valor total dos protestos |
Mais Anotações – Ações Judiciais
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| judgementFilingsResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| legalNatureId | string | Identificação de natureza jurídica |
| legalNature | string | Descrição Natureza Jurídica ID da ocorrência |
| civilCourt | string | Corte Civil |
| amount | number($double) | Valor da dívida |
| distributor | string | Distribuidor |
| city | string | Cidade |
| state | string | Estado |
| legalSquare | string | Praça da ocorrência |
| summary | ||
| count | integer($int32) | Quantidade total de Ações |
| balance | number($double) | Valor total das ações |
| firstOccurrence | string($date) | Data da ação mais antiga |
| lastOccurrence | string($date) | Data da ação mais recente |
Mais Anotações – Participações em Falências
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| bankruptsResponse | ||
| occurrenceDate | string($date) | Data da ocorrência |
| companyDocumentId | string | CNPJ da empresa registrado no Brasil |
| companyName | string | Nome da empresa |
| companyLegalNatureId | string | Identificação de natureza jurídica |
| companyLegalNature | string | Descrição Natureza Jurídica ID da ocorrência |
| legalSquare | string | Praça da ocorrência |
| summary | ||
| count | integer($int32) | Quantidade total |
| balance | number($double) | Valor total |
| firstOccurrence | string($date) | Data da ação mais antiga |
| lastOccurrence | string($date) | Data da ação mais recente |
Score de Fraude
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scoresFraud > scoresFraudResponse | ||
| score | Integer | Modelo usado para obter score |
| scoreModel | String | Valor do score |
| recommendationRisk | String | Recomendação baseada no valor do score |
| message | String | Mensagem do modelo de score requisitado |
Índice Relacionamento Mercado Setor PF (HIRF)
Possíveis campos de retorno para dados de Indice Relacionamento Mercado Setor PF.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| attributes > attributesResponse | ||
| attributeModel | string | Modelo do score |
| codeMessage | integer | Código da mensagem |
| message | string | Mensagem informativa |
| attributes > attributesResponse > data | ||
| code | Código do setor | |
| codeDescription | Descrição do setor | |
| codeMessage | Código do índice de relacionamento mercado e setor | |
| message | Mensagem do índice de relacionamento mercado e setor |
Alerta de Óbito
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| obito > deathResponse | ||
| document | string | Documento consultado |
| alert | string | Tipo do alerta |
| codes > codes | ||
| messageCode | string | Código da mensagem |
| fullMessage | string | Mensagens referentes ao óbito |
Score de Curto Prazo
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scores> scoreResponse | ||
| score | integer | Pontuação do score |
| scoreModel | string | Modelo do score |
| range | string | Faixa do score |
| defaultRate | string | Probabilidade de Inadimplência |
| codeMessage | integer | Código da mensagem de score |
| message | string | Mensagem do score |
Indicador de Recuperação de Crédito
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| score | ||
| score | integer | Pontuação do score |
| scoreModel | string | Modelo do score |
| range | string | Faixa do score |
| defaultRate | string | Probabilidade de Inadimplência |
| codeMessage | integer | Código da mensagem de score |
| message | string | Mensagem do score |
Agro Score
Análise de risco de crédito para produtores rurais pessoa física. Indica a probabilidade de um indivíduo pagar suas contas em dia nos próximos meses.
Possíveis campos de retorno para o Agro Score PF.
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| scores > scoreResponse | ||
| score | integer | Pontuação do score |
| scoreModel | string | Modelo do score |
| range | string | Faixa do score |
| defaultRate | string | Probabilidade de Inadimplência |
| codeMessage | integer | Código da mensagem de score |
| message | string | Mensagem do score |
Agro Renda Estimada
Agro Renda oferece uma estimativa de renda mensal (R$) calibrada para produtores rurais ou pessoas físicas relacionadas às atividades agropecuárias.
Possíveis campos de retorno:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| attributes > attributesResponse arrayList | ||
| scoring | integer | Pontuação do score |
| attributeModel | string | Modelo do score |
| codeMessage | integer | Código da mensagem |
| message | string | Mensagem informativa |
Segmentação Mosaic
O Mosaic oferece uma segmentação de mercado de pessoas físicas, com características de perfil de consumo.
Possíveis campos de retorno para Segmentação Mosaic:
| Field Name | Type | Description |
|---|---|---|
| mosaic | ||
| code | string | Brazilian Society Classification Code |
| group | string | Brazilian Society Classification Group |
| description | string | Brazilian Society Classification Description |
Risco de crédito do perfil
Traz uma avaliação de risco da população geral que tem o mesmo perfil do documento consultado.
Possíveis campos de retorno para o Risco de Crédito do Perfil:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| attributes > attributesResponse arrayList | ||
| scoring | integer | Pontuação do score |
| attributeModel | string | Modelo do score |
| codeMessage | integer | Código da mensagem |
| message | string | Mensagem informativa |
Renda Mais
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| attributes > attributesResponse arrayList | ||
| scoring | integer | Pontuação do score |
| attributeModel | string | Modelo do score |
| codeMessage | integer | Código da mensagem |
| message | string | Mensagem informativa |
ERROS E CÓDIGOS DE RETORNO/MENSAGEM
Para todas as funcionalidades listadas nesse documento estão sendo considerados os seguintes erros:
| Código | Descrição | Mensagem |
|---|---|---|
| 400 | Bad Request | Bad Request |
| 401 | Authorization Failed | Authorization Failed |
| 403 | Forbidden | Menor de idade protegido legalmente |
| 404 | Not Found | Documento não encontrado na Serasa Experian |
| 412 | Documento Consultado Inválido | [ERROR][INVALID-REQUEST] Erro encontrado com a requisição, informe o documento a ser consultado válido em: [X-Document-Id]. |
| 412 | Feature Opcional Inexistente/Inválida | [ERROR] [INVALID-REQUEST] Erro encontrado com a requisição, as [Features Opcionais] solicitadas [Não existem] ou [Não estão autorizadas] para o relatório [Features Opcionais]: [*<optionalFeature*>,...] |
| 412 | Usuário Sem Transações Cadastradas | [ERROR][USER-NOT-AUTHORIZED] Transações negadas:[<*optionalFeature*>,...] |
| 412 | Usuário Sem Logon ou CNPJ Vinculado no Client_Id | [ERROR][USER-NOT-AUTHORIZED] Usuário não autorizado. |
| 429 | Too Many Requests | Too Many Requests |
| 500 | Internal Server Error | Internal Server Error |
| 500 | Erro no Processamento de Uma ou Mais Informações | [ERROR][PROCESSING] Ocorreu um erro com as features: [<*dataset*>,...] |
| default | Unexpected Error |
DOCUMENTOS DE APOIO
Tabela de Naturezas Das Anotações Concentre
| Tipo de Anotação | Código Natureza | Descrição Natureza |
|---|---|---|
| Protestos | ||
| Ações | BA EX FE FM JB JE JF TR | Busca e Apreensão Execução Execução Fiscal Estadual Execução Fiscal Municipal Busca e Apreensão - Pequenas Causas Execução - Pequenas Causas Execução Fiscal Federal Execução de Título Judicial Trabalhista |
| Falências/Concordatas | AF CD CR CS FD FR RC RE RH RR | Auto Falência Concordata Deferida Concordata Requerida Concordata Suspensiva Falência Decretada Falência Requerida Recuperação Judicial Concedida Recuperação Extrajudicial Requerida Recuperação Extrajudicial Homologada Recuperação Judicial Requerida |
| PIE | FD | Falência Decretada |
| ACHEI | 12 13 14 | Cheques sem fundo 2ª Apresentação Conta Encerrada Prática Espúria |
Tabela de Naturezas Das Anotações REFIN
| Código Natureza | Descrição |
|---|---|
| AD | Adiantamento a depositantes - c/c devedores em geral |
| AG | Empréstimos agrícolas e industriais - financiamentos de custeio de investimentos agrícolas e industriais |
| AR | Arrendamentos, inclusive leasing |
| CA | Operações de câmbio - operações e financiamentos de câmbio em geral |
| CB | CDC outros bens móveis |
| CH | Adiantamento a depositantes - cheques sem fundos acolhidos |
| CL | CDC veículos leves |
| CM | CDC motocicletas e motonetas |
| CR | Impedidos pelo Banco Central de obtenção de crédito rural |
| CT | Cartão de crédito |
| CV | CDC veículos pesados: tratores, ônibus, caminhões, barcos e aviões |
| C2 | Consórcio veículos pesados: tratores, ônibus, caminhões, barcos e aviões |
| C3 | Consórcio veículos leves |
| C4 | Consórcio motocicletas e motonetas |
| C5 | Consórcio outros bens móveis |
| EC | Empréstimos em contas - c/c garantidas, financiamentos de capital de giro, programas especiais, etc |
| FI | Créditos e financiamentos - empréstimos a pessoas físicas, financiamentos ao consumidor final, etc |
| IM | Operações imobiliárias em geral, inclusive de sociedades de poupança |
| IP | Débito IPVA |
| LL | Leasing veículos leves |
| LM | Leasing motocicletas e motonetas |
| LV | Leasing veículos pesados: tratores, ônibus, caminhões, barcos e aviões |
| OJ | Operações ajuizadas |
| OO | Outras operações - diversas operações que não se enquadram nas demais |
| RE | Operações de repasse - operações 63, FINAME, REINVEST, RECON, PROALCOOL, etc |
| SR | Seguro de risco decorrido |
| TD | Títulos descontados - descontos de duplicatas, promissórias e outros títulos |
| FIF | crédito e financiamento-financeira |
Notas:
- Esta tabela de naturezas agrupa as diversas modalidades operacionais, de modo a permitir o enquadramento das operações em geral, realizadas não só pelos bancos comerciais, como também pelas demais empresas do conglomerado financeiro.
- Ao código da natureza da operação poderá opcionalmente ser acrescentada a identificação da empresa do conglomerado em que a operação foi realizada, conforme padrões abaixo:
V – banco de investimento
I – crédito imobiliário
C – corretora de valores
T - turismo
F – financeira
P – poupança
S – seguradora
Se esta identificação não for colocada, a operação será considerada do Banco Comercial.
Se esta identificação não for colocada, a operação será considerada do Banco Comercial.
Tabela de Naturezas Das Anotações PEFIN
| COD | DESCRIÇÃO NATUREZA | ABREVIAÇÃO 12 POS |
|---|---|---|
| AD | Adiantamento a depositantes - conta corrente devedora | ADIANT CONTA |
| AG | Empréstimo / financiamento agrícola / rural-comercial, industrial e custeio | EMPRESTIMOS |
| AL | Aluguel | ALUGUEL |
| AR | Arrendamento, inclusive leasing | LEASING |
| C1 | Consórcio imóvel | CONS IMOVEIS |
| C2 | Consórcio veículos pesados: tratores, ônibus, caminhões, barcos e aviões | CONS VEI PES |
| C3 | Consórcio veículos | CONS VEICULO |
| C4 | Consórcio motocicletas e motonetas | CONS MOTOS |
| C5 | Consórcio outros bens móveis | CONS BENS |
| C6 | Consórcio passagens aéreas | CONS AEREO |
| CA | Operações de financiamento de câmbio em geral | OPER CAMBIO |
| CB | CDC outros bens móveis | CDC BENS |
| CC | Cota condominial | CONDOMINIO |
| CD | Crédito direto – crediário | CREDIARIO |
| CL | CDC veículos leves | CDC V LEVE |
| CM | CDC motocicletas e motonetas | CDC MOTOS |
| CO | Consórcio contemplado | CONS CONTEMP |
| CP | Crédito pessoal | CRED PESSOAL |
| CR | Impedidos de crédito rural pelo Bacen | IMPEDIDO BC |
| CT | Operações com cartão de crédito | CRED CARTAO |
| CV | CDC veículos pesados: tratores, ônibus, caminhões, barcos e aviões | CDC V PES |
| DC | Dívidas originárias de cheques | DIVIDAS CHEQ |
| DE | Dívidas originárias de cheque eletrônico | CHEQUE ELET |
| DP | Duplicata | DUPLICATA |
| EC | Empréstimos em conta, conta corrente garantida, capital de giro, programa especial | EMPRES CONTA |
| EE | Energia elétrica - faturas de fornecimento de luz | ENERGIA ELET |
| EG | Empréstimo consignado | EMPR CONSIG |
| FG | Gás - faturas de fornecimento de gás | FAT GAS |
| FI | Créditos e financiamentos | FINANCIAMENTO |
| HO | Despesas com hospitais | HOSPITAIS |
| IE | Instituição de ensino: bolsa restituível | INST ENSINO |
| IM | Operações imobiliárias | OPER IMOBIL |
| LL | Leasing veículos leves | LEAS VEICULO |
| LM | Leasing motocicletas e motonetas | LEAS MOTOS |
| LV | Leasing veículos pesados: tratores, ônibus, caminhões, barcos e aviões | LEAS VEI PES |
| ME | Mensalidades escolares | MENS ESCOLAR |
| NF | Notas fiscais | NOTA FISCAL |
| OA | Operações agrícolas – negociações produtos rurais, insumos, sementes etc. | OPER AGRIC |
| OJ | Operações ajuizadas | OPER AJUIZAD |
| OO | Outras operações | OUTRAS OPER |
| RE | Operações de repasse, FINAME, 63, REINVEST, RECON, PROALCOOL etc. | REPASSES |
| RR | Arrecadadores - prestadores de serviços | ARRECADADOR |
| SB | Saneamento básico - faturas de fornecimento de água | FAT AGUA |
| SF | Seguro fiança locatícia | SEG FIANCA |
| SG | Seguro garantia | SEG GARANTIA |
| SQ | Seguro quebra de garantia | SEG QUEBRA |
| SR | Seguro de risco decorrido | SEGURO RISCO |
| SS | Mensalidade de plano/seguro de saúde | SEGURO SAUDE |
| TC | Termo de confissão de dívida descumprido | CONFISS DIV |
| TD | Títulos descontados, duplicatas, promissórias, etc. | TIT DESCONTA |
| TE | Serviços de telefonia móvel pessoal / celular – outras contas após rescisão do contrato | TELEF MO |
| TF | Serviços de telefonia fixa – outras contas após rescisão do contrato | TELEF FX |
| TI | Serviços de dados e internet (speedy, aluguel de canais de dados e fibra ótica) | SERV DADOS |
| TM | Serviços de telefonia móvel pessoal / celular – res 221/00 | TELEF MOVEL |
| TP | Serviços de telefonia / vendas de produtos – vendas de aparelhos, instalação, aluguel de aparelhos | SERV TELEFON |
| TR | Serviços de telefonia – renegociação da dívida | RENEG DIVIDA |
| TT | Serviços de telefonia fixa – res 085/98 | TELEF FIXA |
| VM | Prestação de serviços - vendas de mercadorias | VENDA MERCAD |
Tabela de Naturezas Das Anotações Convem Devedores
| Código | Descrição |
|---|---|
| BC | COBRANÇA CAUCIONADA |
| BD | COBRANÇA DESCONTADA |
| BS | COBRANÇA SIMPLES |
| CC | CONTRATO DE CÂMBIO |
| CCC | CÉDULA DE CRÉDITO COMERCIAL |
| CCE | CÉDULA DE CRÉDITO À EXPORTAÇÃO |
| CCI | CÉDULA DE CRÉDITO INDUSTRIAL |
| CCR | CÉDULA DE CRÉDITO RURAL |
| CD | CONFISSÃO DE DÍVIDA |
| CDE | CERT EN76 JE |
| CH | CHEQUE |
| CHP | CÉDULA HIPOTECÁRIA |
| CJV | CONTA JUDICIALMENTE VERIFICADA |
| CM | CONTRATO DE MÚTUO |
| CPH | CÉDULA RURAL PIGNORATÍCIA HIPOTECÁRIA |
| CRH | CÉDULA RURAL HIPOTECÁRIA |
| CRP | CÉDULA RURAL PIGNORATÍCIA |
| CS | CONTA DE PRESTAÇÃO DE SERVIÇO |
| DM | DUPLICATA DE VENDA MERCANTIL |
| DMI | DUPLICATA DE VENDA MERCANTIL POR INDICAÇÃO |
| DR | DUPLICATA RURAL |
| DRI | DUPLICATA RURAL DE INDICAÇÃO |
| DS | DUPLICATA DE PRESTAÇÃO DE SERVIÇOS |
| DSI | DUPLICATA DE PRESTAÇÃO DE SERVIÇOS POR INDICAÇÃO |
| DV | DIVERSOS - QUANDO NÃO ENQUADRAR NA RELAÇÃO ACIMA |
| LC | LETRA DE CÂMBIO |
| LCN | LETRA DE CÂMBIO SEM ACEITE |
| NCC | NOTA DE CRÉDITO COMERCIAL |
| NCE | NOTA DE CRÉDITO À EXPORTAÇÃO |
| NCI | NOTA DE CRÉDITO INDUSTRIAL |
| NCR | NOTA DE CRÉDITO RURAL |
| NP | NOTA PROMISSÓRIA |
| NPR | NOTA PROMISSÓRIA RURAL |
| SJ | SENTENÇA JUDICIAL |
| TA | TERMO DE ACORDO |
| TM | TRIPLICATA DE VENDA MERCANTIL |
| TS | TRIPLICATA DE PRESTAÇÃO DE SERVIÇOS |
| W | WARRANT |
Tabela de índices dos dados cadastrais
| Código | Descrição |
|---|---|
| documentosAlternativos | |
| 1 | CARTEIRA DE IDENTIDADE (RG) |
| 2 | CARTEIRA DE IDENTIFICAÇÃO DE ESTRANGEIRO |
| 4 | CERTIFICAÇÃO MILITAR |
| 5 | CARTEIRA PROFISSIONAL |
| 6 | PASSAPORTE |
| tiposTelefone | |
| 1 | TELEFONE RESIDENCIAL |
| 2 | TELEFONE COMERCIAL |
| 3 | TELEFONE MOVEL |
| 4 | TELEFONE MOVEL |
| 5 | TELEFONE PÚBLICO |
| 6 | HOUSE HOLD-FAMILIA |
| 7 | ENDEREÇO DOMÉSTICO |
| 8 | TELEFONE MOVEL COMERCIAL |
| 9 | TELEFONE DE PARENTE |
| tipoEndereco | |
| 1 | RESIDENCIAL |
| 2 | COMERCIAL |
| educationLevelCode | |
| 1 | GRAU |
| 2 | GRAU |
| 3 | SUPERIOR COMPLETO |
| 4 | SUPERIOR INCOMPLETO |
| 5 | POS GRAD |
| 6 | ANALFABETO |
| 25 | MESTRADO |
| 33 | SUPERIOR COM |
| 35 | DOUTORADO |
| 44 | SUPERIOR INC |
| 45 | PHD |
| maritalStatus | |
| 1 | CASADO |
| 2 | SOLTEIRO |
| 3 | VIUVO |
| 4 | DIVORCIADO |
| 5 | SEPARADO |
| 9 | OUTRO |
Conteúdos de segmento consultante
| # | Descrição |
|---|---|
| 1 | INDUSTRIA DE INSUMOS |
| 2 | SERVICOS DE SAUDE |
| 3 | GRANDES BANCOS PRIVADOS |
| 4 | GRANDES FINANCEIRAS |
| 5 | MEDIOS BANCOS PRIVADOS |
| 6 | BANCOS GIGANTES |
| 7 | SERVICOS DE TURISMO |
| 8 | SERVICOS DE TELECOM |
| 9 | INDUSTRIA DE BENS NAO DURAVEIS |
| 10 | CARTOES E MEIOS DE PAGAMENTO |
| 11 | GRANDES BANCOS PUBLICOS |
| 12 | GRANDES BANCOS |
| 13 | SEGMENTOS DIVERSOS |
| 14 | PEQUENOS BANCOS PUBLICOS |
| 15 | CONSORCIO |
| 16 | ATACADO NAO DURAVEL |
| 17 | VAREJO DE AUTO |
| 18 | VAREJO DE MOVEIS E DECORACAO |
| 19 | PEQUENOS BANCOS |
| 20 | SEGURADORAS |
| 21 | VAREJO DIVERSOS |
| 22 | |
| 23 | FINANCEIRAS |
| 24 | VAREJO ELETROELETRONICO |
| 25 | VAREJO DE MAGAZINE E COMERCIO ELETRONICO |
| 26 | SERVICOS EDUCACIONAIS |
| 27 | MEDIOS BANCOS PUBLICOS |
| 28 | SERVICOS DIVERSOS |
| 29 | MEDIOS BANCOS |
| 30 | SERVICOS BASICOS |
| 31 | VAREJO DE VESTUARIO |
| 32 | FACTORING |
| 33 | ATACADO DURAVEL |
| 34 | PEQUENOS BANCOS PRIVADOS |
| 35 | BANCOS |
| 36 | VAREJO DE MATERIAL DE CONSTRUCAO |
| 37 | MEDIAS FINANCEIRAS |
| 38 | PEQUENAS FINANCEIRAS |
| 39 | VAREJO DE SUPERMERCADOS |
| 40 | SERVICOS IMOBILIARIOS |
| 41 | INDUSTRIA DE BENS DURAVEIS |
| 42 | OUTROS |
Retornos de occupation
| co_ocupacao | de_ocupacao |
|---|---|
| 1 | EMPREGADO |
| 2 | SOCIO/PROP |
| 3 | VIVE RENDA |
| 4 | FUNC PUBL |
| 5 | AUTONOMO |
| 6 | PROF LIBER |
| 7 | APOSENTADO, PENSIONISTA |
| 9 | OUTRO |
Retornos de documentos roubados
Motivos do extravio:
- CLONADO
- EXTRAVIADO
- FURTADO
- ROUBADO