{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a6406f20-644b-430b-bb6c-3318c2823344","name":"API Smart 2.0","description":"Aqui você tem todas as informações de conexão com a api.\n\nURL BASE: [https://api.targetdata.com.br/api<br><br>](https://api.targetdata.com.br/api)Qualquer dúvida com relação a integração, é só acessar os nossos tutoriais de integração abaixo:  \n[https://suporte.targetdata.com.br/help/pt-br/37-area-do-desenvolvedor](https://suporte.targetdata.com.br/help/pt-br/37-area-do-desenvolvedor)\n\n# Chaves da API\n\nPara realizar as consultas na api, é necessário gerar as chaves da api na plataforma Smart.\n\nAs chaves da api são duas:\n\n- API Key\n    \n- API Secret\n    \n\nElas devem ser enviadas no corpo da requisição junto com os parametros do produto, como mostra o exemplo abaixo:\n\n``` json\n{\n    \"api_key\":\"{{api_key}}\",\n    \"api_secret\":\"{{api_secret}}\",\n    \"cnpj\":\"73.985.523/0001-08\"\n}\n\n ```\n\nVeja como é fácil gerar as chaves da api:\n\n[https://suporte.targetdata.com.br/help/pt-br/37-area-do-desenvolvedor/25-como-gerar-chave-api-api_key-e-api_secret](https://suporte.targetdata.com.br/help/pt-br/37-area-do-desenvolvedor/25-como-gerar-chave-api-api_key-e-api_secret)\n\n**Atenção:** As chaves da api não possuem tempo de expiração! Para sua segurança mantenha suas chaves em sigilo absoluto, elas são utilizadas para acessar todos os serviços da TargetData e são de inteira responsabilidade do contratante.\n\n# Whitelist de IPs\n\nPara realizar as consultas na api, é necessário cadastrar os ips na plataforma Smart, no menu Integração.  \nVeja como é fácil adicionar um IP na whitelist:\n\n[https://suporte.targetdata.com.br/help/pt-br/37-area-do-desenvolvedor/52-como-adicionar-um-ip-para-a-whitelist](https://suporte.targetdata.com.br/help/pt-br/37-area-do-desenvolvedor/52-como-adicionar-um-ip-para-a-whitelist)\n\n# Cobrança das APIs\n\nAs consultas só serão cobradas quando o status code (Código HTTP) for igual a **200**\n\n# Implementação de retentativas\n\nÉ recomendado o processo de rentativas apenas quando o status code (Código HTTP) for igual a **500**\n\n# Estruturas de retorno de erro\n\nAntes da autenticação, todos os erros retornam na seguinte estrutura:\n\n``` json\n{\n  \"code_error\": 1404,\n  \"message_error\":\"A página solicitada não foi encontrada.\"\n}\n\n ```\n\nApós a autenticação, todos os erros retornam na seguinte estrutura:\n\n``` json\n{\n    \"header\": {\n        \"amount_found\": 0,\n        \"amount_sent\": 1,\n        \"code_error\": 3022,\n        \"elapsed_time_seconds\": 1.181552,\n        \"message_error\": \"Documento não encontrado\",\n        \"request_date\": \"04/01/2024 12:39:20\",\n        \"request_id\": \"39b3ec3f-969e-4baa-995c-405eff37ddf0-MDQvMDEvMjAyNC0xMjozOToyMA==\"\n    }\n}\n\n ```\n\n# Códigos de Erros Gerais da API\n\n| Código Interno da API | Descrição do Código | **Código HTTP** |\n| --- | --- | --- |\n| 1002 | Empresa não encontrada | **401** |\n| 1003 | A empresa não está ativa, contate a TargetData para saber mais | 401 |\n| 1004 | A chave da api não está preenchida | 401 |\n| 1005 | A chave da api não está preenchida. | 401 |\n| 1006 | A chave da api está inválida | 401 |\n| 1100 | A empresa não possui um contrato ativo. | 401 |\n| 1101 | Produto indisponível para essa empresa. | 400 |\n| 1102 | Produto indisponível | 400 |\n| 1103 | Tabela de preço para esse produto não existe | 400 |\n| 1104 | Saldo insuficiente | 400 |\n| 1104 | Limite de consumo insuficiente. | 400 |\n| 1105 | Produto não encontrado | 400 |\n| 1106 | Produto indisponível para esse usuário. | 400 |\n| 1107 | Parâmetro ausente: \\[campo\\] | 400 |\n| 1108 | CPF inválido | 400 |\n| 1110 | Erro ao gerar PDF | 400 |\n| 1111 | Erro ao buscar PDF | 400 |\n| 1112 | request_id não encontrado | 400 |\n| 1113 | O agrupamento de retorno \\[nome_agrupamento\\] não pode ser enviado junto com o \\[nome_agrupamento\\] | 400 |\n| 1114 | Erro ao gerar a url do iframe | 400 |\n| 1115 | Erro ao buscar as informações do produto | 400 |\n| 1116 | request_id não encontrado | 400 |\n| 1404 | Not Found (Página não encontrada) | 404 |\n| 1500 | Houve um erro interno | 500 |\n| 1993 | Timeout do serviço | 500 |\n| 1996 | Houve um erro interno. | 500 |\n| 1998 | Serviço indisponível temporariamente. | 500 |\n| 1999 | Houve um erro interno | 500 |\n| 2001 | CPF/CNPJ inválido | 400 |\n| 2002 | Tipo inválido | 400 |\n| 2005 | Campo '{campo}' não foi encontrado | 400 |\n| 2006 | Campo '{campo}' não deve ser vazio | 400 |\n| 2007 | Valor inválido para o campo '{campo}' | 400 |\n| 2022 | Documento não encontrado | 400 |\n| 2038 | Somente um dos dois campos 'inscricao_estadual' ou 'cnpj' são permitidos | 400 |\n| 2039 | O parâmetro 'uf' é obrigatório ao fornecer 'inscricao_estadual' | 400 |\n| 2040 | CNPJ não encontrado no database | 400 |\n| 2500 | Erro desconhecido. | 500 |\n| 3001 | CPF/CNPJ inválido | 400 |\n| 3002 | Sem resultados | 400 |\n| 3005 | Campo {} não encontrado | 400 |\n| 3006 | Campo requerido {} não deve ser vazio! | 400 |\n| 3009 | Tipo do {campo} inválido | 400 |\n| 3013 | UF inválido | 400 |\n| 3015 | Não é permitido os dois campos juntos: cpf e cnpj. | 400 |\n| 3019 | Email inválido | 400 |\n| 3020 | Não foi encontrado dados para esse CPF | 400 |\n| 3021 | Não foi encontrado dados para esse CNPJ | 400 |\n| 3022 | Documento não encontrado | 400 |\n| 3023 | Campo inválido | 400 |\n| 3024 | Parâmetro {phone_number} inválido | 400 |\n| 3025 | Servidor indisponível | 500 |\n| 3026 | Erro desconhecido | 500 |\n| 3031 | Parâmetro {param} deve ser string | 400 |\n| 3032 | Parâmetro {param} deve ser uma lista | 400 |\n| 3033 | Parâmetro {param} não é permitido | 400 |\n| 3034 | Parâmetro {param} deve conter apenas números | 400 |\n| 3035 | Parâmetro {param} deve ser uma lista de strings | 400 |\n| 3036 | Parâmetro {param} não é válido | 400 |\n| 3037 | Parâmetro {param} não deve ser vazio | 400 |\n| 3039 | Esse CPF/CNPJ não está na lista de sandbox | 400 |\n| 3041 | {documento} - Este documento não pode ser visualizado, pois essa pessoa é menor de idade (18 anos). | 400 |\n| 3041 | {documento} - Este documento não pode ser visualizado, pois essa pessoa é uma pessoa Pessoa Exposta Politicamente. | 400 |\n| 3041 | {documento} - Este documento não pode ser visualizado, pois o titular solicitou a exclusão, de acordo com as normas da LGPD. | 400 |\n| 3057 | Não foi encontrado dados para esse CNPJ | 400 |\n| 3058 | CNPJ não disponível na base de dados | 400 |\n| 3999 | Excedeu o número máximo do campo {campo} | 400 |\n| 3500 | Erro Interno | 500 |\n| 3502 | Houve um erro interno | 500 |\n| 3504 | Prove® Não consegue identificar o assinante móvel. O número de telefone não está atualmente disponível na rede. | 400 |\n| 3505 | Prove® Não tem acesso aos dados deste assinante móvel. | 400 |\n| 3506 | Prove® Não configurou sua conta para acessar dados deste serviço e/ou de um operador de rede móvel específico. Se isso for inesperado, entre em contato com o suporte da Prove® para provisionamento. | 400 |\n| 3507 | Certifique-se de que o parâmetro especificado em 'AdditionalInfo' seja válido e tente novamente. | 400 |\n| 3508 | O assinante não é elegível para o serviço. Não há dados disponíveis para o assinante móvel. | 400 |\n| 3509 | Não há dados do CRM disponíveis. Não há dados disponíveis para o assinante móvel. | 400 |\n| 3510 | Incompatibilidade de desafio. Insira os dados de desafio corretos. | 400 |\n| 3511 | Token Inválido. Credenciais incorretas. Obtenha um novo token. | 400 |\n| 3512 | Sessão Expirada. O token expirou. Obtenha um novo token. | 400 |\n| 3513 | Parâmetros inválidos. Tipo de mídia inválido: somente application/json é suportado. | 400 |\n| 3514 | Incompatibilidade de operadora. As informações da operadora MNO recebidas não correspondem às informações da operadora registradas. | 400 |\n| 3515 | O provedor externo não pode ser alcançado. A Prove está atualmente enfrentando problemas para se conectar a um provedor de dados terceirizado. | 400 |\n| 3516 | Operadora não forneceu autorização para o número de telefone, ou o provedor de dados não pode concluir a transação. | 400 |\n| 3400 | Requisição inválida (check_timestamp) | 400 |\n| 3401 | Erro de autenticação com o provedor | 401 |\n| 3403 | Acesso negado ao serviço | 403 |\n| 3404 | Documento não encontrado (check_timestamp) | 404 |\n| 3503 | Serviço temporariamente indisponível | 503 |\n| 3822 | CPF/CNPJ não encontrado na base da Receita Federal | 200 |\n| 3852 | Erro de comunicação (Bad Gateway) | 502 |\n| 3854 | Tempo de resposta excedido (Gateway Timeout) | 504 |\n| 3862 | CPF de menor de idade (LGPD) | 200 |\n| 3863 | CPF de menor de 16 anos - Lei Felca (Lei nº 15.211/2025) | 200 |\n| 3872 | Assinatura não corresponde ao documento (check_timestamp) | 422 |\n\n# Webhook\n\nAo cadastrrar o webhook, é possivel cadastrar somente url com protocolo **https**.\n\nPode ser selecionados as seguintes formas de autenticação:\n\n- Basic\n    \n- Bearer\n    \n- X-Key-API\n    \n- Sem autenticação\n    \n\nO retorno da sua api, deve retornar com o campo **\"token\"** com o token de verificação mostrado no cadastro do webhook.\n\n#### Exemplos de webhook:\n\n``` json\n{\n    \"id\": \"2b1cf407-17ee-492b-a401-4df3eee547ef-MTYvMDQvMjAyNS0wMzozNzoyOA==\",\n    \"product\": \"monitora-pj\",\n    \"request_id\": null,\n    \"status\": \"success\",\n    \"message_error\": null,\n    \"code_error\": null,\n    \"data\": {}\n}\n\n ```\n\nSiga o tutorial abaixo para cadastrar um webhook:  \n[https://suporte.targetdata.com.br/help/pt-br/37-area-do-desenvolvedor/43-como-criar-um-webhook](https://suporte.targetdata.com.br/help/pt-br/37-area-do-desenvolvedor/43-como-criar-um-webhook)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"30373872","team":12599052,"collectionId":"a6406f20-644b-430b-bb6c-3318c2823344","publishedId":"2s9YJhveyd","public":true,"publicUrl":"https://documenter-api.postman.tech/view/30373872/2s9YJhveyd","privateUrl":"https://go.postman.co/documentation/30373872-a6406f20-644b-430b-bb6c-3318c2823344","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"API dos produtos do Smart 2.0, onde possui consultas de cobrança e antifraude, análise de crédito, compliance e patrimônio."},{"name":"title","value":"Documentação da API Smart 2.0"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/e57c715a-808d-4305-99c5-04a8f9acfe09/dGFyZ2V0ZGF0YS1sb2dvLWhvcml6b250YWwtY29yLXJnYi5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/eab81c26-f931-4589-9924-e4d0540f6ba2/dGFyZ2V0ZGF0YS1sb2dvLWhvcml6b250YWwtY29yLXJnYi5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-05-13T14:33:23.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Documentação da API Smart 2.0","description":"API dos produtos do Smart 2.0, onde possui consultas de cobrança e antifraude, análise de crédito, compliance e patrimônio."},"logos":{"logoLight":"https://content.pstmn.io/eab81c26-f931-4589-9924-e4d0540f6ba2/dGFyZ2V0ZGF0YS1sb2dvLWhvcml6b250YWwtY29yLXJnYi5wbmc=","logoDark":"https://content.pstmn.io/e57c715a-808d-4305-99c5-04a8f9acfe09/dGFyZ2V0ZGF0YS1sb2dvLWhvcml6b250YWwtY29yLXJnYi5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/48b80089061d10bffb0fa732597ef85f474e878f24ae6e3204d313d69b30e40a","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s9YJhveyd"}