{"openapi":"3.1.0","info":{"title":"DGII RNC API","description":"API profesional para consulta, validación y analítica del Registro Nacional de Contribuyentes y cédulas de República Dominicana, con datos indexados desde fuentes públicas de DGII y acceso gobernado por API key para integraciones.","version":"2.4.4"},"paths":{"/api/v1/health":{"get":{"tags":["Health"],"summary":"Health","operationId":"health_api_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/rnc/search":{"get":{"tags":["RNC / Cédula"],"summary":"Search Rnc","operationId":"search_rnc_api_v1_rnc_search_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"title":"Q"}},{"name":"field","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Field"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxpayerSearchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/rnc/statistics":{"get":{"tags":["RNC / Cédula"],"summary":"Taxpayer Statistics","operationId":"taxpayer_statistics_api_v1_rnc_statistics_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxpayerStatisticsResponse"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/rnc/{document_number}":{"get":{"tags":["RNC / Cédula"],"summary":"Lookup Rnc","operationId":"lookup_rnc_api_v1_rnc__document_number__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"document_number","in":"path","required":true,"schema":{"type":"string","title":"Document Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxpayerResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/rnc/lookup":{"post":{"tags":["RNC / Cédula"],"summary":"Lookup Rnc Post","operationId":"lookup_rnc_post_api_v1_rnc_lookup_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxpayerLookupRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxpayerResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/sync/stage-zip":{"post":{"tags":["Sincronización"],"summary":"Stage Zip","operationId":"stage_zip_api_v1_sync_stage_zip_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"clear_existing","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Clear Existing"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncActionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sync/process-staging":{"post":{"tags":["Sincronización"],"summary":"Process Staging","operationId":"process_staging_api_v1_sync_process_staging_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"batch_size","in":"query","required":false,"schema":{"type":"integer","maximum":50000,"minimum":1,"default":1000,"title":"Batch Size"}},{"name":"max_batches","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Max Batches"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncActionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sync/full":{"post":{"tags":["Sincronización"],"summary":"Full Sync","operationId":"full_sync_api_v1_sync_full_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"clear_existing","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Clear Existing"}},{"name":"batch_size","in":"query","required":false,"schema":{"type":"integer","maximum":50000,"minimum":1,"default":1000,"title":"Batch Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sync/enrich-html":{"post":{"tags":["Sincronización"],"summary":"Enrich Html","operationId":"enrich_html_api_v1_sync_enrich_html_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"max_records","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Max Records"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncActionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sync/jobs":{"get":{"tags":["Sincronización"],"summary":"List Jobs","operationId":"list_jobs_api_v1_sync_jobs_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SyncJobResponse"},"title":"Response List Jobs Api V1 Sync Jobs Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sync/jobs/{job_id}":{"get":{"tags":["Sincronización"],"summary":"Get Job","operationId":"get_job_api_v1_sync_jobs__job_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"integer","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sync/staging/stats":{"get":{"tags":["Sincronización"],"summary":"Staging Stats","operationId":"staging_stats_api_v1_sync_staging_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StagingStatsResponse"}}}}},"security":[{"APIKeyHeader":[]}]}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"StagingStatsResponse":{"properties":{"total":{"type":"integer","title":"Total"},"processed":{"type":"integer","title":"Processed"},"pending":{"type":"integer","title":"Pending"}},"type":"object","required":["total","processed","pending"],"title":"StagingStatsResponse"},"StatisticBucket":{"properties":{"name":{"type":"string","title":"Name"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["name","count"],"title":"StatisticBucket"},"SyncActionResponse":{"properties":{"error":{"type":"boolean","title":"Error","default":false},"codigo_http":{"type":"integer","title":"Codigo Http","default":200},"mensaje":{"type":"string","title":"Mensaje"},"job":{"$ref":"#/components/schemas/SyncJobResponse"}},"type":"object","required":["mensaje","job"],"title":"SyncActionResponse"},"SyncJobResponse":{"properties":{"id":{"type":"integer","title":"Id"},"job_type":{"type":"string","title":"Job Type"},"status":{"type":"string","title":"Status"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"},"records_read":{"type":"integer","title":"Records Read","default":0},"records_inserted":{"type":"integer","title":"Records Inserted","default":0},"records_updated":{"type":"integer","title":"Records Updated","default":0},"records_failed":{"type":"integer","title":"Records Failed","default":0},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"source_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Filename"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"}},"type":"object","required":["id","job_type","status"],"title":"SyncJobResponse"},"TaxpayerLookupRequest":{"properties":{"document_number":{"type":"string","maxLength":20,"minLength":5,"title":"Document Number"}},"type":"object","required":["document_number"],"title":"TaxpayerLookupRequest"},"TaxpayerResponse":{"properties":{"error":{"type":"boolean","title":"Error","default":false},"codigo_http":{"type":"integer","title":"Codigo Http","default":200},"mensaje":{"type":"string","title":"Mensaje","default":"Consulta Exitosa"},"cedula_rnc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cedula Rnc"},"nombre_razon_social":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nombre Razon Social"},"nombre_comercial":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nombre Comercial"},"categoria":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Categoria"},"regimen_de_pagos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Regimen De Pagos"},"estado":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Estado"},"actividad_economica":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actividad Economica"},"administracion_local":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Administracion Local"},"facturador_electronico":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Facturador Electronico"},"licencias_de_comercializacion_de_vhm":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Licencias De Comercializacion De Vhm"},"rnc_consultado":{"type":"string","title":"Rnc Consultado"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"cached":{"type":"boolean","title":"Cached","default":false},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At"}},"type":"object","required":["rnc_consultado"],"title":"TaxpayerResponse"},"TaxpayerSearchResponse":{"properties":{"total":{"type":"integer","title":"Total"},"items":{"items":{"$ref":"#/components/schemas/TaxpayerResponse"},"type":"array","title":"Items"}},"type":"object","required":["total","items"],"title":"TaxpayerSearchResponse"},"TaxpayerStatisticsResponse":{"properties":{"total_contributors":{"type":"integer","title":"Total Contributors"},"active_contributors":{"type":"integer","title":"Active Contributors"},"suspended_contributors":{"type":"integer","title":"Suspended Contributors"},"inactive_contributors":{"type":"integer","title":"Inactive Contributors"},"zip_only_contributors":{"type":"integer","title":"Zip Only Contributors"},"html_enriched_contributors":{"type":"integer","title":"Html Enriched Contributors"},"html_enrichment_pending_contributors":{"type":"integer","title":"Html Enrichment Pending Contributors"},"html_enrichment_failed_contributors":{"type":"integer","title":"Html Enrichment Failed Contributors"},"html_enrichment_coverage_ratio":{"type":"number","title":"Html Enrichment Coverage Ratio"},"unique_categories":{"type":"integer","title":"Unique Categories"},"unique_economic_activities":{"type":"integer","title":"Unique Economic Activities"},"electronic_invoicers":{"type":"integer","title":"Electronic Invoicers"},"electronic_invoicers_ratio":{"type":"number","title":"Electronic Invoicers Ratio"},"categories":{"items":{"$ref":"#/components/schemas/StatisticBucket"},"type":"array","title":"Categories"},"states":{"items":{"$ref":"#/components/schemas/StatisticBucket"},"type":"array","title":"States"},"payment_regimes":{"items":{"$ref":"#/components/schemas/StatisticBucket"},"type":"array","title":"Payment Regimes"},"economic_activities":{"items":{"$ref":"#/components/schemas/StatisticBucket"},"type":"array","title":"Economic Activities"},"local_administrations":{"items":{"$ref":"#/components/schemas/StatisticBucket"},"type":"array","title":"Local Administrations"},"electronic_invoicing":{"items":{"$ref":"#/components/schemas/StatisticBucket"},"type":"array","title":"Electronic Invoicing"},"document_types":{"items":{"$ref":"#/components/schemas/StatisticBucket"},"type":"array","title":"Document Types"},"sources":{"items":{"$ref":"#/components/schemas/StatisticBucket"},"type":"array","title":"Sources"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At"}},"type":"object","required":["total_contributors","active_contributors","suspended_contributors","inactive_contributors","zip_only_contributors","html_enriched_contributors","html_enrichment_pending_contributors","html_enrichment_failed_contributors","html_enrichment_coverage_ratio","unique_categories","unique_economic_activities","electronic_invoicers","electronic_invoicers_ratio","categories","states","payment_regimes","economic_activities","local_administrations","electronic_invoicing","document_types","sources"],"title":"TaxpayerStatisticsResponse"},"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"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-Api-Key"}}}}