{"openapi":"3.1.0","info":{"title":"Detectin API","description":"Consulta de CPF e CNPJ para sistemas de empresas e órgãos públicos. Autentique com `Authorization: Bearer <sua chave>`.","version":"1.0.0"},"paths":{"/api/v1/status":{"get":{"tags":["API v1"],"summary":"Confere a chave e o contrato","operationId":"status_api_v1_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/uso":{"get":{"tags":["API v1"],"summary":"Uso da franquia no mês","operationId":"uso_api_v1_uso_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/consultas":{"post":{"tags":["API v1"],"summary":"Consulta um CPF ou CNPJ","operationId":"consultar_api_v1_consultas_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsultaIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["API v1"],"summary":"Lista as consultas da empresa","operationId":"listar_api_v1_consultas_get","parameters":[{"name":"pagina","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Pagina"}},{"name":"por_pagina","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Por Pagina"}},{"name":"desde","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"ISO 8601, UTC","title":"Desde"},"description":"ISO 8601, UTC"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/consultas/{consulta_id}":{"get":{"tags":["API v1"],"summary":"Recupera uma consulta já feita (sem custo)","operationId":"detalhe_api_v1_consultas__consulta_id__get","parameters":[{"name":"consulta_id","in":"path","required":true,"schema":{"type":"string","title":"Consulta Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ConsultaIn":{"properties":{"documento":{"type":"string","title":"Documento","description":"CPF ou CNPJ, com ou sem pontuação.","examples":["11.444.777/0001-61"]},"tipo":{"anyOf":[{"type":"string","enum":["cpf","cnpj"]},{"type":"null"}],"title":"Tipo","description":"Opcional: detectado pelo documento."},"idade_maxima_dias":{"anyOf":[{"type":"integer","maximum":3650.0,"minimum":1.0},{"type":"null"}],"title":"Idade Maxima Dias","description":"Se o dado guardado for mais antigo que isso, reconsulta a fonte (consome franquia)."},"incluir_bruto":{"type":"boolean","title":"Incluir Bruto","description":"Inclui o payload bruto das fontes, já redigido.","default":false}},"type":"object","required":["documento"],"title":"ConsultaIn"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"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"}}}}