{"openapi":"3.1.0","info":{"title":"PrismaData — Fronteiras","version":"1.0.0","termsOfService":"https://prismadata.io/terms","contact":{"name":"PrismaData Support Team","url":"https://prismadata.io/contact","email":"suporte.api@prismadata.io"},"license":{"name":"Proprietary","url":"https://api.prismadata.io/license"},"description":"O dado de fronteiras indica se um ponto está localizado em uma faixa de fronteira e traz algumas informações desta fronteira, como proximidade da fronteira, qual é o país mais próximo e se a mancha urbana do município que o ponto se encontra está próximo da faixa de fronteira.\n\nA faixa de fronteira, segundo o IBGE, é uma faixa de até 150 km de largura ao longo das fronteiras terrestres do Brasil, considerada importante para a defesa nacional. Essa área abrange 16,7% do território brasileiro.\n\n## Uso em PLD/FT\n\nO dado atende à avaliação de risco geográfico da Abordagem Baseada em Risco (ABR) exigida pela Circular BACEN 3.978, com três camadas de granularidade:\n\n- **Cidade gêmea**: além do indicador booleano, a resposta nomeia a cidade gêmea estrangeira e o país a que ela pertence.\n- **Tríplice fronteira**: indica se o ponto está a até 50 km de um dos quatro pontos de tríplice fronteira do Brasil, com o nome e os países envolvidos. Tríplices fronteiras são tratadas pelo GAFI/FATF como áreas de risco elevado — a do Iguaçu é citada nominalmente no Relatório de Avaliação Mútua do Brasil (2023).\n- **Arco de fronteira**: classificação do IBGE da faixa em três arcos (`NORTE`, `CENTRAL` e `SUL`), cada um com perfil socioeconômico e de risco distinto.\n\n## Índice de exposição de fronteira\n\nA resposta traz um índice determinístico de 0 a 100 (`score_exposicao_fronteira`), derivado dos demais campos, com a banda correspondente (`RESIDUAL`, `BAIXA`, `MODERADA` ou `ELEVADA`), os quatro componentes que o formam e a lista de fatores acionados.\n\nO índice agrega quatro dimensões: proximidade à linha internacional, tríplice fronteira, cidade gêmea e intensidade municipal. Quando o ponto não está em município brasileiro de fronteira, as dimensões municipais ficam nulas e os pesos são renormalizados sobre as presentes — ausência não é tratada como zero, para não subestimar pontos no exterior colados na linha.\n\nOs fatores acionados vêm de duas formas: a string `fatores_acionados`, em ordem canônica fixa e separada por `|`, para o parecer do analista; e um campo booleano por fator (`fator_*`), para filtro e modelagem sem depender de busca por substring.\n\n**Três ressalvas de uso, que fazem parte do produto:**\n\n1. O índice mede a exposição do **território**, não a pessoa. Não é score de risco de cliente e não expressa julgamento sobre quem está no endereço.\n2. É **insumo** da Abordagem Baseada em Risco da instituição e não substitui a metodologia própria exigida pela Circular BACEN 3.978.\n3. Não deve ser **fundamento único** para recusa ou encerramento de relacionamento, tanto pelo risco de discriminação territorial quanto pelo direito à revisão previsto no art. 20 da LGPD.\n\nA metodologia é versionada por semver (`versao_metodologia_score`) e versões anteriores permanecem disponíveis. Todos os parâmetros de cálculo — pesos, âncoras, limiares, bandas, regra de arredondamento e vocabulário de fatores — são publicados em `/border/metadata`, de modo que o cliente recalcule o índice e confira por igualdade exata, sem depender da API.\n\nO endpoint `/border/metadata` descreve as fontes de dados, os parâmetros de cálculo e os pontos de tríplice fronteira considerados.\n\nMaiores informações podem ser encontradas na [documentação de produto](https://prismadata.io/doc-comercial/fronteira/). Testes manuais com o fim de se compreender melhor o dado podem ser feitos [aqui](https://prismadata.io/testador-de-api/api-de-localizacao/).\n"},"servers":[{"url":"https://api.prismadata.io/v1","description":"Ambiente de Produção"}],"security":[{"X-Apikey":[]},{"api_key":[]},{"BearerAuth":[]}],"tags":[{"name":"Fronteiras","description":"O dado de fronteiras indica se um ponto está localizado em uma faixa de fronteira e traz algumas informações desta fronteira, como proximidade da fronteira, qual é o país mais próximo e se a mancha urbana do município que o ponto se encontra está próximo da faixa de fronteira.\n\nA faixa de fronteira, segundo o IBGE, é uma faixa de até 150 km de largura ao longo das fronteiras terrestres do Brasil, considerada importante para a defesa nacional. Essa área abrange 16,7% do território brasileiro.\n\n## Uso em PLD/FT\n\nO dado atende à avaliação de risco geográfico da Abordagem Baseada em Risco (ABR) exigida pela Circular BACEN 3.978, com três camadas de granularidade:\n\n- **Cidade gêmea**: além do indicador booleano, a resposta nomeia a cidade gêmea estrangeira e o país a que ela pertence.\n- **Tríplice fronteira**: indica se o ponto está a até 50 km de um dos quatro pontos de tríplice fronteira do Brasil, com o nome e os países envolvidos. Tríplices fronteiras são tratadas pelo GAFI/FATF como áreas de risco elevado — a do Iguaçu é citada nominalmente no Relatório de Avaliação Mútua do Brasil (2023).\n- **Arco de fronteira**: classificação do IBGE da faixa em três arcos (`NORTE`, `CENTRAL` e `SUL`), cada um com perfil socioeconômico e de risco distinto.\n\n## Índice de exposição de fronteira\n\nA resposta traz um índice determinístico de 0 a 100 (`score_exposicao_fronteira`), derivado dos demais campos, com a banda correspondente (`RESIDUAL`, `BAIXA`, `MODERADA` ou `ELEVADA`), os quatro componentes que o formam e a lista de fatores acionados.\n\nO índice agrega quatro dimensões: proximidade à linha internacional, tríplice fronteira, cidade gêmea e intensidade municipal. Quando o ponto não está em município brasileiro de fronteira, as dimensões municipais ficam nulas e os pesos são renormalizados sobre as presentes — ausência não é tratada como zero, para não subestimar pontos no exterior colados na linha.\n\nOs fatores acionados vêm de duas formas: a string `fatores_acionados`, em ordem canônica fixa e separada por `|`, para o parecer do analista; e um campo booleano por fator (`fator_*`), para filtro e modelagem sem depender de busca por substring.\n\n**Três ressalvas de uso, que fazem parte do produto:**\n\n1. O índice mede a exposição do **território**, não a pessoa. Não é score de risco de cliente e não expressa julgamento sobre quem está no endereço.\n2. É **insumo** da Abordagem Baseada em Risco da instituição e não substitui a metodologia própria exigida pela Circular BACEN 3.978.\n3. Não deve ser **fundamento único** para recusa ou encerramento de relacionamento, tanto pelo risco de discriminação territorial quanto pelo direito à revisão previsto no art. 20 da LGPD.\n\nA metodologia é versionada por semver (`versao_metodologia_score`) e versões anteriores permanecem disponíveis. Todos os parâmetros de cálculo — pesos, âncoras, limiares, bandas, regra de arredondamento e vocabulário de fatores — são publicados em `/border/metadata`, de modo que o cliente recalcule o índice e confira por igualdade exata, sem depender da API.\n\nO endpoint `/border/metadata` descreve as fontes de dados, os parâmetros de cálculo e os pontos de tríplice fronteira considerados.\n\nMaiores informações podem ser encontradas na [documentação de produto](https://prismadata.io/doc-comercial/fronteira/). Testes manuais com o fim de se compreender melhor o dado podem ser feitos [aqui](https://prismadata.io/testador-de-api/api-de-localizacao/).\n"}],"paths":{"/location/batch/border":{"post":{"tags":["Fronteiras"],"summary":"Proximidade às fronteiras em lote","description":"Consulta em lote a proximidade às fronteiras terrestres brasileiras, com as\nmesmas informações da consulta por ponto para até 1024 coordenadas. A\ncobrança é feita por coordenada do lote.","operationId":"border_batch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/BorderResponse"},"type":"object","title":"BorderResponseBatch","description":"Dicionário onde as chaves são identificadores únicos para cada ponto consultado"},"example":{"foz_do_iguacu":{"prismadata__border__area_municipio_integrada_faixa_de_fronteira_km2":609.19,"prismadata__border__area_total_municipio_km2":609.19,"prismadata__border__distancia_geodesica_pais_mais_proximo_pt_km":0.759,"prismadata__border__distancia_geodesica_pais_mais_proximo_sede_municipio_km":1.014,"prismadata__border__distancia_geodesica_ponto_borda_faixa_de_fronteira_km":0.0,"prismadata__border__municipio_possui_cidade_gemea":true,"prismadata__border__nome_municipio_de_fronteira":"Foz do Iguaçu","prismadata__border__pais_mais_proximo":"PARAGUAI","prismadata__border__pais_mais_proximo_pt":"PARAGUAI","prismadata__border__ponto_contido_na_faixa_de_fronteira":true,"prismadata__border__frac_area_municipio_faixa_de_fronteira":1.0,"prismadata__border__sede_municipio_dentro_da_faixa_de_fronteira":true,"prismadata__border__nome_cidade_gemea_estrangeira":"Ciudad del Este","prismadata__border__pais_cidade_gemea":"PARAGUAI","prismadata__border__segundo_pais_mais_proximo_pt":"ARGENTINA","prismadata__border__distancia_geodesica_segundo_pais_km":5.3,"prismadata__border__ponto_em_area_triplice_fronteira":true,"prismadata__border__distancia_triplice_fronteira_km":7.75,"prismadata__border__nome_triplice_fronteira":"Tríplice Fronteira do Iguaçu","prismadata__border__paises_triplice_fronteira":"ARGENTINA/BRASIL/PARAGUAI","prismadata__border__arco_fronteira":"SUL","prismadata__border__score_exposicao_fronteira":98,"prismadata__border__classificacao_exposicao_fronteira":"ELEVADA","prismadata__border__versao_metodologia_score":"1.0.0","prismadata__border__piso_aplicado":null,"prismadata__border__score_componente_proximidade_internacional":94,"prismadata__border__score_componente_triplice_fronteira":100,"prismadata__border__score_componente_cidade_gemea":100,"prismadata__border__score_componente_intensidade_municipal":100,"prismadata__border__qtd_fatores_acionados":6,"prismadata__border__fatores_acionados":"PONTO_NA_FAIXA|AREA_INFLUENCIA_TRIPLICE|TRIPLICE_IGUACU|CIDADE_GEMEA|MUNICIPIO_INTEGRALMENTE_NA_FAIXA|SEDE_NA_FAIXA","prismadata__border__fator_ponto_fora_do_territorio_nacional":false,"prismadata__border__fator_ponto_na_faixa":true,"prismadata__border__fator_area_influencia_triplice":true,"prismadata__border__fator_triplice_iguacu":true,"prismadata__border__fator_cidade_gemea":true,"prismadata__border__fator_municipio_integralmente_na_faixa":true,"prismadata__border__fator_sede_na_faixa":true},"sao_paulo":{"prismadata__border__area_municipio_integrada_faixa_de_fronteira_km2":null,"prismadata__border__area_total_municipio_km2":null,"prismadata__border__distancia_geodesica_pais_mais_proximo_pt_km":766.867,"prismadata__border__distancia_geodesica_pais_mais_proximo_sede_municipio_km":null,"prismadata__border__distancia_geodesica_ponto_borda_faixa_de_fronteira_km":614.993,"prismadata__border__municipio_possui_cidade_gemea":null,"prismadata__border__nome_municipio_de_fronteira":null,"prismadata__border__pais_mais_proximo":null,"prismadata__border__pais_mais_proximo_pt":"ARGENTINA","prismadata__border__ponto_contido_na_faixa_de_fronteira":false,"prismadata__border__frac_area_municipio_faixa_de_fronteira":null,"prismadata__border__sede_municipio_dentro_da_faixa_de_fronteira":null,"prismadata__border__nome_cidade_gemea_estrangeira":null,"prismadata__border__pais_cidade_gemea":null,"prismadata__border__segundo_pais_mais_proximo_pt":"PARAGUAI","prismadata__border__distancia_geodesica_segundo_pais_km":781.2,"prismadata__border__ponto_em_area_triplice_fronteira":false,"prismadata__border__distancia_triplice_fronteira_km":null,"prismadata__border__nome_triplice_fronteira":null,"prismadata__border__paises_triplice_fronteira":null,"prismadata__border__arco_fronteira":null,"prismadata__border__score_exposicao_fronteira":0,"prismadata__border__classificacao_exposicao_fronteira":"RESIDUAL","prismadata__border__versao_metodologia_score":"1.0.0","prismadata__border__piso_aplicado":null,"prismadata__border__score_componente_proximidade_internacional":0,"prismadata__border__score_componente_triplice_fronteira":0,"prismadata__border__score_componente_cidade_gemea":null,"prismadata__border__score_componente_intensidade_municipal":null,"prismadata__border__qtd_fatores_acionados":0,"prismadata__border__fatores_acionados":"","prismadata__border__fator_ponto_fora_do_territorio_nacional":false,"prismadata__border__fator_ponto_na_faixa":false,"prismadata__border__fator_area_influencia_triplice":false,"prismadata__border__fator_triplice_iguacu":false,"prismadata__border__fator_cidade_gemea":false,"prismadata__border__fator_municipio_integralmente_na_faixa":false,"prismadata__border__fator_sede_na_faixa":false}}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Unauthorized - Missing or invalid API key (X-Apikey header or api_key query parameter)","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"403":{"description":"Forbidden - Missing privileges to retrieve data","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"422":{"description":"Validation Error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"$ref":"#/components/responses/RateLimitExceeded"}},"x-codeSamples":[{"lang":"curl","source":"curl -X POST \"https://api.prismadata.io/v1/location/batch/border\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"1\": [-23.55, -46.63], \"2\": [-22.90, -43.17]}'"},{"lang":"Python","source":"import httpx\n\nresp = httpx.post(\n    \"https://api.prismadata.io/v1/location/batch/border\",\n    json={\"1\": [-23.55, -46.63], \"2\": [-22.90, -43.17]},\n    headers={\"X-Apikey\": \"ak_xxxxxxxxxxxxxxxx\"},\n)\ndados = resp.json()"},{"lang":"Python SDK","source":"from prismadata import Client\n\nclient = Client(api_key=\"ak_xxxxxxxxxxxxxxxx\")\nresult = client.border_batch(points={\n    \"p1\": [-23.55, -46.63],\n    \"p2\": [-22.90, -43.17],\n})\nprint(result)"},{"lang":"TypeScript SDK","source":"import { PrismaDataClient } from \"prismadata\";\n\nconst client = new PrismaDataClient({ apiKey: \"ak_xxxxxxxxxxxxxxxx\" });\nconst result = await client.borderBatch({\n  p1: [-23.55, -46.63],\n  p2: [-22.90, -43.17],\n});\nconsole.log(result);"}]}},"/location/border":{"get":{"tags":["Fronteiras"],"summary":"Proximidade de um ponto às fronteiras do Brasil","description":"Consulta a proximidade de um ponto às fronteiras terrestres brasileiras.\nIndica se o ponto está na faixa de fronteira, o município de fronteira, o\npaís estrangeiro mais próximo, a cidade gêmea, a tríplice fronteira mais\npróxima e o índice de exposição geográfica de fronteira.","operationId":"border_query","parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number","exclusiveMaximum":90,"exclusiveMinimum":-90,"description":"Latitude do ponto de\n                   consulta.","title":"Lat"},"description":"Latitude do ponto de\n                   consulta.","example":-25.52568655357868},{"name":"lng","in":"query","required":true,"schema":{"type":"number","exclusiveMaximum":180,"exclusiveMinimum":-180,"description":"Longitude do ponto de consulta.","title":"Lng"},"description":"Longitude do ponto de consulta.","example":-54.59273323017718}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BorderResponse"},"example":{"prismadata__border__area_municipio_integrada_faixa_de_fronteira_km2":609.19,"prismadata__border__area_total_municipio_km2":609.19,"prismadata__border__distancia_geodesica_pais_mais_proximo_pt_km":0.759,"prismadata__border__distancia_geodesica_pais_mais_proximo_sede_municipio_km":1.014,"prismadata__border__distancia_geodesica_ponto_borda_faixa_de_fronteira_km":0.0,"prismadata__border__municipio_possui_cidade_gemea":true,"prismadata__border__nome_municipio_de_fronteira":"Foz do Iguaçu","prismadata__border__pais_mais_proximo":"PARAGUAI","prismadata__border__pais_mais_proximo_pt":"PARAGUAI","prismadata__border__ponto_contido_na_faixa_de_fronteira":true,"prismadata__border__frac_area_municipio_faixa_de_fronteira":1.0,"prismadata__border__sede_municipio_dentro_da_faixa_de_fronteira":true,"prismadata__border__nome_cidade_gemea_estrangeira":"Ciudad del Este","prismadata__border__pais_cidade_gemea":"PARAGUAI","prismadata__border__segundo_pais_mais_proximo_pt":"ARGENTINA","prismadata__border__distancia_geodesica_segundo_pais_km":5.3,"prismadata__border__ponto_em_area_triplice_fronteira":true,"prismadata__border__distancia_triplice_fronteira_km":7.75,"prismadata__border__nome_triplice_fronteira":"Tríplice Fronteira do Iguaçu","prismadata__border__paises_triplice_fronteira":"ARGENTINA/BRASIL/PARAGUAI","prismadata__border__arco_fronteira":"SUL","prismadata__border__score_exposicao_fronteira":98,"prismadata__border__classificacao_exposicao_fronteira":"ELEVADA","prismadata__border__versao_metodologia_score":"1.0.0","prismadata__border__piso_aplicado":null,"prismadata__border__score_componente_proximidade_internacional":94,"prismadata__border__score_componente_triplice_fronteira":100,"prismadata__border__score_componente_cidade_gemea":100,"prismadata__border__score_componente_intensidade_municipal":100,"prismadata__border__qtd_fatores_acionados":6,"prismadata__border__fatores_acionados":"PONTO_NA_FAIXA|AREA_INFLUENCIA_TRIPLICE|TRIPLICE_IGUACU|CIDADE_GEMEA|MUNICIPIO_INTEGRALMENTE_NA_FAIXA|SEDE_NA_FAIXA","prismadata__border__fator_ponto_fora_do_territorio_nacional":false,"prismadata__border__fator_ponto_na_faixa":true,"prismadata__border__fator_area_influencia_triplice":true,"prismadata__border__fator_triplice_iguacu":true,"prismadata__border__fator_cidade_gemea":true,"prismadata__border__fator_municipio_integralmente_na_faixa":true,"prismadata__border__fator_sede_na_faixa":true}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Unauthorized - Missing or invalid API key (X-Apikey header or api_key query parameter)","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"403":{"description":"Forbidden - Missing privileges to retrieve data","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"422":{"description":"Validation Error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"$ref":"#/components/responses/RateLimitExceeded"}},"x-codeSamples":[{"lang":"curl","source":"curl \"https://api.prismadata.io/v1/location/border?lat=-25.52568655357868&lng=-54.59273323017718\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\""},{"lang":"Python","source":"import httpx\n\nresp = httpx.get(\n    \"https://api.prismadata.io/v1/location/border\",\n    params={\"lat\": -25.52568655357868, \"lng\": -54.59273323017718},\n    headers={\"X-Apikey\": \"ak_xxxxxxxxxxxxxxxx\"},\n)\ndados = resp.json()"},{"lang":"Python SDK","source":"from prismadata import Client\n\nclient = Client(api_key=\"ak_xxxxxxxxxxxxxxxx\")\nresult = client.border(lat=-23.55, lng=-46.63)\nprint(result)\n\n# Tríplice fronteira (Foz do Iguaçu → dentro do raio de 50 km)\nr = client.border(lat=-25.5478, lng=-54.5882)\nif r[\"prismadata__border__ponto_em_area_triplice_fronteira\"]:\n    print(\n        r[\"prismadata__border__nome_triplice_fronteira\"],       # \"Tríplice Fronteira do Iguaçu\"\n        r[\"prismadata__border__paises_triplice_fronteira\"],     # \"ARGENTINA/BRASIL/PARAGUAI\"\n        r[\"prismadata__border__distancia_triplice_fronteira_km\"],\n    )\n\n# Score de exposicao a fronteira (metodologia 1.0.0)\n# Indice deterministico 0-100 com 4 componentes ponderados e 7 fatores\nprint(r[\"prismadata__border__score_exposicao_fronteira\"])        # 0..100\nprint(r[\"prismadata__border__classificacao_exposicao_fronteira\"]) # RESIDUAL/BAIXA/MODERADA/ELEVADA\nprint(r[\"prismadata__border__fatores_acionados\"])                # \"PONTO_NA_FAIXA|CIDADE_GEMEA|...\"\nprint(r[\"prismadata__border__piso_aplicado\"])                    # None ou \"TRIPLICE_FRONTEIRA_GAFI\""},{"lang":"R SDK","source":"library(prismadata)\n\nclient <- prismadata_client(api_key = \"ak_xxxxxxxxxxxxxxxx\")\nresult <- client$border(lat = -23.55, lng = -46.63)\nprint(result)"},{"lang":"TypeScript SDK","source":"import { PrismaDataClient } from \"prismadata\";\n\nconst client = new PrismaDataClient({ apiKey: \"ak_xxxxxxxxxxxxxxxx\" });\nconst result = await client.border(-23.55, -46.63);\nconsole.log(result);"}]}},"/location/border/metadata":{"get":{"tags":["Fronteiras"],"summary":"Fontes e parâmetros do produto Fronteiras","description":"Descreve as fontes de dados, os parâmetros de cálculo e os pontos de\ntríplice fronteira usados na composição da resposta da API.","operationId":"border_metadata","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"BorderMetadataResponse","description":"Fontes de dados, parâmetros de cálculo e pontos de tríplice fronteira usados na composição da resposta."},"example":{"prismadata__border__fontes":[{"NOME":"Faixa de Fronteira e Municípios da Faixa de Fronteira","ORGAO":"IBGE","ANO_REFERENCIA":2022,"URL":"https://www.ibge.gov.br/geociencias/organizacao-do-territorio/estrutura-territorial.html","CAMPOS":["prismadata__border__nome_municipio_de_fronteira","prismadata__border__area_total_municipio_km2","prismadata__border__area_municipio_integrada_faixa_de_fronteira_km2","prismadata__border__frac_area_municipio_faixa_de_fronteira","prismadata__border__sede_municipio_dentro_da_faixa_de_fronteira","prismadata__border__ponto_contido_na_faixa_de_fronteira","prismadata__border__distancia_geodesica_ponto_borda_faixa_de_fronteira_km"]},{"NOME":"Cidades Gêmeas da Faixa de Fronteira","ORGAO":"Ministério da Integração e do Desenvolvimento Regional","ANO_REFERENCIA":2022,"URL":"https://www.gov.br/mdr/pt-br/assuntos/desenvolvimento-regional/fronteiras/cidades-gemeas","CAMPOS":["prismadata__border__municipio_possui_cidade_gemea","prismadata__border__nome_cidade_gemea_estrangeira","prismadata__border__pais_cidade_gemea"]},{"NOME":"Limites internacionais (GEOFT_PAIS)","ORGAO":"IBGE","ANO_REFERENCIA":2022,"URL":"https://www.ibge.gov.br/geociencias/downloads-geociencias.html","CAMPOS":["prismadata__border__pais_mais_proximo","prismadata__border__pais_mais_proximo_pt","prismadata__border__distancia_geodesica_pais_mais_proximo_pt_km","prismadata__border__distancia_geodesica_pais_mais_proximo_sede_municipio_km","prismadata__border__segundo_pais_mais_proximo_pt","prismadata__border__distancia_geodesica_segundo_pais_km"]},{"NOME":"Arcos da Faixa de Fronteira (Norte, Central e Sul)","ORGAO":"IBGE","ANO_REFERENCIA":2022,"URL":"https://www.ibge.gov.br/geociencias/organizacao-do-territorio/estrutura-territorial.html","CAMPOS":["prismadata__border__arco_fronteira"]},{"NOME":"Pontos de Tríplice Fronteira do Brasil","ORGAO":"PrismaData (confluências fluviais de referência)","ANO_REFERENCIA":2023,"URL":"https://www.fatf-gafi.org/en/publications/Mutualevaluations/Mer-brazil-2023.html","OBSERVACAO":"Tríplices fronteiras são tratadas pelo GAFI/FATF como áreas de risco elevado para PLD/FT. A do Iguaçu é citada nominalmente no Relatório de Avaliação Mútua do Brasil (2023).","CAMPOS":["prismadata__border__ponto_em_area_triplice_fronteira","prismadata__border__distancia_triplice_fronteira_km","prismadata__border__nome_triplice_fronteira","prismadata__border__paises_triplice_fronteira"]}],"prismadata__border__parametros":{"LARGURA_FAIXA_DE_FRONTEIRA_KM":150,"RAIO_AREA_TRIPLICE_FRONTEIRA_KM":50.0,"ALCANCE_MAXIMO_TRIPLICE_FRONTEIRA_KM":500.0,"ELIPSOIDE_DISTANCIAS_GEODESICAS":"WGS84"},"prismadata__border__pontos_triplice_fronteira":[{"NOME":"Tríplice Fronteira do Iguaçu","LAT":-25.5955,"LNG":-54.588,"PAISES":"ARGENTINA/BRASIL/PARAGUAI"},{"NOME":"Tríplice Fronteira de Barra do Quaraí","LAT":-30.2107,"LNG":-57.5519,"PAISES":"ARGENTINA/BRASIL/URUGUAI"},{"NOME":"Tríplice Fronteira de Assis Brasil","LAT":-10.9441,"LNG":-69.5697,"PAISES":"BOLIVIA/BRASIL/PERU"},{"NOME":"Tríplice Fronteira de Tabatinga","LAT":-4.2356,"LNG":-69.9387,"PAISES":"BRASIL/COLOMBIA/PERU"}],"prismadata__border__score":{"VERSAO_METODOLOGIA":"1.0.0","PESOS":{"D1_PROXIMIDADE_INTERNACIONAL":0.35,"D2_TRIPLICE_FRONTEIRA":0.3,"D3_CIDADE_GEMEA":0.2,"D4_INTENSIDADE_MUNICIPAL":0.15},"D0_KM":2.0,"ANCORAS_D1":[{"DISTANCIA_KM":0.0,"VALOR":100.0},{"DISTANCIA_KM":150.0,"VALOR":25.0},{"DISTANCIA_KM":500.0,"VALOR":0.0}],"LIMIAR_TRIPLICE_KM":50.0,"ALCANCE_TRIPLICE_KM":500.0,"VALOR_D2_IGUACU":100.0,"VALOR_D2_DEMAIS":85.0,"PISO_TRIPLICE":70,"BANDAS":[{"LIMITE_INFERIOR":0,"LIMITE_SUPERIOR":19,"ROTULO":"RESIDUAL"},{"LIMITE_INFERIOR":20,"LIMITE_SUPERIOR":44,"ROTULO":"BAIXA"},{"LIMITE_INFERIOR":45,"LIMITE_SUPERIOR":69,"ROTULO":"MODERADA"},{"LIMITE_INFERIOR":70,"LIMITE_SUPERIOR":100,"ROTULO":"ELEVADA"}],"REGRA_ARREDONDAMENTO":"HALF_UP","REGRA_AGREGACAO":"Média ponderada renormalizada sobre as dimensões não nulas, calculada sobre os componentes já arredondados para inteiro.","SEPARADOR_FATORES":"|","VOCABULARIO_FATORES":["PONTO_FORA_DO_TERRITORIO_NACIONAL","PONTO_NA_FAIXA","AREA_INFLUENCIA_TRIPLICE","TRIPLICE_IGUACU","CIDADE_GEMEA","MUNICIPIO_INTEGRALMENTE_NA_FAIXA","SEDE_NA_FAIXA"]}}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Unauthorized - Missing or invalid API key (X-Apikey header or api_key query parameter)","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"403":{"description":"Forbidden - Missing privileges to retrieve data","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"429":{"$ref":"#/components/responses/RateLimitExceeded"}},"x-codeSamples":[{"lang":"curl","source":"curl \"https://api.prismadata.io/v1/location/border/metadata\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\""},{"lang":"Python","source":"import httpx\n\nresp = httpx.get(\n    \"https://api.prismadata.io/v1/location/border/metadata\",\n    headers={\"X-Apikey\": \"ak_xxxxxxxxxxxxxxxx\"},\n)\ndados = resp.json()"},{"lang":"Python SDK","source":"from prismadata import Client\n\nclient = Client(api_key=\"ak_xxxxxxxxxxxxxxxx\")\nmeta = client.border_metadata()\nparams = meta[\"prismadata__border__parametros\"]\nprint(params[\"RAIO_AREA_TRIPLICE_FRONTEIRA_KM\"])   # ex: 50.0\nprint(len(meta[\"prismadata__border__pontos_triplice_fronteira\"]))\n\n# Metodologia do score (v0.17+): pesos, ancoras, limiares\nscore_meta = meta[\"prismadata__border__score\"]\nprint(score_meta[\"VERSAO_METODOLOGIA\"])            # \"1.0.0\"\nprint(score_meta[\"PESOS\"])                         # {\"D1_...\": 0.35, ...}"}]}}},"components":{"securitySchemes":{"X-Apikey":{"type":"apiKey","in":"header","name":"X-Apikey","description":"Token de acesso via header."},"api_key":{"type":"apiKey","in":"query","name":"api_key","description":"Token de acesso via query parameter."},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT obtido via POST /auth/token"}},"headers":{"X-RateLimit-Limit":{"description":"Número máximo de requisições permitidas por minuto para o usuário.","schema":{"type":"integer","example":60}},"X-RateLimit-Remaining":{"description":"Número de requisições restantes na janela de rate limit atual.","schema":{"type":"integer","example":57}},"X-RateLimit-Reset":{"description":"Unix timestamp (segundos) indicando quando a janela de rate limit será reiniciada.","schema":{"type":"integer","example":1738281600}}},"responses":{"RateLimitExceeded":{"description":"Too Many Requests - Rate limit ou quota excedidos.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"text/plain":{"schema":{"type":"string"},"examples":{"rate_limit":{"summary":"Rate limit excedido","value":"rate limit exceeded"},"quota":{"summary":"Quota excedida","value":"limit exceeded: 1000 requests used, limit is 1000"}}}}}},"schemas":{"BorderResponse":{"description":"Atributos do produto de Faixa de Fronteira, prefixados com `prismadata__border__`. Cobrem três níveis de leitura: o ponto consultado, o município de fronteira que o contém e a sede desse município. Campos não aplicáveis são retornados como `null`, nunca omitidos.","properties":{"prismadata__border__area_municipio_integrada_faixa_de_fronteira_km2":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"tamanho da área em quilômetros quadrados do municipio que coincide com a faixa de fronteira.","title":"Prismadata  Border  Area Municipio Integrada Faixa De Fronteira Km2"},"prismadata__border__area_total_municipio_km2":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"tamanho total da área do município.","title":"Prismadata  Border  Area Total Municipio Km2"},"prismadata__border__distancia_geodesica_pais_mais_proximo_pt_km":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"a distância em quilômetros do ponto em análise até o país estrangeiro mais proximo.","title":"Prismadata  Border  Distancia Geodesica Pais Mais Proximo Pt Km"},"prismadata__border__distancia_geodesica_pais_mais_proximo_sede_municipio_km":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"distância em quilômetros do ponto até a sede do município de fronteira. A sede do município é o marco zero do município, o ponto do qual o município iniciou o seu crescimento. Em geral é a prefeitura, praça principal ou igreja matriz do município.","title":"Prismadata  Border  Distancia Geodesica Pais Mais Proximo Sede Municipio Km"},"prismadata__border__distancia_geodesica_ponto_borda_faixa_de_fronteira_km":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"distância em quilômetros do ponto até a borda da geometria de fronteira definida pelo IBGE.","title":"Prismadata  Border  Distancia Geodesica Ponto Borda Faixa De Fronteira Km"},"prismadata__border__municipio_possui_cidade_gemea":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"indica se o município em que o ponto se encontra possui uma cidade gêmea em outro pais. Duas cidades são consideradas gêmeas quando as manchas urbanas delas são muito próximas apesar delas estarem em países distintos","title":"Prismadata  Border  Municipio Possui Cidade Gemea"},"prismadata__border__nome_municipio_de_fronteira":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"nome do município de fronteira em que o ponto se encontra.","title":"Prismadata  Border  Nome Municipio De Fronteira"},"prismadata__border__pais_mais_proximo":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"nome do pais mais próximo ao município de fronteira em que o ponto se encontra.","title":"Prismadata  Border  Pais Mais Proximo"},"prismadata__border__pais_mais_proximo_pt":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"nome do pais de fronteira mais próximo ao ponto propriamente dito.","title":"Prismadata  Border  Pais Mais Proximo Pt"},"prismadata__border__ponto_contido_na_faixa_de_fronteira":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"indica se o ponto está contido na faixa de fronteira.","title":"Prismadata  Border  Ponto Contido Na Faixa De Fronteira"},"prismadata__border__frac_area_municipio_faixa_de_fronteira":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"fração da área do município em que o ponto se encontra que está dentro da área de fronteira. Valor em [0,1] (ex.: 0.325 = 32,5%).","title":"Prismadata  Border  Frac Area Municipio Faixa De Fronteira"},"prismadata__border__sede_municipio_dentro_da_faixa_de_fronteira":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"indica se a sede do município, que é o marco zero do município, se encontra dentro da faixa de fronteira.","title":"Prismadata  Border  Sede Municipio Dentro Da Faixa De Fronteira"},"prismadata__border__nome_cidade_gemea_estrangeira":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"nome da cidade gêmea estrangeira do município em que o ponto se encontra. Nulo quando o município não possui cidade gêmea ou quando o ponto não está em município de fronteira.","title":"Prismadata  Border  Nome Cidade Gemea Estrangeira"},"prismadata__border__pais_cidade_gemea":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"país da cidade gêmea estrangeira. Segue a mesma nomenclatura de `pais_mais_proximo_pt`.","title":"Prismadata  Border  Pais Cidade Gemea"},"prismadata__border__segundo_pais_mais_proximo_pt":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"nome do segundo país estrangeiro mais próximo ao ponto. Relevante em tríplices fronteiras, onde dois países estão a distâncias comparáveis.","title":"Prismadata  Border  Segundo Pais Mais Proximo Pt"},"prismadata__border__distancia_geodesica_segundo_pais_km":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"distância em quilômetros do ponto até o segundo país estrangeiro mais próximo.","title":"Prismadata  Border  Distancia Geodesica Segundo Pais Km"},"prismadata__border__ponto_em_area_triplice_fronteira":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"indica se o ponto está a até 50 km de um ponto de tríplice fronteira. Tríplices fronteiras são tratadas pelo GAFI/FATF como áreas de risco elevado para PLD/FT.","title":"Prismadata  Border  Ponto Em Area Triplice Fronteira"},"prismadata__border__distancia_triplice_fronteira_km":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"distância geodésica em quilômetros até a tríplice fronteira mais próxima. Nulo quando essa distância supera 500 km.","title":"Prismadata  Border  Distancia Triplice Fronteira Km"},"prismadata__border__nome_triplice_fronteira":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"nome da tríplice fronteira mais próxima ao ponto. Nulo quando a distância supera 500 km.","title":"Prismadata  Border  Nome Triplice Fronteira"},"prismadata__border__paises_triplice_fronteira":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"países que formam a tríplice fronteira mais próxima ao ponto, em ordem alfabética e separados por `/` (ex.: `ARGENTINA/BRASIL/PARAGUAI`). Nulo quando a distância supera 500 km.","title":"Prismadata  Border  Paises Triplice Fronteira"},"prismadata__border__arco_fronteira":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"arco da faixa de fronteira, conforme classificação do IBGE por UF: `NORTE`, `CENTRAL` ou `SUL`. Nulo quando o ponto não está em município de fronteira.","title":"Prismadata  Border  Arco Fronteira"},"prismadata__border__score_exposicao_fronteira":{"description":"índice determinístico de exposição geográfica à fronteira, de 0 a 100, derivado dos demais campos desta resposta. Três ressalvas de uso: (1) mede a exposição do território, não a pessoa — não é score de risco de cliente e não expressa julgamento sobre quem está no endereço; (2) é insumo da Abordagem Baseada em Risco da instituição e não substitui a metodologia própria exigida pela Circular BACEN 3.978; (3) não deve ser fundamento único para recusa ou encerramento de relacionamento, tanto pelo risco de discriminação territorial quanto pelo direito à revisão do art. 20 da LGPD. Os parâmetros de cálculo estão em `/border/metadata`.","maximum":100,"minimum":0,"title":"Prismadata  Border  Score Exposicao Fronteira","type":"integer"},"prismadata__border__classificacao_exposicao_fronteira":{"description":"banda do índice: `RESIDUAL` (0-19), `BAIXA` (20-44), `MODERADA` (45-69) ou `ELEVADA` (70-100).","title":"Prismadata  Border  Classificacao Exposicao Fronteira","type":"string"},"prismadata__border__versao_metodologia_score":{"description":"versão semver da metodologia usada no cálculo. Versões anteriores permanecem disponíveis e documentadas em `/border/metadata`.","title":"Prismadata  Border  Versao Metodologia Score","type":"string"},"prismadata__border__score_componente_proximidade_internacional":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"componente D1: proximidade à linha internacional, em escala logarítmica ancorada em 100 na linha, 25 na borda da faixa e 0 a partir de 500 km.","title":"Prismadata  Border  Score Componente Proximidade Internacional"},"prismadata__border__score_componente_triplice_fronteira":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"componente D2: proximidade a ponto de tríplice fronteira. Vale 100 no Iguaçu, única citada nominalmente no relatório do GAFI/FATF sobre o Brasil (2023), e 85 nas demais.","title":"Prismadata  Border  Score Componente Triplice Fronteira"},"prismadata__border__score_componente_cidade_gemea":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"componente D3: 100 se o município possui cidade gêmea, 0 se não. Nulo fora de município de fronteira.","title":"Prismadata  Border  Score Componente Cidade Gemea"},"prismadata__border__score_componente_intensidade_municipal":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"componente D4: combina a fração da área do município dentro da faixa com a presença da sede na faixa. Nulo fora de município de fronteira.","title":"Prismadata  Border  Score Componente Intensidade Municipal"},"prismadata__border__qtd_fatores_acionados":{"description":"quantidade de fatores acionados para o ponto.","title":"Prismadata  Border  Qtd Fatores Acionados","type":"integer"},"prismadata__border__fatores_acionados":{"description":"fatores acionados, em ordem canônica fixa, separados por `|`. String vazia quando nenhum fator é acionado. Para filtro e modelagem, prefira os campos booleanos `fator_*`.","title":"Prismadata  Border  Fatores Acionados","type":"string"},"prismadata__border__fator_ponto_fora_do_territorio_nacional":{"description":"o ponto está fora do território nacional. É informação de jurisdição e não entra no cálculo do índice.","title":"Prismadata  Border  Fator Ponto Fora Do Territorio Nacional","type":"boolean"},"prismadata__border__fator_ponto_na_faixa":{"description":"o ponto está dentro da faixa de fronteira de 150 km.","title":"Prismadata  Border  Fator Ponto Na Faixa","type":"boolean"},"prismadata__border__fator_area_influencia_triplice":{"description":"o ponto está a até 50 km de um ponto de tríplice fronteira.","title":"Prismadata  Border  Fator Area Influencia Triplice","type":"boolean"},"prismadata__border__fator_triplice_iguacu":{"description":"o ponto está na área de influência da Tríplice Fronteira do Iguaçu.","title":"Prismadata  Border  Fator Triplice Iguacu","type":"boolean"},"prismadata__border__fator_cidade_gemea":{"description":"o município do ponto possui cidade gêmea no país vizinho.","title":"Prismadata  Border  Fator Cidade Gemea","type":"boolean"},"prismadata__border__fator_municipio_integralmente_na_faixa":{"description":"a área do município está inteiramente dentro da faixa de fronteira.","title":"Prismadata  Border  Fator Municipio Integralmente Na Faixa","type":"boolean"},"prismadata__border__fator_sede_na_faixa":{"description":"a sede do município está dentro da faixa de fronteira.","title":"Prismadata  Border  Fator Sede Na Faixa","type":"boolean"},"prismadata__border__piso_aplicado":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"rótulo do piso regulatório aplicado, quando ele elevou o índice. `TRIPLICE_FRONTEIRA_GAFI` em áreas de tríplice fronteira. Nulo quando nenhum piso atuou.","title":"Prismadata  Border  Piso Aplicado"}},"required":["prismadata__border__score_exposicao_fronteira","prismadata__border__classificacao_exposicao_fronteira","prismadata__border__versao_metodologia_score","prismadata__border__qtd_fatores_acionados","prismadata__border__fatores_acionados","prismadata__border__fator_ponto_fora_do_territorio_nacional","prismadata__border__fator_ponto_na_faixa","prismadata__border__fator_area_influencia_triplice","prismadata__border__fator_triplice_iguacu","prismadata__border__fator_cidade_gemea","prismadata__border__fator_municipio_integralmente_na_faixa","prismadata__border__fator_sede_na_faixa"],"title":"BorderResponse","type":"object"},"Coordinates":{"items":{"type":"number"},"type":"array","maxItems":2,"minItems":2,"title":"Coordinates","description":"Encapsula as coordenadas geográficas","example":[-23.5505,-46.6333]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"LocationDict":{"additionalProperties":{"$ref":"#/components/schemas/Coordinates"},"type":"object","maxProperties":1024,"title":"LocationDict","description":"Modelo da entrada em batch","example":{"point1":[-23.5505,-46.6333],"point2":[40.7128,-74.006]}},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}