--- title: "Quod - Análise de Crédito - Pessoa Física" method: POST path: "/br/quod/analise-credito/pessoa-fisica" tags: ["Quod - Gestora de Crédito"] --- # Quod - Análise de Crédito - Pessoa Física `POST /br/quod/analise-credito/pessoa-fisica` ## Request - Base URL: `https://api.exato.digital` - URL: `https://api.exato.digital/br/quod/analise-credito/pessoa-fisica` - Auth: API key in header `token` Quod - Análise de Crédito - Pessoa Física ## Query parameters - `test_mode` boolean - `lightweight` boolean ## Request body `application/x-www-form-urlencoded` - object - `cpf` string, required: Person's CPF (Brazilian Tax ID) / CPF a ser consultado ## Response `200` Success - QuodReportResponse: QuodReportResponse - `ApiResultType` 'Success' | 'SuccessWithRemarks' | 'InvalidInput' | 'DataUnavailable' | 'NotFound' | 'InvalidParameters' | 'UnsupportedCombination' | 'RemoteUnavailable' | 'Timeout' | 'RetryLimitReached' | 'RemoteError' | 'InProgress' | 'InsufficientCredits' | 'ConcurrentLimitReached' | 'TransactionUnavailable' | 'AccessDenied' | 'TransactionCancelled' | 'Created' | 'Updated' | 'Deleted' | 'InternalError' | 'ValidationFailed' | 'Conflict' | 'ResourceLocked' | 'PendingApproval' | 'Approved' | 'Rejected' | 'Cancelled' | 'Paused' | 'Resumed': Novo tipo de resultado unificado para queries e operações administrativas. Substitui TransactionResultType com melhor semântica. - `BalanceInBrl` number, double: Saldo atual em BRL. - `BalanceInCredits` integer: Saldo atual em créditos. - `DataSourceCategory` string: Categoria da fonte de dados - `Date` string, date-time: Data da transação. - `ElapsedTimeInMilliseconds` integer: Tempo de execução (em milisegundos). - `ExecutedDataSourceName` string: Nome de exibição do tipo de consulta que realmente executou. - `ExecutedDataSourceTypeId` integer: Id do tipo de consulta que realmente executou (o gravado na transação), que pode diferir do tipo pedido quando a rota é genérica por UF ou quando um master delega a uma sub-consulta. - `HasOriginalFiles` boolean: Indica que a transação carrega arquivos originais da fonte (a certidão emitida, por exemplo) para download em OriginalFilesUrl. Falso não significa que a URL não exista: ela é montada sempre. - `HasPdf` boolean: Indica que existe PDF de comprovante do resultado. - `Message` string: Mensagem. - `OriginalFilesUrl` string: Url para download dos arquivos originais da transação (quando disponíveis). - `OutdatedResult` boolean: Indica que o resultado é datado. - `PdfUrl` string: Url para download do arquivo de comprovante em PDF da transação (quando disponível). - `ResultSubtype` string: Subtipo específico do resultado para fornecer contexto adicional (ex: 'duplicate_name', 'invalid_cpf'). - `ResultTypeCode` integer: Código numérico do resultado (compatível com TransactionResultTypeCode mas extensível). - `TotalCost` number, double: Internal use only. - `TotalCostInCredits` integer: Custo total da transação em créditos. - `TransactionResultType` 'Success' | 'SuccessWithRemarks' | 'InvalidInputData' | 'UnavailableData' | 'EntityNotFound' | 'InvalidParameters' | 'ParametersNotSupported' | 'RemoteSystemUnavailable' | 'Timeout' | 'AttemptsLimitReached' | 'RemoteSystemError' | 'AsyncExecutionInProgress' | 'AwaitingExecution' | 'BirthDateRequired' | 'InsufficientBalance' | 'SimultaneousTransactionsLimitReached' | 'TransactionUnavailable' | 'AccessDenied' | 'TransactionCancelled' | 'InternalError':
TransactionResultType CodeTransactionResultTypeDefinitivoFaturavelErro
1SucessoVerdadeiroVerdadeiroFalso
2Sucesso parcial ou com observaçõesVerdadeiroVerdadeiroFalso
3Entrada ou documento inválidoVerdadeiroFalsoVerdadeiro
4Dados não disponíveisVerdadeiro (no dia)FalsoFalso
5Entidade ou documento inexistente/não encontradoVerdadeiroVerdadeiroFalso
6Parâmetros de entrada inválidosVerdadeiroFalsoVerdadeiro
7Combinação de parâmetros não suportadosVerdadeiroFalsoVerdadeiro
8Fonte de dados ou sistema remoto indisponívelFalsoFalsoVerdadeiro
9Limite de tempo esgotadoFalsoFalsoVerdadeiro
10Limite de tentativas atingidoFalsoFalsoVerdadeiro
11Erro na fonte de dados ou sistema remotoFalsoFalsoVerdadeiro
12Transação em execuçãoFalsoFalsoFalso
101Saldo em créditos insuficiente, entre em contatoFalsoFalsoVerdadeiro
102Limite de transações simultâneas atingido, entre em contatoFalsoFalsoVerdadeiro
103Transação não disponível, entre em contatoFalsoFalsoVerdadeiro
104Credenciais inválidas ou acesso negado, entre em contatoFalsoFalsoVerdadeiro
105Transação cancelada, entre em contatoFalsoFalsoVerdadeiro
255*Erro interno não esperado, entre em contatoVerdadeiro (no dia)FalsoVerdadeiro
* Consulta em manutenção, tente refazer mais tarde ou entre em contato com a Exato para notificação do problema
- `TransactionResultTypeCode` integer: Código do tipo de resultado da transação. - `UniqueIdentifier` string: Identificador único da transação. Recomendado armazenar para controle e depuração. - `Result` QuodReportResult: QuodReportResult - `Records` QuodPfRecords: QuodPfRecords - `Record` QuodPfRecord[] - `HasOnlyMinimumPII` boolean: Indica se o CPF contém dados mínimos do registro (nome, CPF e data de nascimento) - `HasNegativeData` boolean: Indica se o CPF contém qualquer negativação. Caso essa informação tenha sido solicitada na consulta (“IncludeOnlyNegativeAndInquiryExistenceCheck” = 1) o retorno será positivo(true) ou negativo(false). Caso a informação não tenha sido solicitada na consulta, o retorno será sempre negativo(‘false”) - `HasInquiryData` boolean: Indica se o CPF contém dados de consulta. Caso essa informação tenha sido solicitada na consulta(“IncludeOnlyNegativeAndInquiryExistenceCheck” = 1) o retorno será positivo(true) ou negativo(false). Caso a informação não tenha sido solicitada na consulta, o retorno será sempre negativo(‘false”) - `BestInfo` QuodPfBestInfo: QuodPfBestInfo - `CPF` string: CPF - `CPFStatus` string: Indica se um CPF está ativo (por exemplo, se o CPF está ativo com receita) - `PersonName` QuodPfPersonName: QuodPfPersonName - `Name` QuodPfName: QuodPfName - … - `MotherName` QuodPfName: QuodPfName - `Full` string: Nome Completo - `DOB` QuodPfDate: QuodPfDate - `Year` string: Ano - `Month` string: Mês - `Day` string: Dia - `Age` string: Idade - `Gender` string: Gênero - `Address` QuodPfAddress: QuodPfAddress - `Street` string: Nome da rua - `Number` string: Número - `Complement` string: Complemento - `Neighborhood` string: Bairro - `City` string: Nome da localidade (p.ex., cidade) - `State` string: Estado - `PostalCode` string: CEP - `DateLastSeen` QuodPfDate: QuodPfDate - … - `Email` QuodPfEmail: QuodPfEmail - `DateLastSeen` QuodPfDate: QuodPfDate - … - `EmailValue` string: E-mail - `PhoneNumber` QuodPfPhoneNumber: QuodPfPhoneNumber - `DateLastSeen` QuodPfDate: QuodPfDate - … - `PhoneNumberValue` string: Número de telefone - `MobilePhoneNumber` QuodPfMobilePhoneNumber: QuodPfMobilePhoneNumber - `DateLastSeen` QuodPfDate: QuodPfDate - … - `PhoneNumber` string: Número de telefone - `PersonNameHistory` QuodPfPersonNameHistory: QuodPfPersonNameHistory - `Name` QuodPfName[]: Estrutura que contém os dados do nome - … - `AddressHistory` QuodPfAddressHistory: QuodPfAddressHistory - `Address` QuodPfAddress[]: Estrutura que contém os elementos Street, Number, Complement, Neighborhood, City, State e PostalCode - … - `EmailHistory` QuodPfEmailHistory: QuodPfEmailHistory - `Email` QuodPfEmail[]: E-mail - … - `PhoneNumberHistory` QuodPfPhoneNumberHistory: QuodPfPhoneNumberHistory - `PhoneNumber` QuodPfPhoneNumber[]: Número de telefone - … - `MobilePhoneNumberHistory` QuodPfMobilePhoneNumberHistory: QuodPfMobilePhoneNumberHistory - `MobilePhoneNumber` QuodPfMobilePhoneNumber[]: Estrutura que contém os elementos DateLastSeen e PhoneNumber - … - `QuodScore` QuodPfScore: QuodPfScore - `Score` integer: Pontuação de crédito (0-999) - `ReasonCode1` QuodPfReasonCode: QuodPfReasonCode - `Code` string: Código que indica a razão para o score de uma pessoa - `Message` string: Mensagem que detalha a o código de razão - `ReasonCode2` QuodPfReasonCode: QuodPfReasonCode - `Code` string: Código que indica a razão para o score de uma pessoa - `Message` string: Mensagem que detalha a o código de razão - `ReasonCode3` QuodPfReasonCode: QuodPfReasonCode - `Code` string: Código que indica a razão para o score de uma pessoa - `Message` string: Mensagem que detalha a o código de razão - `NormalizedScoreReason` QuodPfNormalizedScoreReason: QuodPfNormalizedScoreReason - `Zone` string - `ZoneStart` integer - `ZoneEnd` integer - `Risk` QuodPfNormalizedScoreReasonRisk: QuodPfNormalizedScoreReasonRisk - … - `PaymentExpectation` QuodPfNormalizedScoreReasonPaymentExpectation: QuodPfNormalizedScoreReasonPaymentExpectation - … - `PaymentCommitmentScore` string - `PaymentCommitmentScoreDescription` string - `ProfileScore` string - `ProfileScoreDescription` string - `PaymentCommitmentScoreValue` integer - `ProfileScoreValue` integer - `Segment` string - `Negative` QuodPfNegative: QuodPfNegative - `DateLastApontamento` QuodPfDate: QuodPfDate - `Year` string: Ano - `Month` string: Mês - `Day` string: Dia - `PendenciesControlCred` string: Número de negativações - `Apontamentos` QuodPfApontamentos: QuodPfApontamentos - `Apontamento` QuodPfApontamento[]: Estrutura que contém elementos Apontamento - … - `LawSuitApontamentos` QuodPfLawSuitApontamentos: QuodPfLawSuitApontamentos - `LawSuitApontamento` QuodPfLawSuitApontamento[]: Bloco do apontamento da ação judicial. - … - `CcfApontamentos` QuodPfCcfApontamentos: QuodPfCcfApontamentos - `CcfApontamento` QuodPfCcfApontamento[] - … - `Inquiries` QuodPfInquiries: QuodPfInquiries - `InquiryCountLast30Days` integer: Contagem de consultas nos últimos 30 dias - `InquiryCountLast31to60Days` integer: Contagem de consultas entre os últimos 31 e 60 dias - `InquiryCountLast61to90Days` integer: Contagem de consultas entre os últimos 61 e 90 dias - `InquiryCountMore90Days` integer: Contagem de consultas de mais de 90 dias - `InquiryDetails` QuodPfInquiryDetails: QuodPfInquiryDetails - `InquiryDetail` QuodPfInquiryDetail[]: InquiryDetail - … - `EnterpriseData` QuodPfEnterpriseData: QuodPfEnterpriseData - `Partnerships` QuodPfPartnerships: QuodPfPartnerships - `Partnership` QuodPfPartnership[] - … - `Protests` QuodPfProtests: QuodPfProtests - `Protest` QuodPfProtest[] - `CNPJ` string - `CpfCnpj` string - `TransactionId` string - `Data_consulta` string - `Retorno` string - `Erro` string - `Erro_descricao` string - `Situacao` string - `Valor_protestados_total` string - `Conteudo` QuodPfConteudo: QuodPfConteudo - … - `CPStatus` string: Estrutura que contém dados sobre consultas --- [API](https://skmtc.dev/exato/apis/backend-apis.md) - [All operations](https://skmtc.dev/exato/apis/backend-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/exato/apis/backend-apis/revisions/c25e99bad8a4?raw)