{"openapi":"3.1.0","info":{"title":"Croma Marketplace API","version":"1.0.0","description":"Government-data APIs for Colombia, Peru, Mexico, and global web search. Croma normalizes public-sector data into structured JSON for product teams and AI agents.\n\nEvery operation is a POST with a JSON body and an organization API key as a bearer token; every operation is an idempotent lookup and accepts an optional `Idempotency-Key` header. Paths carry their major version (`/v1`); the versioning and deprecation policy, including the `Deprecation` and `Sunset` headers a retiring endpoint sends, is at https://docs.usecroma.com/versioning. Rate limits are per organization and reported on every response (`RateLimit-Policy`, `X-RateLimit-*`): https://docs.usecroma.com/rate-limits.","termsOfService":"https://usecroma.com/en/terms","contact":{"name":"Croma support","url":"https://usecroma.com/en/support","email":"tomas@usecroma.com"}},"servers":[{"url":"https://api.croma.run"}],"paths":{"/co/rama-judicial/cases-by-entity/v1":{"post":{"operationId":"rama_judicial_cases_by_entity","summary":"Rama Judicial Cases by Entity","description":"Search Colombian judicial cases by entity name. Optional filters narrow by entity type, court code, recent activity, and page.","tags":["Colombia","Rama Judicial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/rama-judicial"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":200,"description":"Entity name to search for. Letters, digits, spaces, .,'&- allowed."},"entity_type":{"type":"string","enum":["natural","juridical"],"default":"natural","description":"Entity type: `natural` or `juridical`. Defaults to `natural`."},"active_only":{"type":"boolean","default":false,"description":"When true, only return cases with activity in the last 30 days."},"court_code":{"type":"string","default":"","description":"Optional court code to scope the search to one court."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"name":"PEDRO CIFUENTES"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RamaJudicialSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/rama-judicial/cases-by-radicado/v1":{"post":{"operationId":"rama_judicial_cases_by_radicado","summary":"Rama Judicial Cases by Radicado","description":"Resolve a Colombian judicial case by radicado and return case metadata plus the first 40 actuaciones (actions) available.","tags":["Colombia","Rama Judicial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/rama-judicial"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["registration_number"],"properties":{"registration_number":{"type":"string","minLength":20,"maxLength":25,"pattern":"^\\d{20,25}$","description":"The judicial case number (radicado), normally 23 digits, e.g. `11001600001720180327700`. 20-25 digits accepted."}},"additionalProperties":false},"example":{"registration_number":"11001600001720180327700"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RamaJudicialCaseResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/rama-judicial/cases-by-radicado/v1/batch":{"post":{"operationId":"rama_judicial_cases_by_radicado_batch","summary":"Rama Judicial Cases by Radicado (Batch)","description":"Resolve up to 50 Colombian judicial cases by radicado in one request. Returns one result per radicado in input order, each with its own status, so a single bad radicado never fails the batch. Each item counts as one request against your quota.","tags":["Colombia","Rama Judicial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/rama-judicial"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","minItems":1,"maxItems":50,"description":"1-50 request objects, each identical to the single endpoint's body. Results are returned in the same order. Each item counts as one request against your quota.","items":{"type":"object","required":["registration_number"],"properties":{"registration_number":{"type":"string","minLength":20,"maxLength":25,"pattern":"^\\d{20,25}$","description":"The judicial case number (radicado), normally 23 digits, e.g. `11001600001720180327700`. 20-25 digits accepted."}},"additionalProperties":false}}},"additionalProperties":false},"example":{"items":[{"registration_number":"11001600001720180327700"},{"registration_number":"05001310300120190012300"}]}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RamaJudicialBatchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/rama-judicial/email-directory/v1":{"post":{"operationId":"rama_judicial_email_directory","summary":"Rama Judicial Email Directory","description":"Search the Rama Judicial's official email directory: the mailbox of every Colombian despacho judicial and administrative area, with its corporation, specialty, department, city and seccional. Filter by place, kind of office or specialty (case and accents ignored), or resolve a court directly from a case: the first 12 digits of any radicado are the `court_code` of the despacho that holds it, and a full radicado is accepted as-is. Free text reaches the office name, the address itself, and the office's classification and place. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Rama Judicial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/rama-judicial"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Optional search terms matched against the office name, the email address, and the office's corporation, specialty, department, city and seccional."},"department":{"type":"string","maxLength":60,"default":"","description":"Optional department, matched from the start of the name: `santander`, `bogota`, `valle`. Case and accents are ignored."},"city":{"type":"string","maxLength":60,"default":"","description":"Optional city, matched from the start of the name: `bogota` finds Bogotá D.C., `medellin` Medellín. Case and accents are ignored."},"corporation":{"type":"string","maxLength":120,"default":"","description":"Optional kind of office (corporación), matched from the start of the name: `juzgado-de-circuito`, `tribunal-superior`, `centro-de-servicios`, `corte-suprema`. Case and accents are ignored; `juzgado` matches every kind of juzgado."},"specialty":{"type":"string","maxLength":120,"default":"","description":"Optional specialty (especialidad), matched from the start of the name: `civil`, `laboral`, `penal` (which also matches the penal sub-specialties), `familia`. Case and accents are ignored."},"account_type":{"type":"string","enum":["","despacho","area"],"default":"","description":"Optional kind of mailbox: `despacho` for a court's own account, `area` for an administrative or service area. Empty returns both."},"court_code":{"type":"string","pattern":"^(\\d{12}|\\d{20,25})?$","default":"","description":"Optional 12-digit court code (código de despacho). A full 20-25-digit radicado is also accepted: its first 12 digits identify the office where the case is filed."},"district":{"type":"string","maxLength":60,"default":"","description":"Optional administrative district (seccional), matched from the start of the name: `bucaramanga` finds Seccional Bucaramanga, `nivel-central` the national level. Case and accents are ignored."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Results per page (1-100)."}},"additionalProperties":false},"example":{"city":"bucaramanga","specialty":"penal"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RamaJudicialEmailDirectoryResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/rama-judicial/emails-by-court/v1":{"post":{"operationId":"rama_judicial_emails_by_court","summary":"Rama Judicial Emails by Court","description":"Resolve the official mailbox of a Colombian court from its 12-digit court code (código de despacho), or directly from a full radicado: its first 12 digits identify the court where the case is filed, so a case number answers \"whom do I email about this case\" in one call. Returns every account the directory holds for that code, the despacho's own mailbox first, then its service and filing areas. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Rama Judicial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/rama-judicial"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["court_code"],"properties":{"court_code":{"type":"string","pattern":"^(\\d{12}|\\d{20,25})$","description":"The court's 12-digit code (código de despacho), or a full 20-25-digit radicado: its first 12 digits identify the court where the case is filed."}},"additionalProperties":false},"example":{"court_code":"110013103021"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RamaJudicialEmailsByCourtResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/registraduria/vital-status/v1":{"post":{"operationId":"registraduria_vital_status","summary":"Registraduría Vital Status","description":"Check a Colombian cédula's vital status. Returns `found: false` if the cédula isn't in the registry; otherwise `status` is `ALIVE` or `DECEASED`.","tags":["Colombia","Registraduría"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/registraduria"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","minLength":5,"maxLength":12,"pattern":"^[1-9]\\d{4,11}$","description":"Colombian cédula. 5-12 digits, no leading zero."}},"additionalProperties":false},"example":{"document_number":"5786287"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VitalStatusResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/registro-civil/birth-record/v1":{"post":{"operationId":"registro_civil_birth_record","summary":"Registro Civil Birth Record","description":"Find a Colombian birth civil registry (office, serial, inscription date) by first surname, first name, sex and date of birth. Returns `found: false` when there is no match.","tags":["Colombia","Registraduría Nacional del Estado Civil"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/registro-civil"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["first_surname","first_name","sex","birth_date"],"properties":{"first_surname":{"type":"string","minLength":1,"maxLength":60,"description":"First surname (primer apellido)."},"first_name":{"type":"string","minLength":1,"maxLength":60,"description":"First given name (primer nombre)."},"sex":{"type":"string","enum":["M","F"],"description":"Sex on the record: `M` (masculino) or `F` (femenino)."},"birth_date":{"type":"string","format":"date","description":"Date of birth in yyyy-mm-dd format (year 1900 or later)."},"second_surname":{"type":"string","maxLength":60,"default":"","description":"Second surname (segundo apellido). Optional."},"second_name":{"type":"string","maxLength":60,"default":"","description":"Second given name (segundo nombre). Optional."}},"additionalProperties":false},"example":{"first_surname":"PEREZ","first_name":"JUAN","sex":"M","birth_date":"1990-01-01"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistroCivilBirthRecordResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/ruaf/affiliations/v1":{"post":{"operationId":"ruaf_affiliations","summary":"RUAF Affiliations","description":"Look up a person's social-security affiliations in Colombia by document number. Requires the date the document was issued. `document_type` defaults to `CC`.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","RUAF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/ruaf"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number","issue_date"],"properties":{"document_type":{"type":"string","enum":["CC","CE","TI","RC","PA","PEP","PPT"],"default":"CC","description":"Colombian document type. Defaults to `CC`."},"document_number":{"type":"string","minLength":5,"maxLength":12,"pattern":"^[1-9]\\d{4,11}$","description":"Colombian cédula. 5-12 digits, no leading zero."},"issue_date":{"type":"string","format":"date","description":"Date the document was issued, in yyyy-mm-dd format. For TI and RC, the date of birth."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_number":"1234567890","issue_date":"2008-02-15"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuafResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/rues/entities-by-name/v1":{"post":{"operationId":"rues_entities_by_name","summary":"RUES Entities by Name","description":"Search Colombian businesses in RUES by name, paginated, each result enriched with its full registry record (DetalleRM).","tags":["Colombia","RUES"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/rues"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":200,"description":"Entity name (razón social) to search for."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"name":"exito"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuesEntitySearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/rues/entity-by-nit/v1":{"post":{"operationId":"rues_entity_by_nit","summary":"RUES Entity by NIT","description":"Resolve a Colombian business by NIT and return its full RUES record: registry detail, financial statements, renewal history, related parties and registry notices.","tags":["Colombia","RUES"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/rues"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","minLength":4,"maxLength":15,"pattern":"^\\d{4,15}$","description":"Colombian NIT (numeric, no verification digit). 4-15 digits."}},"additionalProperties":false},"example":{"document_number":"900654922"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuesEntityResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/policia/criminal-records/v1":{"post":{"operationId":"policia_criminal_records","summary":"Policía Criminal Records","description":"Check a person's Colombian criminal record (antecedentes). `document_type` defaults to `CC`.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","Policía Nacional"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/policia"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_type":{"type":"string","enum":["CC","CE","PA","DPO"],"default":"CC","description":"Colombian document type. Defaults to `CC`."},"document_number":{"type":"string","minLength":3,"maxLength":30,"description":"Document number (alphanumeric with hyphens allowed)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_number":"1234567890"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AntecedentesResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/siata/v1":{"post":{"operationId":"siata_conditions","summary":"SIATA Aburrá Valley Conditions","description":"Deprecated since 2026-08-27; stops answering on 2026-12-01. Use `POST /co/siata-geoportal/weather/v1` instead.\n\nLive environmental conditions for the Aburrá Valley (Medellín metropolitan area) from SIATA: per-station weather (temperature, humidity, wind, pressure), rainfall (accumulated + intensity), and air quality (24h PM2.5 + ICA index). All inputs optional: an empty body returns every station; pass `latitude` + `longitude` (with optional `radius_km`, default 10) to get only nearby stations, nearest first with `distance_km` populated. Coverage is the Medellín metro area only.","deprecated":true,"tags":["Colombia","SIATA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/siata"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90,"description":"Optional latitude. With `longitude`, returns only stations near that point."},"longitude":{"type":"number","minimum":-180,"maximum":180,"description":"Optional longitude. With `latitude`, returns only stations near that point."},"radius_km":{"type":"number","minimum":1,"maximum":100,"default":10,"description":"Radius in km around `latitude`/`longitude` to include stations. Defaults to 10."}},"additionalProperties":false},"example":{"latitude":6.2442,"longitude":-75.5812,"radius_km":5}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiataConditionsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/siata-geoportal/weather/v1":{"post":{"operationId":"siata_geoportal_weather","summary":"SIATA Weather","description":"Current weather at every SIATA station in the Aburrá Valley (Medellín metropolitan area): temperature, humidity, wind, pressure, an hourly 12-hour series per station, and the valley's UV index with today's hourly series. All inputs optional: an empty body returns every station; pass `latitude` + `longitude` (with optional `radius_km`, default 10) for nearby stations nearest first, or `municipality` / `station_code` to narrow. Coverage is the Medellín metro area only.","tags":["Colombia","SIATA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/siata-geoportal"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90,"description":"Optional latitude. With `longitude`, returns only stations near that point."},"longitude":{"type":"number","minimum":-180,"maximum":180,"description":"Optional longitude. With `latitude`, returns only stations near that point."},"radius_km":{"type":"number","minimum":1,"maximum":100,"default":10,"description":"Radius in km around `latitude`/`longitude` to include stations. Defaults to 10."},"municipality":{"type":"string","maxLength":80,"default":"","description":"Optional municipality filter, e.g. `Medellín` or `Itagüí`. Accents and case are ignored."},"station_code":{"type":"string","maxLength":20,"default":"","description":"Optional station code, e.g. `520`. Returns only that station."}},"additionalProperties":false},"example":{"latitude":6.2442,"longitude":-75.5812,"radius_km":5}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiataGeoportalWeatherResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/siata-geoportal/weather-series/v1":{"post":{"operationId":"siata_geoportal_weather_series","summary":"SIATA Weather Station Series","description":"Minute-by-minute weather at one SIATA station in the Aburrá Valley (Medellín metropolitan area): temperature, humidity, wind speed and pressure over the last hour at one-minute resolution (`window: \"1h\"`, the default) or the last six hours at five-minute resolution (`window: \"6h\"`), with the source's means and temperature percentiles. `station_code` is required; codes come from the weather endpoint. Returns `found: false` for an unknown station.","tags":["Colombia","SIATA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/siata-geoportal"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["station_code"],"properties":{"station_code":{"type":"string","pattern":"^[0-9]{1,6}$","description":"Station code, e.g. `202`. Codes come from the `weather` endpoint's `station_code`."},"window":{"type":"string","enum":["1h","6h"],"default":"1h","description":"`1h` for the last hour at one-minute resolution, `6h` for the last six hours at five-minute resolution."}},"additionalProperties":false},"example":{"station_code":"202","window":"1h"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiataGeoportalWeatherSeriesResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/siata-geoportal/river-levels/v1":{"post":{"operationId":"siata_geoportal_river_levels","summary":"SIATA River Levels","description":"Current river, stream and storm-sewer water levels for the Aburrá Valley (Medellín metropolitan area) from SIATA: per-station level in metres against the station's flood thresholds (with a derived status), the highest and mean level over the last three hours, the source's alert colour and level, six trailing windows, basin morphology and land cover. `include_series` adds a per-minute 3-hour series. All inputs optional: an empty body returns every station; pass `latitude` + `longitude` (with optional `radius_km`, default 10) for nearby stations nearest first, or `municipality` / `station_code` to narrow. Coverage is the Medellín metro area only.","tags":["Colombia","SIATA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/siata-geoportal"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90,"description":"Optional latitude. With `longitude`, returns only stations near that point."},"longitude":{"type":"number","minimum":-180,"maximum":180,"description":"Optional longitude. With `latitude`, returns only stations near that point."},"radius_km":{"type":"number","minimum":1,"maximum":100,"default":10,"description":"Radius in km around `latitude`/`longitude` to include stations. Defaults to 10."},"municipality":{"type":"string","maxLength":80,"default":"","description":"Optional municipality filter, e.g. `Medellín` or `Itagüí`. Accents and case are ignored."},"station_code":{"type":"string","maxLength":20,"default":"","description":"Optional station code, e.g. `520`. Returns only that station."},"include_series":{"type":"boolean","default":false,"description":"When true, each station also carries `series_3h`, one level reading per minute for the last three hours."}},"additionalProperties":false},"example":{"latitude":6.2442,"longitude":-75.5812,"radius_km":5}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiataGeoportalRiverLevelsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/siata-geoportal/rainfall/v1":{"post":{"operationId":"siata_geoportal_rainfall","summary":"SIATA Rainfall","description":"Rain at every SIATA gauge in the Aburrá Valley (Medellín metropolitan area): whether it is raining now and the source's extreme-rain flag, rain accumulated over seven trailing windows (5 minutes to 30 days), and monthly totals for the current year with each month's data availability. All inputs optional: an empty body returns every gauge; pass `latitude` + `longitude` (with optional `radius_km`, default 10) for nearby gauges nearest first, or `municipality` / `station_code` to narrow. Coverage is the Medellín metro area only.","tags":["Colombia","SIATA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/siata-geoportal"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90,"description":"Optional latitude. With `longitude`, returns only stations near that point."},"longitude":{"type":"number","minimum":-180,"maximum":180,"description":"Optional longitude. With `latitude`, returns only stations near that point."},"radius_km":{"type":"number","minimum":1,"maximum":100,"default":10,"description":"Radius in km around `latitude`/`longitude` to include stations. Defaults to 10."},"municipality":{"type":"string","maxLength":80,"default":"","description":"Optional municipality filter, e.g. `Medellín` or `Itagüí`. Accents and case are ignored."},"station_code":{"type":"string","maxLength":20,"default":"","description":"Optional station code, e.g. `520`. Returns only that station."}},"additionalProperties":false},"example":{"latitude":6.2442,"longitude":-75.5812,"radius_km":5}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiataGeoportalRainfallResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/siata-geoportal/air-quality/v1":{"post":{"operationId":"siata_geoportal_air_quality","summary":"SIATA Air Quality","description":"Current air quality at SIATA's reference stations in the Aburrá Valley (Medellín metropolitan area): 24-hour PM2.5 and PM10, 8-hour ozone and CO, 1-hour NO2 and SO2, each as a concentration with Colombia's numeric air-quality index (ICA) and its category, plus the pollutant driving each station's index. All inputs optional: an empty body returns every station; pass `latitude` + `longitude` (with optional `radius_km`, default 10) for nearby stations nearest first, or `municipality` / `station_code` to narrow. Coverage is the Medellín metro area only.","tags":["Colombia","SIATA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/siata-geoportal"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90,"description":"Optional latitude. With `longitude`, returns only stations near that point."},"longitude":{"type":"number","minimum":-180,"maximum":180,"description":"Optional longitude. With `latitude`, returns only stations near that point."},"radius_km":{"type":"number","minimum":1,"maximum":100,"default":10,"description":"Radius in km around `latitude`/`longitude` to include stations. Defaults to 10."},"municipality":{"type":"string","maxLength":80,"default":"","description":"Optional municipality filter, e.g. `Medellín` or `Itagüí`. Accents and case are ignored."},"station_code":{"type":"string","maxLength":20,"default":"","description":"Optional station code, e.g. `520`. Returns only that station."}},"additionalProperties":false},"example":{"municipality":"Medellín"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiataGeoportalAirQualityResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/siata-geoportal/citizen-sensors/v1":{"post":{"operationId":"siata_geoportal_citizen_sensors","summary":"SIATA Citizen Air Sensors","description":"The citizen-science PM2.5 sensor network of the Aburrá Valley (Medellín metropolitan area), about 230 low-cost sensors: PM2.5 over the last hour, the daily air-quality index (ICA) with its category, whether each sensor is reporting, and its data recovery over 24 hours and 15 days. All inputs optional: an empty body returns every sensor; pass `latitude` + `longitude` (with optional `radius_km`, default 10) for nearby sensors nearest first, or `municipality` / `station_code` to narrow. Indicative data; use the air-quality endpoint for the reference network.","tags":["Colombia","SIATA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/siata-geoportal"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90,"description":"Optional latitude. With `longitude`, returns only stations near that point."},"longitude":{"type":"number","minimum":-180,"maximum":180,"description":"Optional longitude. With `latitude`, returns only stations near that point."},"radius_km":{"type":"number","minimum":1,"maximum":100,"default":10,"description":"Radius in km around `latitude`/`longitude` to include stations. Defaults to 10."},"municipality":{"type":"string","maxLength":80,"default":"","description":"Optional municipality filter, e.g. `Medellín` or `Itagüí`. Accents and case are ignored."},"station_code":{"type":"string","maxLength":20,"default":"","description":"Optional station code, e.g. `520`. Returns only that station."}},"additionalProperties":false},"example":{"latitude":6.2442,"longitude":-75.5812,"radius_km":3}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiataGeoportalCitizenSensorsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/siata-geoportal/forecast/v1":{"post":{"operationId":"siata_geoportal_forecast","summary":"SIATA Weather Forecast","description":"SIATA's two-day weather forecast for the Aburrá Valley (Medellín metropolitan area), per municipality and, for Medellín, per zone: daily maximum and minimum temperature and the likelihood of rain for each part of the day (early morning, morning, afternoon, night). Pass `municipality` to get one municipality; an empty body returns every zone. Issued once a day.","tags":["Colombia","SIATA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/siata-geoportal"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"municipality":{"type":"string","maxLength":80,"default":"","description":"Optional municipality filter, e.g. `Medellín` or `Itagüí`. Accents and case are ignored."}},"additionalProperties":false},"example":{"municipality":"Medellín"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiataGeoportalForecastResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/siata-geoportal/alerts/v1":{"post":{"operationId":"siata_geoportal_alerts","summary":"SIATA Alerts","description":"Official notices from SIATA, the early-warning system of the Aburrá Valley (Medellín metropolitan area): title, plain-text description, validity dates and audience. Returns the active notices; pass `include_past: true` for every notice on record, most recent first.","tags":["Colombia","SIATA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/siata-geoportal"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"include_past":{"type":"boolean","default":false,"description":"When true, returns past notices as well as the active ones."}},"additionalProperties":false},"example":{"include_past":true}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiataGeoportalAlertsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/siata-geoportal/seismic-events/v1":{"post":{"operationId":"siata_geoportal_seismic_events","summary":"SIATA Seismic Events","description":"The last earthquakes recorded by SIATA's accelerograph and seismograph network in the Aburrá Valley (Medellín metropolitan area): per station, the most recent events with magnitude, epicentre, depth and what the station measured (peak ground acceleration and Mercalli intensity on accelerographs, peak ground velocity on seismographs). All inputs optional: an empty body returns every station; pass `latitude` + `longitude` (with optional `radius_km`, default 10) for nearby stations nearest first, or `municipality` / `station_code` to narrow.","tags":["Colombia","SIATA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/siata-geoportal"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90,"description":"Optional latitude. With `longitude`, returns only stations near that point."},"longitude":{"type":"number","minimum":-180,"maximum":180,"description":"Optional longitude. With `latitude`, returns only stations near that point."},"radius_km":{"type":"number","minimum":1,"maximum":100,"default":10,"description":"Radius in km around `latitude`/`longitude` to include stations. Defaults to 10."},"municipality":{"type":"string","maxLength":80,"default":"","description":"Optional municipality filter, e.g. `Medellín` or `Itagüí`. Accents and case are ignored."},"station_code":{"type":"string","maxLength":20,"default":"","description":"Optional station code, e.g. `520`. Returns only that station."}},"additionalProperties":false},"example":{}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiataGeoportalSeismicEventsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/siata-geoportal/cameras/v1":{"post":{"operationId":"siata_geoportal_cameras","summary":"SIATA Cameras","description":"SIATA's camera network in the Aburrá Valley (Medellín metropolitan area), about 90 cameras pointed at river gauges, the sky, underpasses and the boundary layer, each with the URL of its latest snapshot. All inputs optional: pass `latitude` + `longitude` (with optional `radius_km`, default 10) for nearby cameras nearest first, or `type` (`nivel`, `cielo`, `deprimido`, `capa_limite`) to keep one kind.","tags":["Colombia","SIATA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/siata-geoportal"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90,"description":"Optional latitude. With `longitude`, returns only stations near that point."},"longitude":{"type":"number","minimum":-180,"maximum":180,"description":"Optional longitude. With `latitude`, returns only stations near that point."},"radius_km":{"type":"number","minimum":1,"maximum":100,"default":10,"description":"Radius in km around `latitude`/`longitude` to include stations. Defaults to 10."},"type":{"type":"string","maxLength":20,"default":"","description":"Optional camera type: `nivel` (river gauges), `cielo` (sky), `deprimido` (underpasses) or `capa_limite` (boundary layer)."}},"additionalProperties":false},"example":{"type":"nivel","latitude":6.2442,"longitude":-75.5812,"radius_km":5}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiataGeoportalCamerasResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/legalize/laws/v1":{"post":{"operationId":"legalize_laws_search","summary":"Colombia Laws Search","description":"Search Colombian legislation as structured data, sourced from Legalize. Filter by free text, law type, publication year, status, and jurisdiction. Returns paginated law summaries; use `per_page` and `page` to page. Drill into one with `legalize-law-detail`.","tags":["Colombia","Legalize"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/legalize"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Free-text search over law titles and content. Omit to list all."},"law_type":{"type":"string","maxLength":60,"default":"","description":"Filter by law type (e.g. `ley`, `decreto`). Omit for all types."},"year":{"type":"string","default":"","description":"Filter by publication year (yyyy). Omit for all years."},"status":{"type":"string","maxLength":40,"default":"","description":"Filter by law status (e.g. `in_force`). Omit for any status."},"jurisdiction":{"type":"string","maxLength":60,"default":"","description":"Filter by jurisdiction. Omit for all jurisdictions."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":50,"description":"Results per page (1-100)."}},"additionalProperties":false},"example":{"query":"habeas data","per_page":20}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalizeLawsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/legalize/law/v1":{"post":{"operationId":"legalize_law_detail","summary":"Colombia Law Detail","description":"Resolve a single Colombian law by its identifier and return the full record, sourced from Legalize: metadata plus the law text as Markdown (`content_md`). `found: false` when no law matches the identifier.","tags":["Colombia","Legalize"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/legalize"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["law_id"],"properties":{"law_id":{"type":"string","minLength":1,"maxLength":200,"description":"The law identifier returned by the laws search (`id`)."}},"additionalProperties":false},"example":{"law_id":"LEY-1266-2008"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalizeLawResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/ancp-cce/conceptos-search/v1":{"post":{"operationId":"ancp_cce_conceptos_search","summary":"ANCP-CCE Conceptos Search","description":"Search conceptos (public-procurement legal opinions) from the Relatoría de la ANCP-CCE (Colombia Compra Eficiente) by free text, tema (descriptor), and modification date. Paginated, newest-modified first. Drill into one with `ancp-cce-concepto` for the full text.","tags":["Colombia","Relatoría de la ANCP-CCE"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/ancp-cce"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Optional free-text search over the concepto text. Empty returns the most recently modified conceptos."},"subject":{"type":"string","maxLength":120,"default":"","description":"Optional tema (descriptor) filter, e.g. `Capacidad jurídica`. Empty applies no tema filter."},"modified_after":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Results per page (maximum 100)."}},"additionalProperties":false},"example":{"query":"capacidad jurídica"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AncpConceptosSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/ancp-cce/concepto/v1":{"post":{"operationId":"ancp_cce_concepto","summary":"ANCP-CCE Concepto","description":"Retrieve one ANCP-CCE concepto by id or slug (e.g. `c-1094-de-2026`): full doctrinal text, dates, subjects and subtopics. `found: false` when nothing matches.","tags":["Colombia","Relatoría de la ANCP-CCE"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/ancp-cce"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["identifier"],"properties":{"identifier":{"type":"string","pattern":"^(?:\\d+|[a-z0-9]+(?:-[a-z0-9]+)*)$","description":"Numeric id or slug of the concepto (e.g. `c-1094-de-2026`), as returned by the search."}},"additionalProperties":false},"example":{"identifier":"c-1094-de-2026"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AncpConceptoResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/cndj/rulings-search/v1":{"post":{"operationId":"cndj_rulings_search","summary":"CNDJ Rulings Search","description":"Search disciplinary rulings from the Relatoría de la Comisión Nacional de Disciplina Judicial (CNDJ) by free text or the advanced filters (reporting magistrate, topic, respondent, matter, subtopic, filing year). Returns the matching summaries with their `numero_unico` + `numero_ficha` key; read one in full with `cndj-ruling`.","tags":["Colombia","Relatoría de la CNDJ"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/cndj"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Texto de búsqueda general (providencias disciplinarias)."},"reporting_judge":{"type":"string","maxLength":120,"default":"","description":"Filtro por magistrado ponente."},"subject":{"type":"string","maxLength":120,"default":"","description":"Filtro por tema."},"respondent":{"type":"string","maxLength":120,"default":"","description":"Filtro por nombre del disciplinado."},"matter":{"type":"string","maxLength":120,"default":"","description":"Filtro por asunto."},"subtopic":{"type":"string","maxLength":120,"default":"","description":"Filtro por restrictor."},"year":{"type":"string","default":"","description":"Filtro opcional por año de radicación (4 dígitos)."},"limit":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Número máximo de resultados a devolver."}},"additionalProperties":false},"example":{"query":"prescripción","limit":25}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CndjRulingsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/cndj/ruling/v1":{"post":{"operationId":"cndj_ruling","summary":"CNDJ Ruling","description":"Retrieve one CNDJ disciplinary ruling by its `registration_number` + `ficha_number` key: the editorial fields (titulación, descriptores, fuentes normativas, salvamentos) plus the ruling document and its extracted full text when it carries a text layer. `found: false` when no document is stored for that key.","tags":["Colombia","Relatoría de la CNDJ"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/cndj"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["registration_number","ficha_number"],"properties":{"registration_number":{"type":"string","pattern":"^\\d{23}$","description":"Numero unico de la radicación (`numero_unico` de la búsqueda)."},"ficha_number":{"type":"integer","minimum":1,"description":"Número de ficha de la radicación (`numero_ficha` de la búsqueda)."}},"additionalProperties":false},"example":{"registration_number":"11001010200020200012300","ficha_number":12345}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CndjRulingResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/contraloria/fiscal-records/v1":{"post":{"operationId":"contraloria_fiscal_records","summary":"Contraloría Fiscal Records","description":"Check whether a person is reported as a responsable fiscal in the Contraloría's SIBOR boletín (certificado de antecedentes de responsabilidad fiscal). `document_type` defaults to `CC`. Returns the verdict plus a verification code.","tags":["Colombia","Contraloría"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/contraloria"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_type":{"type":"string","enum":["CC","CE","TI","PA","PEP","PPT"],"default":"CC","description":"Colombian document type. Defaults to `CC`."},"document_number":{"type":"string","minLength":3,"maxLength":30,"description":"Document number (alphanumeric with hyphens allowed)."}},"additionalProperties":false},"example":{"document_number":"1234567890"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContraloriaResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/dian/doctrina-search/v1":{"post":{"operationId":"dian_doctrina_search","summary":"DIAN Doctrina Search","description":"Full-text search over DIAN's published tax doctrine and related legal compilation: oficios, conceptos, decretos, resoluciones, leyes and high-court rulings. Each hit carries the `document_id` used by `dian-doctrina-document`, plus the title, issuing body, epigraph and a matching excerpt. Optional filters: `document_type` (e.g. `Oficios`, `Conceptos`) and `year`. Paginated with `page` and `per_page`; `capped: true` means the source returned more matches than are retrievable, so narrow the query.","tags":["Colombia","DIAN"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dian"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string","minLength":2,"maxLength":300,"description":"Términos de búsqueda en el texto de la doctrina (p. ej. `dividendos`)."},"document_type":{"type":"string","maxLength":60,"default":"","description":"Filtro por tipo de documento (p. ej. `Oficios`, `Conceptos`). Vacío para todos."},"year":{"type":"string","default":"","description":"Filtro por año de expedición (yyyy). Vacío para todos."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Resultados por página (1-100)."}},"additionalProperties":false},"example":{"query":"dividendos","document_type":"Conceptos"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DianDoctrinaSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/dian/doctrina/v1":{"post":{"operationId":"dian_doctrina_document","summary":"DIAN Doctrina Document","description":"Retrieve the text of one DIAN doctrine document by the `document_id` returned by `dian-doctrina-search`: the official title and the body of the oficio, concepto or norm. Compiled norms run to millions of characters, so the body is returned in character ranges: `content.total_length` is the full size, and when `content.has_more` is true request the next range with `offset: content.next_offset`. `found: false` when no document carries that id.","tags":["Colombia","DIAN"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dian"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_id"],"properties":{"document_id":{"type":"string","pattern":"^[A-Za-z0-9_()\\[\\]-]{3,120}$","description":"`document_id` devuelto por la búsqueda (p. ej. `oficio_dian_18075_2023`)."},"offset":{"type":"integer","minimum":0,"maximum":10000000,"default":0,"description":"First character of the range to return. Pass the previous response's `next_offset` to continue reading."},"limit":{"type":"integer","minimum":1000,"maximum":1000000,"default":200000,"description":"Maximum characters to return (1000-1000000)."}},"additionalProperties":false},"example":{"document_id":"oficio_dian_18075_2023"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DianDoctrinaDocumentResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/dian/electronic-document/v1":{"post":{"operationId":"dian_electronic_document","summary":"DIAN Electronic Document","description":"Validate a Colombian electronic document (factura electrónica, nota crédito/débito) by its CUFE/UUID and the emisor or receptor NIT. Returns the issuer, recipient, totals and taxes, current legitimate holder, validations, and events. Set `include_pdf: true` to also receive `pdf_url`, the URL of the official PDF representation. `found: false` means the document is not registered under that CUFE, or the NIT matches neither the emisor nor the receptor.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","DIAN"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dian"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cufe","document_number"],"properties":{"cufe":{"type":"string","minLength":30,"maxLength":100,"pattern":"^[A-Za-z0-9-]{30,100}$","description":"CUFE/CUDE (unique electronic-document code) or UUID of the document."},"document_number":{"type":"string","minLength":4,"maxLength":15,"pattern":"^\\d{4,15}$","description":"Colombian NIT (numeric, no verification digit). 4-15 digits."},"include_pdf":{"type":"boolean","default":false,"description":"When true, the response includes `pdf_url`, the URL of the official PDF representation of the document."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"cufe":"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","document_number":"900123456"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DianElectronicDocumentResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/funcion-publica/norms-search/v1":{"post":{"operationId":"funcion_publica_norms_search","summary":"Función Pública Norms Search","description":"Search the Gestor Normativo, the Colombian state's register of the norms that govern public administration: laws, decrees, conceptos, rulings, circulares and acuerdos from 1620 to today, across every kind and year at once. Free text matches the norm's citation, the register's own one-line description and the full text of the norm itself. Filter by `document_type`, `year`, exact `number` (with or without leading zeros), issuing `entity`, the `subject` the register files it under, and the date it was issued (`issued_from`/`issued_to`). Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Función Pública"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/funcion-publica"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the norm's citation, the register's one-line description and the full text of the norm itself."},"document_type":{"type":"string","maxLength":60,"default":"","description":"Optional kind of instrument: `ley`, `decreto`, `concepto`, `sentencia`, `acuerdo`, `resolucion`, `circular`, `circular-externa`, `decreto-ley`, `acto-legislativo`, `directiva`, `auto`, `constitucion-politica` and others. Case and accents are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year in the norm's own designation (the 2008 of `Ley 1266 de 2008`). 0 searches every year."},"number":{"type":"string","maxLength":40,"default":"","description":"Optional norm number, with or without leading zeros (`1266`, `007`, `100-010`, `2017-00230`)."},"entity":{"type":"string","maxLength":120,"default":"","description":"Optional issuing entity, matched from the start of the name: `congreso` finds the Congreso de la República, `ministerio-de-hacienda` the ministry. Case and accents are ignored. `nivel-nacional` is how the register labels norms of the national executive."},"subject":{"type":"string","maxLength":120,"default":"","description":"Optional subject heading the register files the norm under, matched exactly as it publishes it, e.g. `HABEAS DATA`, `CARRERA ADMINISTRATIVA`."},"issued_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"issued_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"habeas data","document_type":"ley"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FuncionPublicaNormsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/funcion-publica/norm/v1":{"post":{"operationId":"funcion_publica_norm","summary":"Función Pública Norm","description":"Retrieve one norm of the Gestor Normativo by its `norm_id` from the search results: its consolidated text, the dates it was issued and entered into force, where it was officially published, the subjects the register files it under, and the later norms it records as having added to, modified or repealed it. The text comes back a character range at a time (`offset`, `limit`), because the longest norms run past a million characters; follow `next_offset` until `has_more` is false.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Función Pública"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/funcion-publica"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["norm_id"],"properties":{"norm_id":{"type":"string","pattern":"^\\d{1,12}$","description":"Norm identifier from the search results (`id`), e.g. `34488`."},"offset":{"type":"integer","minimum":0,"maximum":10000000,"default":0,"description":"First character of the range to return. Pass the previous response's `next_offset` to continue reading."},"limit":{"type":"integer","minimum":1000,"maximum":1000000,"default":200000,"description":"Maximum characters to return (1000-1000000)."}},"additionalProperties":false},"example":{"norm_id":"34488"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FuncionPublicaNormResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/imprenta/gaceta-documents-search/v1":{"post":{"operationId":"imprenta_gaceta_documents_search","summary":"Gaceta del Congreso Documents","description":"Search everything the Colombian Congress has published in the Gaceta del Congreso since 2000, document by document: proyectos de ley as filed, informes de ponencia, actas de comisión y plenaria, textos aprobados y definitivos, informes de conciliación, objeciones presidenciales and conceptos. Search the full text, or filter by `chamber`, `kind`, and by the bill a document is about (`bill_number`, `bill_year`) to follow one proyecto de ley through every stage of its passage. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Imprenta Nacional"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/imprenta"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Optional free-text search. Matches the document's title, its epígrafe and its full text."},"chamber":{"type":"string","enum":["any","senado","camara"],"default":"any","description":"Chamber: `senado` (Senado de la República), `camara` (Cámara de Representantes), or `any`."},"kind":{"type":"string","enum":["any","proyecto","ponencia","acta","texto","conciliacion","objecion","concepto","ley","otro"],"default":"any","description":"Kind of document: `proyecto` (a bill as filed), `ponencia` (a committee report), `acta` (minutes of a sitting), `texto` (an approved or definitive text), `conciliacion`, `objecion`, `concepto`, `ley`, `otro`, or `any`."},"bill_number":{"type":"string","maxLength":10,"default":"","description":"Optional number. Leading zeros are ignored, so `02` and `2` match the same thing."},"bill_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the bill was filed. 0 searches every year."},"published_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"published_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"reforma pensional","kind":"ponencia"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImprentaGacetaDocumentsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/imprenta/gaceta-document/v1":{"post":{"operationId":"imprenta_gaceta_document","summary":"Gaceta del Congreso Document","description":"Retrieve one document published in the Gaceta del Congreso by its `document_id` from the search results (e.g. `87176`), with its full text as the Gaceta published it, the issue it appeared in, and the proyecto de ley it belongs to.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Imprenta Nacional"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/imprenta"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_id"],"properties":{"document_id":{"type":"string","minLength":1,"maxLength":20,"description":"The document's identifier, e.g. `87176`."}},"additionalProperties":false},"example":{"document_id":"87176"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImprentaGacetaDocumentResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/imprenta/gacetas-search/v1":{"post":{"operationId":"imprenta_gacetas_search","summary":"Gaceta del Congreso Issues","description":"Browse the issues of the Gaceta del Congreso themselves: every issue either chamber has published since 2000, by number, chamber and publication date. Use this to find an issue by its citation; use the Documents endpoint to search what is inside them.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Imprenta Nacional"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/imprenta"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Optional free-text search. Matches the document's title, its epígrafe and its full text."},"chamber":{"type":"string","enum":["any","senado","camara"],"default":"any","description":"Chamber: `senado` (Senado de la República), `camara` (Cámara de Representantes), or `any`."},"number":{"type":"string","maxLength":10,"default":"","description":"Optional number. Leading zeros are ignored, so `02` and `2` match the same thing."},"published_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"published_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"chamber":"senado","published_from":"2026-08-01"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImprentaGacetasResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/imprenta/diarios-search/v1":{"post":{"operationId":"imprenta_diarios_search","summary":"Diario Oficial Issues","description":"Browse the Diario Oficial, the gazette where Colombian law takes effect: every issue the Imprenta Nacional lists, from number 23,962 of 2 January 1939 to this week's, by number, edition and publication date.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Imprenta Nacional"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/imprenta"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"number":{"type":"string","maxLength":15,"default":"","description":"Optional Diario Oficial issue number. The thousands separator is ignored, so `53.609` and `53609` match the same issue."},"edition":{"type":"string","enum":["any","ordinaria","extraordinaria","especial","oficio_tributario","otra"],"default":"any","description":"Edition: `ordinaria` (the daily edition), `extraordinaria`, `especial`, `oficio_tributario`, `otra`, or `any`."},"published_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"published_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"published_from":"2026-08-01"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImprentaDiariosResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/procuraduria/disciplinary-records/v1":{"post":{"operationId":"procuraduria_disciplinary_records","summary":"Procuraduría Disciplinary Records","description":"Check a person or entity's antecedentes with the Procuraduría General de la Nación (disciplinary, penal, contractual, fiscal, and pérdida de investidura records from SIRI). `document_type` defaults to `CC`. Returns the verdict, the registered name, and the antecedente sections reproduced from the certificate.","tags":["Colombia","Procuraduría"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/procuraduria"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_type":{"type":"string","enum":["CC","CE","NIT","PEP","PPT"],"default":"CC","description":"Colombian document type. Defaults to `CC`."},"document_number":{"type":"string","minLength":3,"maxLength":30,"description":"Document number (alphanumeric with hyphens allowed)."}},"additionalProperties":false},"example":{"document_number":"1234567890"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcuraduriaResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/samai/processes/v1":{"post":{"operationId":"samai_processes","summary":"SAMAI Processes","description":"Search live contentious-administrative processes (Consejo de Estado plus every Tribunal and Juzgado Administrativo) by party, radicado, or class, scoped to a corporación. Returns one page of matches with the reporting magistrate, class, filing date, parties and the official detail link. A radicado search derives the corporación from the radicado when none is given.","tags":["Colombia","SAMAI / Consejo de Estado"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/samai"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"search_type":{"type":"string","enum":["radicado","clase","parte"],"default":"parte","description":"Search by `parte` (party name), `radicado` (case number), or `clase` (process class)."},"query":{"type":"string","minLength":2,"maxLength":200,"description":"The value to search for: a party name (`parte`), a radicado, or a process class."},"corporacion":{"type":"string","default":"","description":"Corporación (despacho) code to scope the search, e.g. `1100103` for the Consejo de Estado. Required for party/class searches; for a radicado search it is inferred when omitted. List codes with the corporaciones catalog."},"section":{"type":"string","maxLength":20,"default":"","description":"Optional sección (chamber) code to narrow the search."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":10,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"search_type":"parte","query":"BANCOLOMBIA","corporacion":"1100103"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SamaiProcessesResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/samai/corporaciones/v1":{"post":{"operationId":"samai_corporaciones","summary":"SAMAI Corporaciones","description":"Every corporación (despacho) SAMAI exposes, with its code and name. A code scopes a process search.","tags":["Colombia","SAMAI / Consejo de Estado"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/samai"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{},"additionalProperties":false},"example":{}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SamaiCorporacionesResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/samai/secciones/v1":{"post":{"operationId":"samai_secciones","summary":"SAMAI Secciones","description":"The secciones (salas) inside one corporación, with their codes and names.","tags":["Colombia","SAMAI / Consejo de Estado"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/samai"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["corporacion"],"properties":{"corporacion":{"type":"string","pattern":"^\\d{5,9}$","description":"Corporación code (from the corporaciones catalog)."}},"additionalProperties":false},"example":{"corporacion":"1100103"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SamaiSeccionesResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/samai-rulings/search/v1":{"post":{"operationId":"samai_rulings_search","summary":"SAMAI Rulings Search","description":"Search every ruling of the Consejo de Estado dated since December 2021 that its relatoría has titled: sentencias, autos, aclaraciones and salvamentos de voto and conceptos, each with the relatoría's headnotes (descriptors, legal problem and answer, thesis, formal sources, notes), its full text, its document (PDF, or Word for some of the oldest) and the case's page on the court's own site. Free text matches the headnotes, the case number, the parties and the full text. Filter by `chamber`, `type`, `year`, `registration_number` (the radicado), `reporting_judge` (the consejero ponente), `plaintiff`, `defendant` and the ruling date (`from_date`/`to_date`). Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SAMAI / Consejo de Estado"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/samai-rulings"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the ruling's headnotes (descriptors, legal problem, thesis, sources, relatoría note), its case number, its parties and its full text."},"chamber":{"type":"string","maxLength":120,"default":"","description":"Optional chamber (sección or sala), matched from the start of its name: `Sección Tercera` also matches its subsecciones. Case and accents are ignored."},"type":{"type":"string","maxLength":80,"default":"","description":"Optional kind of ruling, matched from the start of its name: `Sentencia`, `Auto` (every kind of auto), `Salvamento voto`, `Aclaración voto`. Case and accents are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the ruling date. 0 searches every year."},"registration_number":{"type":"string","maxLength":40,"default":"","description":"Optional 23-digit case number (radicado). Spaces, dots and dashes are ignored."},"reporting_judge":{"type":"string","maxLength":120,"default":"","description":"Optional consejero ponente, by full name as it appears in `reporting_judges`. Case and accents are ignored."},"plaintiff":{"type":"string","maxLength":200,"default":"","description":"Optional plaintiff, matched from the start of the name as the court lists it. Case and accents are ignored."},"defendant":{"type":"string","maxLength":200,"default":"","description":"Optional defendant, matched from the start of the name as the court lists it. Case and accents are ignored."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"reparación directa","chamber":"Sección Tercera"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SamaiRulingsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/samai-rulings/ruling/v1":{"post":{"operationId":"samai_rulings_ruling","summary":"SAMAI Ruling","description":"Retrieve one ruling of the Consejo de Estado by its `id` (from a search result): the relatoría's headnotes, the case data, the parties, the ruling's document (PDF, or Word for some of the oldest) and the case's page on the court's own site, with the full text read a character range at a time (`offset`, `limit`); follow `next_offset` until `has_more` is false. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SAMAI / Consejo de Estado"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/samai-rulings"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ruling_id"],"properties":{"ruling_id":{"type":"string","pattern":"^\\s*[0-9A-Fa-f]{64}\\s*$","description":"The ruling's `id` from a search result: the 64-character hexadecimal certificate of its document."},"offset":{"type":"integer","minimum":0,"maximum":10000000,"default":0,"description":"First character of the range to return. Pass the previous response's `next_offset` to continue reading."},"limit":{"type":"integer","minimum":1000,"maximum":1000000,"default":200000,"description":"Maximum characters to return (1000-1000000)."}},"additionalProperties":false},"example":{"ruling_id":"8C5E75723C249F020E54B1D2B2BCB0735566D537789B23F23B1373B33F24F21F"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SamaiRulingResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/process/v1":{"post":{"operationId":"secop_process","summary":"SECOP Process by Notice","description":"Resolve a Colombian public-procurement process (SECOP II) by its OpportunityDetail noticeUID and return the process header, the per-provider award list, and every awarded contract: providers, documents, values, dates, and execution amounts. Sourced from Colombia Compra Eficiente's open data. `found: false` when no process matches the noticeUID.","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["notice_uid"],"properties":{"notice_uid":{"type":"string","pattern":"^CO1\\.NTC\\.\\d{3,}$","description":"SECOP OpportunityDetail noticeUID, e.g. \"CO1.NTC.9458505\"."}},"additionalProperties":false},"example":{"notice_uid":"CO1.NTC.9458505"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopProcessResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/contracts-by-provider/v1":{"post":{"operationId":"secop_contracts_by_provider","summary":"SECOP Contracts by Provider","description":"Deprecated since 2026-08-30; stops answering on 2026-12-01. Use `POST /co/secop/contracts-search/v1` instead.\n\nList the public-procurement contracts (SECOP II) awarded to one provider by cédula or NIT, across all contracting entities: the contractor profile (who hired them, values, status, dates). Optional filters: contracting-entity NIT and a sign-date window (`from_date`/`to_date`). Pages of 500, newest first (`page`, 1-based); `capped: true` means the page is full and later pages may exist.","deprecated":true,"tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","pattern":"^[0-9A-Za-z.\\-]{4,24}$","description":"Provider cédula or NIT. Dots and a trailing verification digit are optional: `900195855`, `900195855-1` and `900.195.855-1` all match the same contractor."},"entity_nit":{"type":"string","pattern":"^(\\d{4,15})?$","default":"","description":"Optional contracting-entity NIT filter (digits, no verification digit)."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"document_number":"79372917"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopContractSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/processes-by-entity/v1":{"post":{"operationId":"secop_processes_by_entity","summary":"SECOP Processes by Entity","description":"Deprecated since 2026-08-30; stops answering on 2026-12-01. Use `POST /co/secop/processes-search/v1` instead.\n\nList the procurement processes (SECOP II) published by one contracting entity (by NIT), optionally within a publication-date window. The audit population for an entity. Returns lean summaries (drill into one with `secop-process`). Pages of 500, newest first (`page`, 1-based); `capped: true` means the page is full and later pages may exist.","deprecated":true,"tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","minLength":4,"maxLength":15,"pattern":"^\\d{4,15}$","description":"Colombian NIT (numeric, no verification digit). 4-15 digits."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"document_number":"899999061","from_date":"2026-01-01"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopProcessSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/contract/v1":{"post":{"operationId":"secop_contract","summary":"SECOP Contract by ID","description":"Resolve one electronic contract (SECOP II) by its contract id and return the full contract record plus its satellite history: registered additions/modifications, insurance policies (garantías) with insurer and validity, and the delivery plan with planned vs actual progress. `found: false` when no contract matches the id.","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contract_id"],"properties":{"contract_id":{"type":"string","pattern":"^CO1\\.PCCNTR\\.\\d{3,}$","description":"SECOP electronic contract id, e.g. \"CO1.PCCNTR.6794799\"."}},"additionalProperties":false},"example":{"contract_id":"CO1.PCCNTR.6794799"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopContractLookupResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/sanctions-by-provider/v1":{"post":{"operationId":"secop_sanctions_by_provider","summary":"SECOP Sanctions by Provider","description":"Deprecated since 2026-08-30; stops answering on 2026-12-01. Use `POST /co/secop/sanctions-search/v1` instead.\n\nList the fines and sanctions (multas y sanciones) recorded against one state contractor by cédula or NIT: sanctioning entity, resolution number, value, and the dates the sanction was published and became final. A direct adverse signal for counterparty screening, from Colombia Compra Eficiente's open data.","deprecated":true,"tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","pattern":"^[0-9A-Za-z.\\-]{4,24}$","description":"Provider cédula or NIT. Dots and a trailing verification digit are optional: `900195855`, `900195855-1` and `900.195.855-1` all match the same contractor."}},"additionalProperties":false},"example":{"document_number":"1067811412"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopSanctionSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/processes-search/v1":{"post":{"operationId":"secop_processes_search","summary":"SECOP Processes Search","description":"Search every Colombian public procurement process from SECOP II (2015 onward) and SECOP I (2004 onward) in one place. Full-text over what is being bought, plus filters on the buying entity's NIT, department, modality, contract type, status, UNSPSC category, year, publication-date range, estimated value and whether the process was awarded. Answers in milliseconds and covers both systems at once; use `secop-process` when you have a noticeUID and want one process with its awards and contracts.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the free text of the record (what is being bought, the entity and the supplier). Leave empty to filter without searching."},"platform":{"type":"string","enum":["any","secop_i","secop_ii"],"default":"any","description":"Restrict to one system: `secop_ii` (the transactional platform, 2015 onward), `secop_i` (the publication register, 2004 onward), or `any` for both."},"entity_nit":{"type":"string","maxLength":20,"default":"","description":"Optional document filter: a NIT or a cédula, with or without dots and verification digit (`900195855`, `900.195.855-1` and `900195855-1` all match the same records)."},"department":{"type":"string","maxLength":80,"default":"","description":"Optional department of the contracting entity, as SECOP writes it (`Antioquia`, `Bogotá D.C.`, ...). Empty for the whole country."},"modality":{"type":"string","maxLength":120,"default":"","description":"Optional modalidad de contratación, exactly as SECOP writes it (`Contratación directa`, `Licitación pública`, `Mínima cuantía`, ...). Empty for every modality."},"contract_type":{"type":"string","maxLength":120,"default":"","description":"Optional tipo de contrato, exactly as SECOP writes it (`Prestación de servicios`, `Obra`, `Suministros`, ...). Empty for every type."},"status":{"type":"string","maxLength":120,"default":"","description":"Optional estado, exactly as SECOP writes it (`Adjudicado`, `Celebrado`, `En ejecución`, `Terminado`, ...). Empty for every status."},"unspsc_code":{"type":"string","maxLength":40,"default":"","description":"Optional main UNSPSC category code of the purchase (`V1.80101500`). Empty for every category."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional calendar year. 0 searches every year."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"min_value":{"type":"number","minimum":0,"default":0,"description":"Optional lower bound on the amount, in COP. 0 means no lower bound."},"max_value":{"type":"number","minimum":0,"default":0,"description":"Optional upper bound on the amount, in COP. 0 means no upper bound."},"sort":{"type":"string","enum":["recent","oldest","value_desc","value_asc"],"default":"recent","description":"Order of the results: `recent` (newest first, the default), `oldest`, `value_desc` (largest amount first) or `value_asc`."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Results per page (1-100)."},"awarded":{"type":"string","enum":["any","yes","no"],"default":"any","description":"Restrict to processes that reached an award (`yes`), that did not (`no`), or `any`. Processes whose outcome the source does not state are excluded by `yes` and `no` alike."}},"additionalProperties":false},"example":{"query":"recolección de residuos","year":2025,"per_page":20}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopProcessesSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/contracts-search/v1":{"post":{"operationId":"secop_contracts_search","summary":"SECOP Contracts Search","description":"Search every contract the Colombian state has signed, across SECOP II (2015 onward) and SECOP I (2004 onward), in one shape. Full-text over the contract object and the parties, plus filters on the contractor's document (NIT or cédula, in any of the spellings SECOP prints), the entity NIT, department, sector, contract type, modality, status, UNSPSC category, year, signature-date range and amount. This is the endpoint for \"everything this company or person has contracted with the Colombian state\".\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the free text of the record (what is being bought, the entity and the supplier). Leave empty to filter without searching."},"platform":{"type":"string","enum":["any","secop_i","secop_ii"],"default":"any","description":"Restrict to one system: `secop_ii` (the transactional platform, 2015 onward), `secop_i` (the publication register, 2004 onward), or `any` for both."},"entity_nit":{"type":"string","maxLength":20,"default":"","description":"Optional document filter: a NIT or a cédula, with or without dots and verification digit (`900195855`, `900.195.855-1` and `900195855-1` all match the same records)."},"department":{"type":"string","maxLength":80,"default":"","description":"Optional department of the contracting entity, as SECOP writes it (`Antioquia`, `Bogotá D.C.`, ...). Empty for the whole country."},"modality":{"type":"string","maxLength":120,"default":"","description":"Optional modalidad de contratación, exactly as SECOP writes it (`Contratación directa`, `Licitación pública`, `Mínima cuantía`, ...). Empty for every modality."},"contract_type":{"type":"string","maxLength":120,"default":"","description":"Optional tipo de contrato, exactly as SECOP writes it (`Prestación de servicios`, `Obra`, `Suministros`, ...). Empty for every type."},"status":{"type":"string","maxLength":120,"default":"","description":"Optional estado, exactly as SECOP writes it (`Adjudicado`, `Celebrado`, `En ejecución`, `Terminado`, ...). Empty for every status."},"unspsc_code":{"type":"string","maxLength":40,"default":"","description":"Optional main UNSPSC category code of the purchase (`V1.80101500`). Empty for every category."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional calendar year. 0 searches every year."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"min_value":{"type":"number","minimum":0,"default":0,"description":"Optional lower bound on the amount, in COP. 0 means no lower bound."},"max_value":{"type":"number","minimum":0,"default":0,"description":"Optional upper bound on the amount, in COP. 0 means no upper bound."},"sort":{"type":"string","enum":["recent","oldest","value_desc","value_asc"],"default":"recent","description":"Order of the results: `recent` (newest first, the default), `oldest`, `value_desc` (largest amount first) or `value_asc`."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Results per page (1-100)."},"provider_document":{"type":"string","maxLength":20,"default":"","description":"Optional document filter: a NIT or a cédula, with or without dots and verification digit (`900195855`, `900.195.855-1` and `900195855-1` all match the same records)."},"sector":{"type":"string","maxLength":80,"default":"","description":"Optional sector of the contracting entity (`Salud y Protección Social`, `Educación Nacional`, ...). Published on SECOP II contracts only. Empty for every sector."}},"additionalProperties":false},"example":{"provider_document":"900195855","sort":"value_desc","per_page":20}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopContractsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/modifications-search/v1":{"post":{"operationId":"secop_modifications_search","summary":"SECOP Contract Modifications Search","description":"Search the changes made to Colombian public contracts after signature: additions, extensions and other modifications, with how much money and how many days each one added. Filter by contract id, platform, year, registration-date range and a minimum added amount, and sort by amount to find the contracts that grew the most after they were awarded.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the free text of the record (what is being bought, the entity and the supplier). Leave empty to filter without searching."},"contract_id":{"type":"string","maxLength":120,"default":"","description":"Optional contract id from a search result (`id` on a contract). Empty searches every contract."},"platform":{"type":"string","enum":["any","secop_i","secop_ii"],"default":"any","description":"Restrict to one system: `secop_ii` (the transactional platform, 2015 onward), `secop_i` (the publication register, 2004 onward), or `any` for both."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional calendar year. 0 searches every year."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"min_value":{"type":"number","minimum":0,"default":0,"description":"Optional lower bound on the amount, in COP. 0 means no lower bound."},"sort":{"type":"string","enum":["recent","oldest","value_desc","value_asc"],"default":"recent","description":"Order of the results: `recent` (newest first, the default), `oldest`, `value_desc` (largest amount first) or `value_asc`."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Results per page (1-100)."}},"additionalProperties":false},"example":{"min_value":1000000000,"sort":"value_desc","per_page":20}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopModificationsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/suppliers-search/v1":{"post":{"operationId":"secop_suppliers_search","summary":"SECOP Suppliers Search","description":"Search the suppliers registered on SECOP II: who they are, the document they registered under, what category they sell in, where they are, and whether the account is still active. Use it to resolve a company name to its NIT before searching contracts, or to check that a contractor is a registered supplier at all.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the free text of the record (what is being bought, the entity and the supplier). Leave empty to filter without searching."},"document":{"type":"string","maxLength":20,"default":"","description":"Optional document filter: a NIT or a cédula, with or without dots and verification digit (`900195855`, `900.195.855-1` and `900195855-1` all match the same records)."},"department":{"type":"string","maxLength":80,"default":"","description":"Optional department of the contracting entity, as SECOP writes it (`Antioquia`, `Bogotá D.C.`, ...). Empty for the whole country."},"unspsc_code":{"type":"string","maxLength":40,"default":"","description":"Optional main UNSPSC category code of the purchase (`V1.80101500`). Empty for every category."},"active":{"type":"string","enum":["any","yes","no"],"default":"any","description":"Restrict to active supplier accounts (`yes`), inactive ones (`no`), or `any`."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Results per page (1-100)."}},"additionalProperties":false},"example":{"query":"constructora","department":"Antioquia","per_page":20}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopSuppliersSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/bidders-search/v1":{"post":{"operationId":"secop_bidders_search","summary":"SECOP Bidders Search","description":"Search who bid on Colombian procurement processes, including the bidders that lost. Filter by process id or by a bidder's document to see either everyone who competed for one contract, or every process a company has bid on. This is the only published view of how contested a tender actually was.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"process_id":{"type":"string","maxLength":120,"default":"","description":"Optional process id from a search result (`id` on a process, or `process_id` on a bidder). Empty searches every process."},"bidder_document":{"type":"string","maxLength":20,"default":"","description":"Optional document filter: a NIT or a cédula, with or without dots and verification digit (`900195855`, `900.195.855-1` and `900195855-1` all match the same records)."},"platform":{"type":"string","enum":["any","secop_i","secop_ii"],"default":"any","description":"Restrict to one system: `secop_ii` (the transactional platform, 2015 onward), `secop_i` (the publication register, 2004 onward), or `any` for both."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional calendar year. 0 searches every year."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Results per page (1-100)."}},"additionalProperties":false},"example":{"bidder_document":"900195855","per_page":20}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopBiddersSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/sanctions-search/v1":{"post":{"operationId":"secop_sanctions_search","summary":"SECOP Sanctions Search","description":"Search the fines and sanctions Colombian public entities have imposed on their contractors: who was sanctioned, under which contract, for how much, and when the sanction became final. Filter by the contractor's document, the entity's NIT, the year or a publication-date range.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the free text of the record (what is being bought, the entity and the supplier). Leave empty to filter without searching."},"provider_document":{"type":"string","maxLength":20,"default":"","description":"Optional document filter: a NIT or a cédula, with or without dots and verification digit (`900195855`, `900.195.855-1` and `900195855-1` all match the same records)."},"entity_nit":{"type":"string","maxLength":20,"default":"","description":"Optional document filter: a NIT or a cédula, with or without dots and verification digit (`900195855`, `900.195.855-1` and `900195855-1` all match the same records)."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional calendar year. 0 searches every year."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Results per page (1-100)."}},"additionalProperties":false},"example":{"query":"incumplimiento","per_page":20}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopSanctionsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/plans-search/v1":{"post":{"operationId":"secop_plans_search","summary":"SECOP Annual Procurement Plans Search","description":"Search the Plan Anual de Adquisiciones each Colombian public entity publishes: the budget it expects to spend that year and the thresholds it will buy under, published before it buys any of it. Filter by entity NIT, department, year or platform to see what an entity intends to procure rather than what it already has.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the free text of the record (what is being bought, the entity and the supplier). Leave empty to filter without searching."},"department":{"type":"string","maxLength":80,"default":"","description":"Optional department of the contracting entity, as SECOP writes it (`Antioquia`, `Bogotá D.C.`, ...). Empty for the whole country."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional calendar year. 0 searches every year."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Results per page (1-100)."}},"additionalProperties":false},"example":{"year":2026,"per_page":20}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopPlansSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/profile/v1":{"post":{"operationId":"secop_profile","summary":"SECOP Profile","description":"Everything Colombian public procurement knows about one NIT or cédula, in a single call: the SECOP II supplier account if there is one, how many contracts it has signed and the largest of them, how many awards it has won, how many processes it has bid on, every sanction against it, and, when the document belongs to a public entity, what it has bought. Start here for any question about a company or a person; the searches are for paging past what this returns.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document"],"properties":{"document":{"type":"string","pattern":"^[0-9A-Za-z.\\-]{4,24}$","description":"Provider cédula or NIT. Dots and a trailing verification digit are optional: `900195855`, `900195855-1` and `900.195.855-1` all match the same contractor."},"per_section":{"type":"integer","minimum":1,"maximum":25,"default":5,"description":"How many records each list in the response holds (1-25). The counts beside the lists are exact totals regardless of this."}},"additionalProperties":false},"example":{"document":"900195855"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopProfileResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/awards-search/v1":{"post":{"operationId":"secop_awards_search","summary":"SECOP Awards Search","description":"Search every award made on a Colombian procurement process on SECOP II: which provider won, how much of the award was theirs, and when. The processes dataset keeps one row per process, so a framework agreement that awarded thousands of providers shows only one there; this is where all of them are. Filter by the provider's document to see everything a company has been awarded, as opposed to what it went on to sign.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the free text of the record (what is being bought, the entity and the supplier). Leave empty to filter without searching."},"provider_document":{"type":"string","maxLength":20,"default":"","description":"Optional document filter: a NIT or a cédula, with or without dots and verification digit (`900195855`, `900.195.855-1` and `900195855-1` all match the same records)."},"entity_nit":{"type":"string","maxLength":20,"default":"","description":"Optional document filter: a NIT or a cédula, with or without dots and verification digit (`900195855`, `900.195.855-1` and `900195855-1` all match the same records)."},"process_id":{"type":"string","maxLength":120,"default":"","description":"Optional process id from a search result (`id` on a process, or `process_id` on a bidder). Empty searches every process."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional calendar year. 0 searches every year."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"min_value":{"type":"number","minimum":0,"default":0,"description":"Optional lower bound on the amount, in COP. 0 means no lower bound."},"max_value":{"type":"number","minimum":0,"default":0,"description":"Optional upper bound on the amount, in COP. 0 means no upper bound."},"sort":{"type":"string","enum":["recent","oldest","value_desc","value_asc"],"default":"recent","description":"Order of the results: `recent` (newest first, the default), `oldest`, `value_desc` (largest amount first) or `value_asc`."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Results per page (1-100)."}},"additionalProperties":false},"example":{"provider_document":"900195855","sort":"value_desc","per_page":20}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopAwardsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/process-record/v1":{"post":{"operationId":"secop_process_record","summary":"SECOP Process Record","description":"Read one procurement process by the platform-prefixed `id` a SECOP search returned (e.g. `secop_ii:CO1.REQ.1234567`). Works for SECOP I and SECOP II alike and answers in milliseconds; for the live view of a SECOP II process with its per-provider awards and awarded contracts attached, use `secop-process` with the noticeUID instead.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["record_id"],"properties":{"record_id":{"type":"string","minLength":3,"maxLength":120,"description":"Record id from a SECOP search result (`id`), platform-prefixed: e.g. `secop_ii:CO1.PCCNTR.4168447`, `secop_i:20-11-10442331`."}},"additionalProperties":false},"example":{"record_id":"secop_ii:CO1.REQ.1234567"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopProcessRecordResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/secop/contract-record/v1":{"post":{"operationId":"secop_contract_record","summary":"SECOP Contract Record","description":"Read one contract by the platform-prefixed `id` a SECOP search returned (e.g. `secop_ii:CO1.PCCNTR.4168447`). Works for SECOP I and SECOP II alike and answers in milliseconds; for the live view of a SECOP II contract with its additions, guarantees and delivery plan attached, use `secop-contract` with the contract id instead.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SECOP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/secop"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["record_id"],"properties":{"record_id":{"type":"string","minLength":3,"maxLength":120,"description":"Record id from a SECOP search result (`id`), platform-prefixed: e.g. `secop_ii:CO1.PCCNTR.4168447`, `secop_i:20-11-10442331`."}},"additionalProperties":false},"example":{"record_id":"secop_ii:CO1.PCCNTR.4168447"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecopContractRecordResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/simit/account-status/v1":{"post":{"operationId":"simit_account_status","summary":"SIMIT Account Status","description":"Look up a SIMIT (Sistema Integrado de Información sobre Multas y Sanciones por Infracciones de Tránsito) account status by vehicle plate or by a person's identification number. Returns outstanding comparendos and multas (each with the offending party, infraction codes and descriptions, traffic authority, department, amounts, and the discount/payment projections), the account totals, any payment agreements (acuerdos de pago), and driving courses (cursos viales). `is_plate` reports whether the value was matched as a plate. `clear: true` means paz y salvo (nothing outstanding).\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","SIMIT"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/simit"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","minLength":4,"maxLength":20,"pattern":"^[A-Za-z0-9]{4,20}$","description":"Vehicle plate (e.g. `ABC123`) or identification number to look up."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_number":"ABC123"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimitAccountStatusResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/superfinanciera/regulations-search/v1":{"post":{"operationId":"superfinanciera_regulations_search","summary":"Superfinanciera Regulations Search","description":"Search every Circular Externa, Carta Circular and Resolución the Superintendencia Financiera de Colombia has issued since 2005, across all kinds and years at once. Filter by free text over the official description, by `kind`, `year`, exact `number` (with or without leading zeros), the `bulletin` it was published in, and the date it was issued (`issued_from`/`issued_to`). Results come back newest first with the Superintendencia's own description of what each act does and a link to the act itself. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Superfinanciera"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/superfinanciera"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the official description of the act and its number."},"kind":{"type":"string","enum":["any","circular_externa","carta_circular","resolucion"],"default":"any","description":"Kind of act: `circular_externa` (binding instructions), `carta_circular` (informative), `resolucion` (administrative act), or `any`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the act was issued (2005 or later). 0 searches every year."},"number":{"type":"string","maxLength":40,"default":"","description":"Optional act number, with or without leading zeros (`7`, `007`, `1195`). A few acts carry a written number, e.g. `Conjunta 002`."},"bulletin":{"type":"string","maxLength":20,"default":"","description":"Optional issue number of the Boletín del Ministerio de Hacienda y Crédito Público the act was published in."},"issued_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"issued_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"riesgo de crédito","kind":"circular_externa"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuperfinancieraRegulationsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/superfinanciera/regulation/v1":{"post":{"operationId":"superfinanciera_regulation","summary":"Superfinanciera Regulation","description":"Retrieve one act of the Superintendencia Financiera de Colombia by its `regulation_id` from the search results (e.g. `ce:2026:7` for Circular Externa 007 de 2026, `cc:2026:56`, `res:2026:1195`), with its official description, the date it was issued, the bulletin it was published in and a link to the act.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Superfinanciera"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/superfinanciera"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["regulation_id"],"properties":{"regulation_id":{"type":"string","minLength":3,"maxLength":80,"description":"Act identifier from the search results (`id`), e.g. `ce:2026:7`, `cc:2026:56`, `res:2026:1195`."}},"additionalProperties":false},"example":{"regulation_id":"ce:2026:7"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuperfinancieraRegulationResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/superfinanciera/complaints/v1":{"post":{"operationId":"superfinanciera_complaints","summary":"Superfinanciera Complaints","description":"Return the action history of a specific jurisdictional complaint filed against a person or entity at Colombia's Superfinanciera.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","Superfinanciera"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/superfinanciera"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number","filing_number"],"properties":{"document_number":{"type":"string","pattern":"^\\d{5,20}$","description":"Document or NIT of the complainant."},"filing_number":{"type":"string","pattern":"^\\d{10}$","description":"10-digit filing number (numeroRadicacion) assigned by Superfinanciera when the complaint was filed."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_number":"1234567890","filing_number":"2024051440"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuperfinancieraResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/superfinanciera-doctrine/search/v1":{"post":{"operationId":"superfinanciera_doctrine_search","summary":"Superfinanciera Doctrine Search","description":"Search the Superintendencia Financiera de Colombia's doctrine and case-law catalog: every concepto it has issued since 1994 (the Superintendencia Bancaria's before 2005), every ruling of its Delegatura para Funciones Jurisdiccionales, and the high-court rulings it catalogues as jurisprudencia financiera. Free text matches the number, case file number, title, summary, subject descriptors and full text. Filter by `collection`, `year`, `number`, `registration_number` (expediente or radicado), `issuer`, `topic`, the date (`from_date`/`to_date`) and `text_status`. Each result links to its entry in the Superintendencia's catalog and to the document. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Superfinanciera Doctrina"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/superfinanciera-doctrine"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the document's number, case file number, title, summary, topics and full text."},"collection":{"type":"string","enum":["any","concept","jurisdictional_ruling","financial_case_law","other"],"default":"any","description":"Part of the catalog: `concept` (conceptos, the SFC's doctrine), `jurisdictional_ruling` (fallos of its Delegatura para Funciones Jurisdiccionales), `financial_case_law` (high-court sentencias the SFC catalogues as jurisprudencia financiera), `other`, or `any`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the SFC files the document under (the year it was issued, in almost every case). 0 searches every year."},"number":{"type":"string","maxLength":60,"default":"","description":"Optional number of the concepto, fallo or sentencia as the SFC prints it (`2020311455-001`, `2017-1900`, `T-123`). Case, spaces and leading zeros are ignored."},"registration_number":{"type":"string","maxLength":80,"default":"","description":"Optional case file number (expediente or radicado) of a fallo or sentencia, e.g. `2019123456`. Case, spaces and punctuation are ignored."},"issuer":{"type":"string","maxLength":160,"default":"","description":"Optional issuer, matched from the start of the name: `superintendencia financiera` (its Delegatura para Funciones Jurisdiccionales included), `superintendencia bancaria`, `corte constitucional`, `consejo de estado`, `corte suprema`. Case and accents are ignored."},"topic":{"type":"string","maxLength":160,"default":"","description":"Optional subject descriptor, as the SFC publishes it in `topics`, e.g. `PROTECCIÓN AL CONSUMIDOR FINANCIERO`. Case and accents are ignored."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"text_status":{"type":"string","enum":["any","extracted","no_text_layer","audio","dead_link","withdrawn","no_document"],"default":"any","description":"Optional state of the document's text: `extracted` (the full text is here), `no_text_layer` (a scan or a format with no text to read), `audio` (a hearing published as a recording), `dead_link` (the SFC's link leads to no document), `withdrawn`, `no_document`, or `any`."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"consumidor financiero","collection":"concept"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuperfinancieraDoctrineSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/superfinanciera-doctrine/entry/v1":{"post":{"operationId":"superfinanciera_doctrine_entry","summary":"Superfinanciera Doctrine Entry","description":"Retrieve one document of the Superintendencia Financiera de Colombia's doctrine and case-law catalog by the `id` from the search results: its full text where the document carries text, the SFC's summary and subject descriptors, the number, the date, the issuer, the case file number, and links to its entry in the catalog and to the document itself. The text comes back a character range at a time (`offset`, `limit`); follow `next_offset` until `has_more` is false.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Superfinanciera Doctrina"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/superfinanciera-doctrine"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["entry_id"],"properties":{"entry_id":{"type":"string","pattern":"^\\s*\\d{1,9}\\s*$","description":"Catalog identifier from the search results (`id`), e.g. `18717`."},"offset":{"type":"integer","minimum":0,"maximum":10000000,"default":0,"description":"First character of the range to return. Pass the previous response's `next_offset` to continue reading."},"limit":{"type":"integer","minimum":1000,"maximum":1000000,"default":200000,"description":"Maximum characters to return (1000-1000000)."}},"additionalProperties":false},"example":{"entry_id":"1"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuperfinancieraDoctrineEntryResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/adres/affiliation-status/v1":{"post":{"operationId":"adres_affiliation_status","summary":"ADRES Health Affiliation Status","description":"Look up a person's affiliation to the Colombian health system (BDUA): the entities (EPS) they are or were affiliated to, the régimen (contributivo/subsidiado), affiliation dates, and affiliate type. `document_type` defaults to `CC`. Returns `found: false` when the document is not registered in BDUA.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","ADRES"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/adres"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_type":{"type":"string","enum":["CC","TI","CE","RC","PA","PEP","PPT"],"default":"CC","description":"Colombian document type. Defaults to `CC`."},"document_number":{"type":"string","minLength":3,"maxLength":30,"description":"Document number (alphanumeric with hyphens allowed)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_type":"CC","document_number":"1234567890"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdresAffiliationResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/dnp/social-classification/v1":{"post":{"operationId":"dnp_social_classification","summary":"DNP Social Classification (Sisbén IV and RUI)","description":"Look up a person's socioeconomic classification in Colombia by document, live from the DNP: the Sisbén IV group (`A1` to `D21`, with its category and label) and the RUI income classification with the registered name, sex, age and municipality. `document_type` defaults to `CC`. Returns `found: false` when the person has neither.","tags":["Colombia","Departamento Nacional de Planeación (DNP)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dnp"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_type":{"type":"string","enum":["CC","TI","CE","RC","PA","PEP","PPT"],"default":"CC","description":"Colombian document type. Defaults to `CC`."},"document_number":{"type":"string","minLength":3,"maxLength":30,"description":"Document number (alphanumeric with hyphens allowed)."}},"additionalProperties":false},"example":{"document_type":"CC","document_number":"1234567890"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnpSocialClassificationResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/dnp/sisben-offices/v1":{"post":{"operationId":"dnp_sisben_offices","summary":"DNP Sisbén Offices","description":"The directory of Sisbén offices, from the DNP: every department's coordinator, or with `department_code` (two-digit DIVIPOLA) that department's coordinator and the administrator of each of its municipalities, with address, phone and email.","tags":["Colombia","Departamento Nacional de Planeación (DNP)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dnp"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"department_code":{"type":"string","enum":["","05","08","11","13","15","17","18","19","20","23","25","27","41","44","47","50","52","54","63","66","68","70","73","76","81","85","86","88","91","94","95","97","99"],"default":"","description":"Código DIVIPOLA de dos dígitos del departamento (p. ej. `05` Antioquia, `11` Bogotá). Vacío lista a los coordinadores de todos los departamentos."}},"additionalProperties":false},"example":{"department_code":"05"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnpSisbenOfficesResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/supersociedades/financial-statements/v1":{"post":{"operationId":"supersociedades_financial_statements","summary":"Supersociedades Financial Statements","description":"Annual financial statements a Colombian company has filed with the Superintendencia de Sociedades, by NIT: income statement, balance sheet and cash flow per fiscal year, plus the company identity from the filing cover. One filing per year (the preferred entry point, latest re-submission), newest first, up to 10 years. Figures come as filed, in the unit the filing declares.","tags":["Colombia","Supersociedades"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","minLength":4,"maxLength":15,"pattern":"^\\d{4,15}$","description":"Colombian NIT (numeric, no verification digit). 4-15 digits."}},"additionalProperties":false},"example":{"document_number":"900249127"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupersociedadesFinancialStatementsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/dof/publications-by-date/v1":{"post":{"operationId":"dof_publications_by_date","summary":"DOF Publications by Date","description":"Everything published in Mexico's official federal gazette (Diario Oficial de la Federación) on a given date: decrees, law reforms, and regulator disposiciones across the morning, evening, and extraordinary editions, each with its issuing branch and agency. The gazette is organised by day, so a date is the only way in; it publishes the decree that created or amended a law, never the consolidated current text of one. For that, use `diputados-federal-law`. The index reaches back to 1917, while machine-readable text starts with the 1973 volume: `has_text: true` marks publications retrievable with `dof-publication`, and every entry carries `scan_url` for the official scanned page.","tags":["Mexico","DOF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/dof"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["date"],"properties":{"date":{"type":"string","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Gazette date (yyyy-mm-dd). The index reaches back to 1917; machine-readable text starts with the 1973 volume, and earlier publications are served as scans."}},"additionalProperties":false},"example":{"date":"2026-07-16"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DofPublicationsByDateResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/dof/publication/v1":{"post":{"operationId":"dof_publication","summary":"DOF Publication","description":"Retrieve one publication from Mexico's official federal gazette (DOF) by id, including its plain text when the publication is machine-readable. Publications range from a few hundred characters to entire decrees, so the text is returned in character ranges: `content.total_length` is the full size, and when `content.has_more` is true request the next range with `offset: content.next_offset`. Anything published before the 1973 volume is held only as a scan and returns `is_image_only: true` with `content: null`, its metadata, and `scan_url` for the official scanned page. This returns one gazette publication, not the consolidated text of a law; for that use `diputados-federal-law`.","tags":["Mexico","DOF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/dof"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["publication_id"],"properties":{"publication_id":{"type":"string","pattern":"^\\d{1,12}$","description":"Publication id (`id` from publications-by-date or search results)."},"offset":{"type":"integer","minimum":0,"maximum":10000000,"default":0,"description":"First character of the range to return. Pass the previous response's `next_offset` to continue reading."},"limit":{"type":"integer","minimum":1000,"maximum":1000000,"default":200000,"description":"Maximum characters to return (1000-1000000)."}},"additionalProperties":false},"example":{"publication_id":"5778302"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DofPublicationResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/fiscalias/cdmx/bulletins/v1":{"post":{"operationId":"fiscalia_cdmx_bulletins","summary":"Fiscalía CDMX Bulletins","description":"Browse the public press bulletins (comunicados) of the Mexico City prosecutor, most recent first, paged with `page` (10 per page). Each bulletin carries its comunicado `code`, date, headline, and summary. These are public press releases, not a criminal-record database: a name in a bulletin is an indicio, never proof, and procedural stage must not be read as a conviction.","tags":["Mexico","Fiscalía General de Justicia de la Ciudad de México"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/fiscalias"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"page":1}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiscaliaCdmxBulletinsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/fiscalias/chiapas/bulletins/v1":{"post":{"operationId":"fiscalia_chiapas_bulletins","summary":"Fiscalía Chiapas Bulletins","description":"Browse the public press bulletins (comunicados) of the Chiapas state prosecutor, most recent first; page forward with `page` until `has_more` is false. Each bulletin carries its comunicado number, classification, date, headline, and summary. These are public press releases, not a criminal-record database: a name in a bulletin is an indicio, never proof, and procedural stage must not be read as a conviction.","tags":["Mexico","Fiscalía General del Estado de Chiapas"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/fiscalias"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"page":1}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiscaliaChiapasBulletinsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/fiscalias/chihuahua/bulletins/v1":{"post":{"operationId":"fiscalia_chihuahua_bulletins","summary":"Fiscalía Chihuahua Bulletins","description":"Search the public press bulletins (comunicados) of the Chihuahua state prosecutor. Free-text `query` searches the corpus; omit it for the most recent. Optional `from_date`/`to_date` bound the range. Each bulletin announces one procedural event (arrest, imputation, conviction, sentence); the `categories` name the acting unit. These are public press releases, not a criminal-record database: a name in a bulletin is an indicio, never proof, and procedural stage must not be read as a conviction.","tags":["Mexico","Fiscalía General del Estado de Chihuahua"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/fiscalias"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Free-text search over the bulletins. Omit for the most recent."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date bound (yyyy-mm-dd). Omit for no bound."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date bound (yyyy-mm-dd). Omit for no bound."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"query":"homicidio"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiscaliaChihuahuaBulletinsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/fiscalias/edomex/bulletins/v1":{"post":{"operationId":"fiscalia_edomex_bulletins","summary":"Fiscalía Estado de México Bulletins","description":"Browse the public press bulletins (comunicados) of the Estado de México prosecutor, most recent first; page forward with `page` until `has_more` is false. Each bulletin carries its comunicado `code`, date, headline, and a link to the full document. These are public press releases, not a criminal-record database: a name in a bulletin is an indicio, never proof, and procedural stage must not be read as a conviction.","tags":["Mexico","Fiscalía General de Justicia del Estado de México"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/fiscalias"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"page":1}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiscaliaEdomexBulletinsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/fiscalias/fgr/bulletins/v1":{"post":{"operationId":"fiscalia_fgr_bulletins","summary":"FGR Bulletins","description":"Browse the public press bulletins (comunicados) of the federal prosecutor (FGR), most recent first; page forward with `page` until `has_more` is false. Each item carries its bulletin `code`, `scope` (national or state), date, and headline, and links to the full comunicado. These are public press releases, not a criminal-record database: a name in a bulletin is an indicio, never proof, and procedural stage must not be read as a conviction.","tags":["Mexico","Fiscalía General de la República"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/fiscalias"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"page":1}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiscaliaFgrBulletinsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/fiscalias/jalisco/bulletins/v1":{"post":{"operationId":"fiscalia_jalisco_bulletins","summary":"Fiscalía Jalisco Bulletins","description":"Search the public press bulletins (comunicados) of the Jalisco state prosecutor. Free-text `query` searches the corpus; omit it for the most recent. Each bulletin announces one procedural event (arrest, imputation, conviction, sentence) and carries the issuing author and tags. These are public press releases, not a criminal-record database: a name in a bulletin is an indicio, never proof, and procedural stage must not be read as a conviction.","tags":["Mexico","Fiscalía del Estado de Jalisco"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/fiscalias"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Free-text search over the bulletins. Omit for the most recent."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"query":"vinculado a proceso"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiscaliaJaliscoBulletinsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/fiscalias/nuevoleon/bulletins/v1":{"post":{"operationId":"fiscalia_nuevoleon_bulletins","summary":"Fiscalía Nuevo León Bulletins","description":"Search the public press bulletins (comunicados) of the Nuevo León prosecutor. Free-text `query` searches the corpus; omit it for the most recent. Each bulletin carries its date, headline, and summary. These are public press releases, not a criminal-record database: a name in a bulletin is an indicio, never proof, and procedural stage must not be read as a conviction.","tags":["Mexico","Fiscalía General de Justicia del Estado de Nuevo León"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/fiscalias"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Free-text search over the bulletins. Omit for the most recent."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"query":"homicidio"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiscaliaNuevoleonBulletinsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/fiscalias/puebla/bulletins/v1":{"post":{"operationId":"fiscalia_puebla_bulletins","summary":"Fiscalía Puebla Bulletins","description":"Search the public press bulletins (comunicados) of the Puebla state prosecutor. Free-text `query` searches the corpus; omit it for the most recent. Each bulletin carries its numbered boletín, date, and headline. These are public press releases, not a criminal-record database: a name in a bulletin is an indicio, never proof, and procedural stage must not be read as a conviction.","tags":["Mexico","Fiscalía General del Estado de Puebla"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/fiscalias"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Free-text search over the bulletins. Omit for the most recent."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"query":"homicidio"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiscaliaPueblaBulletinsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/fiscalias/veracruz/bulletins/v1":{"post":{"operationId":"fiscalia_veracruz_bulletins","summary":"Fiscalía Veracruz Bulletins","description":"Search the public press bulletins (comunicados) of the Veracruz state prosecutor. Free-text `query` searches the corpus; omit it for the most recent. Optional `from_date`/`to_date` bound the range. Each bulletin announces one procedural event (arrest, imputation, conviction, sentence). These are public press releases, not a criminal-record database: a name in a bulletin is an indicio, never proof, and procedural stage must not be read as a conviction.","tags":["Mexico","Fiscalía General del Estado de Veracruz"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/fiscalias"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Free-text search over the bulletins. Omit for the most recent."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date bound (yyyy-mm-dd). Omit for no bound."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date bound (yyyy-mm-dd). Omit for no bound."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"query":"detenido"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiscaliaVeracruzBulletinsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/fiscalias/zacatecas/bulletins/v1":{"post":{"operationId":"fiscalia_zacatecas_bulletins","summary":"Fiscalía Zacatecas Bulletins","description":"Browse the public press bulletins (comunicados) of the Zacatecas state prosecutor, most recent first; page forward with `page` until `has_more` is false. Each bulletin announces one procedural event (arrest, imputation, conviction, sentence) and carries the full text. These are public press releases, not a criminal-record database: a name in a bulletin is an indicio, never proof, and procedural stage must not be read as a conviction.","tags":["Mexico","Fiscalía General de Justicia del Estado de Zacatecas"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/fiscalias"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"page":1}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiscaliaZacatecasBulletinsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/scjn/tesis-search/v1":{"post":{"operationId":"scjn_tesis_search","summary":"SCJN Tesis Search","description":"Search the Mexican Supreme Court's case law: every tesis and jurisprudencia the Semanario Judicial de la Federación has published since 1911 (300k+), each in full. Match words in the title and text (`query`, optional; every word must appear) and filter by binding force (`tesis_type`: jurisprudencia vs aislada), subject (materia), época number, year, deciding level (`instance`), court or chamber, how the criterion was formed (`formation`), publication window (`published_from`/`published_to`) and the court's own modification date (`updated_after`). Newest first, pages of up to 50 full records; `as_of` says how current the data is. Read one by its registro digital with `scjn-tesis`.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Mexico","SCJN"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/scjn"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional words to match in the title and text of the tesis."},"tesis_type":{"type":"string","enum":["any","jurisprudencia","aislada"],"default":"any","description":"Filter by tesis type: binding `jurisprudencia`, non-binding `aislada`, or `any`."},"subject":{"type":"string","maxLength":60,"default":"","description":"Optional subject filter (e.g. `Civil`, `Constitucional`)."},"epoch":{"type":"string","default":"","description":"Optional época number filter (`5` through `12`)."},"year":{"type":"string","default":"","description":"Optional 4-digit year filter."},"instance":{"type":"string","maxLength":80,"default":"","description":"Optional deciding level, exactly as the source names it (e.g. `Suprema Corte de Justicia de la Nación`, `Tribunales Colegiados de Circuito`, `Plenos Regionales`)."},"court":{"type":"string","maxLength":200,"default":"","description":"Optional court or chamber, exactly as `court` reads in results (e.g. `Primera Sala`, `Pleno`)."},"formation":{"type":"string","maxLength":120,"default":"","description":"Optional way the criterion was formed, exactly as the source names it (e.g. `Reiteración`, `Contradicción de criterios (antes contradicción de tesis)`)."},"published_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"published_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"updated_after":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Results per page (1-50). Every result carries the full text of the tesis."}},"additionalProperties":false},"example":{"query":"interés usurario","tesis_type":"jurisprudencia"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScjnTesisSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/scjn/tesis/v1":{"post":{"operationId":"scjn_tesis","summary":"SCJN Tesis","description":"Retrieve one tesis by its registro digital (`registration_number`), including the full text, citation (clave, época, localización), subjects, precedent notes, and linked ruling ids.","tags":["Mexico","SCJN"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/scjn"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["registration_number"],"properties":{"registration_number":{"type":"string","pattern":"^\\d{4,10}$","description":"Registro digital of the tesis (`registration_number` from search)."}},"additionalProperties":false},"example":{"registration_number":"2001360"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScjnTesisResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/scjn/tesis-browse/v1":{"post":{"operationId":"scjn_tesis_browse","summary":"SCJN Tesis Browse","description":"Deprecated since 2026-09-07; stops answering on 2026-12-15. Use `POST /mx/scjn/tesis-search/v1` instead.\n\nSame request and response as `scjn-tesis-search`, which replaces it: the Mexican Supreme Court's case law in full, filtered by words in the title and text, binding force, subject, época, year, instance, court, formation, publication window and the court's modification date. Newest first, pages of up to 20 full records, with `as_of`.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","deprecated":true,"x-served-from":"dataset","tags":["Mexico","SCJN"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/scjn"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional words to match in the title and text of the tesis."},"tesis_type":{"type":"string","enum":["any","jurisprudencia","aislada"],"default":"any","description":"Filter by tesis type: binding `jurisprudencia`, non-binding `aislada`, or `any`."},"subject":{"type":"string","maxLength":60,"default":"","description":"Optional subject filter (e.g. `Civil`, `Constitucional`)."},"epoch":{"type":"string","default":"","description":"Optional época number filter (`5` through `12`)."},"year":{"type":"string","default":"","description":"Optional 4-digit year filter."},"instance":{"type":"string","maxLength":80,"default":"","description":"Optional deciding level, exactly as the source names it (e.g. `Suprema Corte de Justicia de la Nación`, `Tribunales Colegiados de Circuito`, `Plenos Regionales`)."},"court":{"type":"string","maxLength":200,"default":"","description":"Optional court or chamber, exactly as `court` reads in results (e.g. `Primera Sala`, `Pleno`)."},"formation":{"type":"string","maxLength":120,"default":"","description":"Optional way the criterion was formed, exactly as the source names it (e.g. `Reiteración`, `Contradicción de criterios (antes contradicción de tesis)`)."},"published_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"published_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"updated_after":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":20,"default":10,"description":"Results per page (1-20). Every result carries the full text of the tesis."}},"additionalProperties":false},"example":{"subject":"Civil","tesis_type":"jurisprudencia","published_from":"2026-01-01"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScjnTesisBrowseResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/banxico/circulars/v1":{"post":{"operationId":"banxico_circulars","summary":"Banxico Circulars","description":"The chronological index of every circular and disposición issued by Banco de México (1,200+ entries back to 1969), each with subject, abrogation status, and which base circular it modifies. One row per index entry: a circular amending several bases appears once per base. Optional `year` filters one year. Paged, 100 per page; drill into one with `banxico-circular`.","tags":["Mexico","Banco de México"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/banxico"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"year":{"type":"string","default":"","description":"Optional 4-digit year filter."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"year":"2026"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanxicoCircularsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/banxico/circular/v1":{"post":{"operationId":"banxico_circular","summary":"Banxico Circular","description":"One Banco de México circular in full, by its `number`: subject, obligated entities, the consolidated (compiled) text PDF, the original text PDF with its DOF date, and every modification with dates and PDFs. Amendment circulars have no page of their own: looking one up returns the amended base circular (its `number` says which), whose modifications list carries the requested número.","tags":["Mexico","Banco de México"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/banxico"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number"],"properties":{"number":{"type":"string","minLength":1,"maxLength":80,"description":"Circular number as listed (e.g. `3/2012`, `E-126/2013`). Matching is case-insensitive."}},"additionalProperties":false},"example":{"number":"3/2012"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanxicoCircularResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/cnbv/regulations/v1":{"post":{"operationId":"cnbv_regulations","summary":"CNBV Regulations","description":"The CNBV's current regulatory catalog (~113 normas: leyes, disposiciones de carácter general including the Circular Única de Bancos, circulares, acuerdos, reglas), each with type, DOF publication date, applicable sectors, and the official PDF. Optional `query` filters by name. Paged, 50 per page. Norms with a `regulation_id` have modification history via `cnbv-regulation-history`.","tags":["Mexico","CNBV"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/cnbv"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Optional name filter (case- and accent-insensitive substring)."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"query":"instituciones de crédito"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnbvRegulationsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/cnbv/regulation-history/v1":{"post":{"operationId":"cnbv_regulation_history","summary":"CNBV Regulation History","description":"Every modifying resolución and annex for one CNBV norma (by `regulation_id` from `cnbv-regulations`), each with its DOF date and official PDF. The Circular Única de Bancos alone carries 180+ modifications.","tags":["Mexico","CNBV"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/cnbv"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["regulation_id"],"properties":{"regulation_id":{"type":"string","pattern":"^\\d{1,10}$","description":"Norm identifier returned by the regulations list (`regulation_id`)."}},"additionalProperties":false},"example":{"regulation_id":"1024"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnbvRegulationHistoryResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/cnsf/provisions-search/v1":{"post":{"operationId":"cnsf_provisions_search","summary":"CNSF Provisions Search","description":"Search Mexico's insurance and surety rulebook in full: every artículo of the Ley de Instituciones de Seguros y de Fianzas (LISF), and every disposición, anexo, anexo transitorio and transitional provision of the Circular Única de Seguros y de Fianzas (CUSF), plus the documentation the circular points to. Filter by free text, `instrument`, `kind`, exact `number`, `chapter_number`, `source_circular` (which Circular Modificatoria introduced a transitional provision), and when the containing chapter was last amended (`amended_from`/`amended_to`). Results come back in reading order with the complete text. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Mexico","CNSF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/cnsf"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the text and headings of the provisions."},"instrument":{"type":"string","enum":["any","LISF","CUSF"],"default":"any","description":"Instrument: `LISF` (the law), `CUSF` (the circular that implements it), or `any` for both."},"kind":{"type":"string","enum":["any","articulo","disposicion","anexo","transitoria","anexo_transitorio","capitulo","documento"],"default":"any","description":"Kind of provision: `articulo` (LISF), `disposicion`, `anexo`, `anexo_transitorio` or `documento` (CUSF), `transitoria` (either), `capitulo` for a chapter repealed in full, or `any`."},"number":{"type":"string","maxLength":40,"default":"","description":"Optional exact provision number as the instrument writes it (e.g. `41` for a LISF artículo, `3.1.2` for a CUSF disposición, `14.2.1-a` for an annex)."},"chapter_number":{"type":"string","maxLength":20,"default":"","description":"Optional chapter filter (e.g. `6.3` in the CUSF)."},"source_circular":{"type":"string","maxLength":20,"default":"","description":"Optional filter for transitional provisions by the Circular Modificatoria that introduced them (e.g. `3/26`), or `original` for those issued with the instrument itself."},"amended_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"amended_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25). Every result carries the full text of the provision."}},"additionalProperties":false},"example":{"query":"requerimiento de capital","instrument":"CUSF"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnsfProvisionsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/cnsf/provision/v1":{"post":{"operationId":"cnsf_provision","summary":"CNSF Provision","description":"Retrieve one provision of Mexico's insurance and surety rulebook by its `provision_id` from the search results (e.g. `cusf:disp:3.1.2`, `lisf:art:41`, `cusf:anexo:14.2.1-a`), with its full text and the chapter it sits in.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Mexico","CNSF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/cnsf"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["provision_id"],"properties":{"provision_id":{"type":"string","minLength":3,"maxLength":80,"description":"Provision identifier from the search results (`id`), e.g. `cusf:disp:3.1.2`, `lisf:art:41`, `cusf:anexo:14.2.1-a`."}},"additionalProperties":false},"example":{"provision_id":"cusf:disp:3.1.2"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnsfProvisionResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/cnsf/amendments/v1":{"post":{"operationId":"cnsf_amendments","summary":"CNSF Amendments","description":"Track how Mexico's Circular Única de Seguros y de Fianzas has changed: every Circular Modificatoria the commission has published since 2014, most recent first, with what it changed, the chapters and annexes it touched, and the Diario Oficial publication behind it. Filter by free text, by `chapter_number`, and by publication window.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Mexico","CNSF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/cnsf"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the text and headings of the provisions."},"chapter_number":{"type":"string","maxLength":20,"default":"","description":"Optional chapter filter (e.g. `6.3` in the CUSF)."},"published_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"published_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25). Every result carries the full text of the provision."}},"additionalProperties":false},"example":{"chapter_number":"6.3"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnsfAmendmentsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/diputados/federal-laws/v1":{"post":{"operationId":"diputados_federal_laws","summary":"Mexican Federal Laws","description":"The Cámara de Diputados catalog of federal laws and codes (315+), each with its official name, abbreviation, original DOF publication date, most recent reform date, consolidated PDF/DOC text, and whether it is still in force. Optional `query` filters by name or abbreviation. Paged, 100 per page; drill into one with `diputados-federal-law`.","tags":["Mexico","Cámara de Diputados"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/diputados"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Optional name filter (case- and accent-insensitive substring)."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"query":"instituciones de crédito"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiputadosFederalLawsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/diputados/federal-law/v1":{"post":{"operationId":"diputados_federal_law","summary":"Mexican Federal Law","description":"One Mexican federal law in full by its `law_id`: current consolidated text (PDF/DOC), original DOF publication with its scan, and every reform decree that amended it, newest first, each with its DOF date, headline, documents, and any fe de erratas.","tags":["Mexico","Cámara de Diputados"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/diputados"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["law_id"],"properties":{"law_id":{"type":"string","pattern":"^[A-Za-z0-9_]{2,60}$","description":"Law identifier returned by the federal-laws list (`id`)."}},"additionalProperties":false},"example":{"law_id":"lic"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiputadosFederalLawResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/diputados/federal-regulations/v1":{"post":{"operationId":"diputados_federal_regulations","summary":"Mexican Federal Regulations","description":"The Cámara de Diputados catalog of federal reglamentos (135+), each with its DOF publication date, consolidated text, whether it is still in force, and an inline history of reforms, annual amount updates, erratas and vigencia notices. Optional `query` filters by name. Paged, 50 per page.","tags":["Mexico","Cámara de Diputados"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/diputados"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Optional name filter (case- and accent-insensitive substring)."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"query":"ley aduanera"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiputadosFederalRegulationsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/diputados/law-reforms/v1":{"post":{"operationId":"diputados_law_reforms","summary":"Mexican Law Reforms by Year","description":"Every reform decree published in the DOF in one year, from the Cámara de Diputados reform log: the decree prose, the canonical actions it takes (reforman, adicionan, derogan, abrogan, expiden...), and every law it touches. One entry per publication day; a single day can bundle several instruments. Defaults to the current year. Paged, 50 decrees per page.","tags":["Mexico","Cámara de Diputados"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/diputados"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"year":{"type":"string","default":"","description":"Optional 4-digit year filter."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."}},"additionalProperties":false},"example":{"year":"2026"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiputadosLawReformsResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/siem/establishments/v1":{"post":{"operationId":"siem_establishments","summary":"SIEM Establishments Search","description":"Search Mexican business establishments in the SIEM directory by commercial name or razón social. Optional filters narrow by state (INEGI code) and SCIAN activity. SIEM is a self-declared directory: registration is voluntary and each establishment chooses which fields stay public, so absence is not evidence of anything. Drill into a result with `siem-establishment`.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Mexico","SIEM"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/siem"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":2,"maxLength":200,"description":"Commercial name or razón social to search for. Matched case-insensitively as a substring."},"state_code":{"type":"integer","minimum":0,"maximum":32,"default":0,"description":"INEGI state code (1-32) to filter by. Omit or 0 searches all states."},"activity_code":{"type":"integer","minimum":0,"maximum":999999,"default":0,"description":"SCIAN activity code to filter by (exact match). Omit or 0 searches all activities."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"name":"OXXO","state_code":21}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiemEstablishmentsResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/mx/siem/establishment/v1":{"post":{"operationId":"siem_establishment","summary":"SIEM Establishment","description":"Retrieve one SIEM establishment's declared profile: RFC, legal or personal name, commercial name, activity, address and contact, headcount, import/export flags, declared products and services, and registration status. Returns `found: false` when the id is unknown.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Mexico","SIEM"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/mexico/siem"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["establishment_id"],"properties":{"establishment_id":{"type":"string","pattern":"^[A-Za-z0-9]{1,40}$","description":"Establishment id returned by the search (`establishment_id`)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"establishment_id":"3417757"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiemEstablishmentResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/rree/foreigner-cards/v1":{"post":{"operationId":"rree_foreigner_cards","summary":"RREE Foreigner Cards","description":"Verify a Peruvian foreigner identity card (carné de extranjería) by its 8-digit card number: names, nationality, immigration status, and expiration. `found: false` when no card matches.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Peru","RREE"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/rree"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","pattern":"^\\d{8}$","description":"8-digit foreigner card number."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_number":"00112233"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RreeResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/apeseg/soat/v1":{"post":{"operationId":"apeseg_soat","summary":"APESEG SOAT Certificate History","description":"Look up a vehicle plate's SOAT (mandatory traffic-accident insurance) certificate history from APESEG (Asociación Peruana de Empresas de Seguros). `has_active_soat: true` means a currently valid (VIGENTE) certificate exists, returned as `active`; `certificates` lists the full history. `found: false` when the plate has no SOAT record.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Peru","APESEG"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/apeseg-soat"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["plate"],"properties":{"plate":{"type":"string","pattern":"^[A-Za-z0-9-]{4,10}$","description":"The vehicle plate to look up (4-10 characters)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"plate":"ABC123"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApesegSoatResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/sbs/soat/v1":{"post":{"operationId":"sbs_soat","summary":"SBS SOAT Report","description":"Look up a vehicle plate's SOAT (mandatory traffic-accident insurance) report from SBS (Superintendencia de Banca, Seguros y AFP), Peru's banking and insurance regulator. Returns `accident_count` (accidents covered by SOAT in the last 5 years) and `policies`, the list of SOAT policies on record (issuing company, vehicle class/use, accidents per policy, policy/certificate number, coverage window, and status VIGENTE/VENCIDA/ANULADA). `has_active_soat: true` means a policy is currently in force, returned as `active`. `found: false` means no SOAT information is reported for the plate.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Peru","SBS"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/sbs-soat"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["plate"],"properties":{"plate":{"type":"string","pattern":"^[A-Za-z0-9-]{4,10}$","description":"The vehicle plate to look up (4-10 characters)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"plate":"ABC123"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SbsSoatResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/sutran/infracciones/v1":{"post":{"operationId":"sutran_infracciones","summary":"SUTRAN Infraction Record","description":"Look up the infraction documents (papeletas and other actos) on record for a vehicle plate from SUTRAN (Superintendencia de Transporte Terrestre de Personas, Carga y Mercancías), Peru's national road-transport authority. `has_infractions: false` means the plate has no infractions on record. When infractions exist, `infractions` lists each one (document number, type, date, infraction code, classification).\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Peru","SUTRAN"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/sutran-infracciones"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["plate"],"properties":{"plate":{"type":"string","pattern":"^[A-Za-z0-9-]{4,10}$","description":"The vehicle plate to look up (4-10 characters)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"plate":"ABC123"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SutranInfraccionesResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/callao/papeletas/v1":{"post":{"operationId":"callao_papeletas","summary":"Callao Traffic Tickets","description":"List the outstanding traffic tickets (papeletas) registered against a vehicle plate in the province of Callao, issued by the Municipalidad Provincial del Callao. `has_papeletas: false` means the plate has no outstanding tickets on record. When tickets exist, `papeletas` lists each one (code, ticket number, infraction date, amount, installment) and `total` is the sum of the outstanding amounts in PEN.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Peru","Municipalidad Provincial del Callao"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/callao-papeletas"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["plate"],"properties":{"plate":{"type":"string","pattern":"^[A-Za-z0-9-]{4,10}$","description":"The vehicle plate to look up (4-10 characters)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"plate":"ABC123"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallaoPapeletasResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/sat-lima/account-status/v1":{"post":{"operationId":"sat_lima_account_status","summary":"SAT Lima Account Status","description":"Look up outstanding debt owed to the SAT de Lima (Servicio de Administración Tributaria de Lima) for a person, company, or vehicle. Pass `document_type` (`dni`, `ruc`, `placa`, `papeleta`, `cod_administrado`, or `compromiso`; defaults to `dni`) plus `document_number`. Returns each outstanding item (taxes such as impuesto vehicular / predial / arbitrios, traffic tickets, administrative fines, and payment commitments) with its group, reference, amount, status, and relevant dates, plus the account total. `clear: true` means nothing is outstanding.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Peru","SAT Lima"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/sat-lima"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_type":{"type":"string","enum":["dni","ruc","placa","papeleta","cod_administrado","compromiso"],"default":"dni","description":"Search dimension: `dni`, `ruc`, `placa` (vehicle plate), `papeleta` (ticket / administrative-fine document), `cod_administrado` (administered-party code), or `compromiso` (payment-commitment code). Defaults to `dni`."},"document_number":{"type":"string","pattern":"^[A-Za-z0-9-]{1,20}$","description":"The value to look up (1-20 alphanumeric characters)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_type":"placa","document_number":"ABC123"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SatLimaAccountStatusResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/sat-lima/capturas/v1":{"post":{"operationId":"sat_lima_capturas","summary":"SAT Lima Vehicle Capture Orders","description":"Check whether a vehicle plate has an outstanding capture order (orden de captura) in the province of Lima, issued by the SAT de Lima (Servicio de Administración Tributaria de Lima) for unpaid tax debt or traffic tickets. `has_capture_order: false` means the plate has no capture order on record. When an order exists, `orders` lists each one with the fields the source reports.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Peru","SAT Lima"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/sat-lima-capturas"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["plate"],"properties":{"plate":{"type":"string","pattern":"^[A-Za-z0-9-]{4,10}$","description":"The vehicle plate to look up (4-10 characters)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"plate":"ABC123"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SatLimaCapturasResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/runt/vehicle-by-plate/v1":{"post":{"operationId":"runt_vehicle_by_plate","summary":"RUNT Vehicle by Plate","description":"Resolve a Colombian vehicle in RUNT (Registro Único Nacional de Tránsito) by plate and the registered owner's document. Returns the vehicle record (brand, line, model year, class, body, color, engine displacement, fuel, weights, VIN, engine/chassis/serial numbers, traffic authority, registration dates, lien/pledge flags) plus SOAT insurance history, técnico-mecánica (RTM) inspection history, extended technical data, registered guarantees/liens (with the creditor, e.g. a financing bank), ownership limitations, armoring (blindaje) status, civil-liability policies, DIJIN and scrapping certificates, normalization records, and scrapping status. `document_type` defaults to `CC`. `found: false` when the plate and owner document have no active match.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","RUNT"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/runt"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["plate","document_number"],"properties":{"plate":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[A-Za-z]{3}\\d{2}[A-Za-z0-9]$","description":"Colombian vehicle plate, e.g. `ABC123` or `ABC12D`."},"document_type":{"type":"string","enum":["CC","CE","TI","RC","PA","NIT","PPT"],"default":"CC","description":"Colombian document type. Defaults to `CC`."},"document_number":{"type":"string","minLength":3,"maxLength":30,"description":"Document number (alphanumeric with hyphens allowed)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"plate":"ABC123","document_type":"CC","document_number":"1234567890"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuntVehicleResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/runt/vehicle-history-by-plate/v1":{"post":{"operationId":"runt_vehicle_history_by_plate","summary":"RUNT Vehicle History by Plate","description":"Look up a Colombian vehicle's history in RUNT (Registro Único Nacional de Tránsito) by plate alone, without the owner's document. Returns the registered owner(s) (name and identification number), the vehicle characteristics (brand, line, model year, class, body, color, VIN, engine/chassis/serial numbers), the traffic-license and import records, SOAT and técnico-mecánica (RTM) history, any accident on record, recent and pending procedures (trámites), and guarantee/lien and ownership-limitation summaries. `found: false` when the plate has no record.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","RUNT"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/runt"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["plate"],"properties":{"plate":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[A-Za-z]{3}\\d{2}[A-Za-z0-9]$","description":"Colombian vehicle plate, e.g. `ABC123` or `ABC12D`."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"plate":"ABC123"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuntVehicleHistoryResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/consejo-estado/search/v1":{"post":{"operationId":"consejo_estado_search","summary":"Consejo de Estado Jurisprudence Search","description":"Search the Relatoría del Consejo de Estado's traditional jurisprudence corpus (broadly providencias before December 2021) by section, type, date window, radicado, ponente, party or challenged rule. Each row carries the providencia's metadata plus a `url` permalink to feed to `consejo-estado-providencia`. For December 2021 onward use the SAMAI endpoints.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","Consejo de Estado"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/consejo-estado"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"section":{"type":"string","maxLength":80,"default":"","description":"Optional section filter (e.g. `SECCION TERCERA`, `SALA PLENA`). Empty means all sections."},"type":{"type":"string","enum":["","AUTO","CONCEPTO","SENTENCIA"],"default":"","description":"Filter by providencia type; empty means any."},"registration_number":{"type":"string","maxLength":40,"default":"","description":"Optional número de proceso (radicado) filter."},"reporting_judge":{"type":"string","maxLength":120,"default":"","description":"Optional consejero ponente filter."},"plaintiff":{"type":"string","maxLength":120,"default":"","description":"Optional demandante (actor) filter."},"defendant":{"type":"string","maxLength":120,"default":"","description":"Optional demandado filter."},"statute":{"type":"string","maxLength":120,"default":"","description":"Optional norma o acto demandado filter."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":20,"default":5,"description":"Results per page (max 20). The source returns one record per view, so larger pages take proportionally longer."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"section":"SECCION TERCERA","type":"SENTENCIA","from_date":"2020-01-01","to_date":"2020-12-31"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsejoEstadoSearchResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/consejo-estado/providencia/v1":{"post":{"operationId":"consejo_estado_providencia","summary":"Consejo de Estado Providencia","description":"Retrieve the full text of one providencia from the Relatoría del Consejo de Estado, by the `url` permalink a search row exposes. `found: false` when the permalink resolves to no document.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","Consejo de Estado"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/consejo-estado"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","maxLength":2048,"description":"Content permalink (`url`) returned by a search result row."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"url":"https://servicios.consejodeestado.gov.co/WebRelatoria/FileReferenceServlet?corp=ce&ext=html&file=233679"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsejoEstadoProvidenciaResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/sicaac/insolvency-cases/v1":{"post":{"operationId":"sicaac_insolvency_cases","summary":"SICAAC Insolvency Cases","description":"Look up Colombian natural-person insolvency cases by document number. `document_type` defaults to `CC` (Cédula de Ciudadanía).\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","SICAAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sicaac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_type":{"type":"string","enum":["CC","CE","TI","RC","PA","NIT","NA","NIE","DEC"],"default":"CC","description":"Colombian document type. Defaults to `CC`."},"document_number":{"type":"string","minLength":3,"maxLength":30,"description":"Document number (alphanumeric with hyphens allowed)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_number":"1020745812"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SicaacResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/contaduria/state-delinquent-debtors/v1":{"post":{"operationId":"contaduria_state_delinquent_debtors","summary":"Contaduría State Delinquent Debtor Records","description":"Check whether a person or entity is a delinquent debtor to the Colombian State, from the Contaduría General de la Nación's register (Boletín de Deudores Morosos del Estado). Returns two verdicts: delinquent debt owed to the State (Ley 901 de 2004) and default on a payment agreement (Ley 1066 de 2006). `document_type` defaults to `CC`.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Colombia","Contaduría"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/contaduria"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_type":{"type":"string","enum":["CC","NIT","TI","CE","PA","RC","PPT"],"default":"CC","description":"Colombian document type. Defaults to `CC`."},"document_number":{"type":"string","minLength":3,"maxLength":30,"description":"Document number (alphanumeric with hyphens allowed)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_number":"1234567890"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateDelinquentDebtorResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/sunat/ruc/v1":{"post":{"operationId":"sunat_ruc","summary":"SUNAT Taxpayer by RUC","description":"Look up a Peruvian taxpayer's full record by RUC (11 digits). `found: false` when the RUC is not registered.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Peru","SUNAT"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/sunat"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ruc"],"properties":{"ruc":{"type":"string","pattern":"^\\d{11}$","description":"11-digit RUC."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"ruc":"20100070970"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RucResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/sunat/document/v1":{"post":{"operationId":"sunat_document","summary":"SUNAT Taxpayer by Document","description":"Look up a Peruvian taxpayer's full record by identity document (DNI, carné de extranjería, passport, or diplomatic card). `found: false` when no taxpayer matches.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Peru","SUNAT"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/sunat"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_type":{"type":"string","enum":["dni","ce","passport","diplomatic"],"default":"dni","description":"Identity document type: `dni`, `ce` (carné de extranjería), `passport`, or `diplomatic`. Defaults to `dni`."},"document_number":{"type":"string","pattern":"^[A-Za-z0-9]{6,16}$","description":"Identity document number (6-16 alphanumeric characters)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_type":"dni","document_number":"12345678"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RucResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/sunat/name/v1":{"post":{"operationId":"sunat_name","summary":"SUNAT Taxpayer Search by Name","description":"Search Peruvian taxpayers by name or razón social. Returns up to 30 matches (SUNAT's cap).\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Peru","SUNAT"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/sunat"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":100,"description":"Taxpayer name or razón social to search for."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"name":"INVERSIONES GENERALES"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SunatNameResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/oece/processes-search/v1":{"post":{"operationId":"oece_processes_search","summary":"OECE Processes Search","description":"Search Peru's public-procurement procedures (SEACE, published by OECE) by free text over title and description, buyer RUC, awarded supplier RUC, department, category (goods/services/works), procedure type, publication-date window and last-modified date. Newest first, pages of up to 50. Served by Croma (`as_of` says how current the data is), covering procedures published from 2020.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Peru","OECE Contrataciones Abiertas"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/oece"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en el título y la descripción del proceso (opcional)."},"buyer_ruc":{"type":"string","pattern":"^(?:\\d{11})?$","default":"","description":"RUC de 11 dígitos (opcional)."},"supplier_ruc":{"type":"string","pattern":"^(?:\\d{11})?$","default":"","description":"RUC de 11 dígitos (opcional)."},"department":{"type":"string","maxLength":60,"default":"","description":"Departamento de la entidad compradora, p. ej. `LIMA` (opcional)."},"category":{"type":"string","enum":["","goods","services","works"],"default":"","description":"Categoría principal: `goods`, `services` o `works` (opcional)."},"method":{"type":"string","maxLength":80,"default":"","description":"Tipo de procedimiento tal como lo nombra la fuente, p. ej. `Licitación Pública` (opcional)."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"updated_after":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"query":"laptops","department":"LIMA","from_date":"2025-01-01"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OeceProcessesSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/pe/oece/process/v1":{"post":{"operationId":"oece_process","summary":"OECE Process by OCID","description":"Resolve one Peruvian public-procurement procedure (SEACE, published by OECE) by its OCDS id and return the full record: buyer, estimated value, items with their stage, bidding documents, awards with suppliers, and contracts. `found: false` when there is no procedure with that id. Served by Croma (`as_of` says how current the data is), covering procedures published from 2020.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Peru","OECE Contrataciones Abiertas"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/oece"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ocid"],"properties":{"ocid":{"type":"string","pattern":"^ocds-dgv273-[a-z0-9]+(?:-\\d+)+$","description":"OCDS process id, e.g. `ocds-dgv273-seacev3-873200`."}},"additionalProperties":false},"example":{"ocid":"ocds-dgv273-seacev3-873200"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OeceProcessResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/sunbiz/entities-search/v1":{"post":{"operationId":"sunbiz_entities_search","summary":"Sunbiz Entities Search","description":"Search Florida's registry of business entities (Sunbiz, the Division of Corporations) by free text over the entity name, its officers and its registered agent, by name prefix, status (active/inactive), filing type (LLC, corporation, partnership, trust...), city and state of the principal address, FEI number, formation-date window and last-published date. Pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","Sunbiz (Florida Division of Corporations)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sunbiz"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en el nombre de la entidad, sus directivos y su agente registrado (opcional)."},"name_prefix":{"type":"string","maxLength":120,"default":"","description":"Inicio del nombre de la entidad, p. ej. `VIVA EXHIBITIONS` (opcional)."},"status":{"type":"string","enum":["","active","inactive"],"default":"","description":"Estado de la entidad: `active` o `inactive` (opcional)."},"filing_type":{"type":"string","enum":["","florida_llc","foreign_llc","domestic_profit","foreign_profit","domestic_nonprofit","foreign_nonprofit","domestic_limited_partnership","foreign_limited_partnership","nonprofit_registration","trust","registered_agent_designation"],"default":"","description":"Tipo de registro: `florida_llc`, `foreign_llc`, `domestic_profit`, `foreign_profit`, `domestic_nonprofit`, `foreign_nonprofit`, `domestic_limited_partnership`, `foreign_limited_partnership`, `nonprofit_registration`, `trust` o `registered_agent_designation` (opcional)."},"city":{"type":"string","maxLength":40,"default":"","description":"Ciudad de la dirección principal, p. ej. `MIAMI` (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Z]{2})?$","default":"","description":"Código de estado de dos letras, p. ej. `FL` (opcional)."},"fei_number":{"type":"string","pattern":"^(?:\\d{2}-?\\d{7})?$","default":"","description":"FEI/EIN de nueve dígitos de la entidad (opcional)."},"filed_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"filed_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"updated_after":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"query":"registered agents inc","status":"active","city":"MIAMI"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SunbizEntitiesSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/sunbiz/entity/v1":{"post":{"operationId":"sunbiz_entity","summary":"Sunbiz Entity by Document Number","description":"Resolve one Florida business entity (Sunbiz, the Division of Corporations) by its document number and return the full record: status, filing type, addresses, formation date, FEI, annual reports, registered agent and officers. `found: false` when the registry has no entity with that number. Served by Croma (`as_of` says how current the data is), brought up to date daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","Sunbiz (Florida Division of Corporations)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sunbiz"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","pattern":"^[A-Z]{0,2}\\d{4,12}$","description":"Número de documento de la entidad en Florida, p. ej. `P26000044030`."}},"additionalProperties":false},"example":{"document_number":"P26000044030"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SunbizEntityResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/sec/form-d-search/v1":{"post":{"operationId":"sec_form_d_search","summary":"SEC Form D Search","description":"Search every Form D filed with the SEC since 2008 (the notice a US company or fund files when it raises money privately) by free text over the issuer and its executives, directors and promoters, by issuer CIK, state, jurisdiction of incorporation, industry group, fund type, funds in or out, form type (new or amendment), filing-date window and minimum amount sold. Newest first, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC EDGAR"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sec"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en el nombre del emisor y en los nombres de sus directivos, directores y promotores (opcional)."},"issuer_cik":{"type":"string","pattern":"^\\d{0,10}$","default":"","description":"CIK del emisor en EDGAR, con o sin ceros a la izquierda (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Z]{2})?$","default":"","description":"Código de estado de dos letras, p. ej. `FL` (opcional)."},"jurisdiction":{"type":"string","maxLength":40,"default":"","description":"Jurisdicción de constitución tal como la escribe el formulario, p. ej. `DELAWARE`, `CAYMAN ISLANDS` (opcional)."},"industry":{"type":"string","maxLength":60,"default":"","description":"Grupo de industria tal como lo nombra el formulario, p. ej. `Other Technology`, `Biotechnology`, `Pooled Investment Fund` (opcional)."},"fund_type":{"type":"string","enum":["","venture_capital_fund","private_equity_fund","hedge_fund","other_investment_fund"],"default":"","description":"Tipo de fondo, solo para emisores que son fondos: `venture_capital_fund`, `private_equity_fund`, `hedge_fund` u `other_investment_fund` (opcional)."},"funds":{"type":"string","enum":["include","exclude","only"],"default":"include","description":"Qué hacer con los fondos de inversión (pooled investment funds): `include` (por defecto), `exclude` para ver solo empresas operativas, `only` para ver solo fondos."},"form_type":{"type":"string","enum":["","D","D/A"],"default":"","description":"`D` para notificaciones nuevas, `D/A` para enmiendas (opcional)."},"filed_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"filed_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"min_amount_sold":{"type":"number","minimum":0,"default":0,"description":"Monto mínimo ya vendido, en dólares (opcional)."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"query":"databricks","funds":"exclude"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecFormDSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/sec/form-d-filing/v1":{"post":{"operationId":"sec_form_d_filing","summary":"SEC Form D Filing","description":"Resolve one Form D filing by its EDGAR accession number and return the full record: issuer, executives and directors, industry, exemptions, securities, amounts offered and sold, investors, sales compensation and signature. `found: false` when EDGAR has no Form D under that number. Served by Croma (`as_of` says how current the data is), brought up to date daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC EDGAR"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sec"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accession_number"],"properties":{"accession_number":{"type":"string","pattern":"^\\d{10}-\\d{2}-\\d{6}$","description":"Número de acceso de EDGAR del filing, p. ej. `0001587468-26-000001`."}},"additionalProperties":false},"example":{"accession_number":"0001587468-26-000001"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecFormDFilingResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/delaware/entities-search/v1":{"post":{"operationId":"delaware_entities_search","summary":"Delaware Entities Search","description":"Search the Delaware Division of Corporations registry of business entities by name: corporations, LLCs, limited partnerships, statutory trusts and partnerships, domestic and foreign, active and inactive. Returns up to 50 matches with their file numbers (`truncated` says whether more exist); `exact: true` matches the full name exactly. Pass a file number to `delaware_entity` for the record.","tags":["United States","Delaware Division of Corporations"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/delaware"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string","minLength":1,"maxLength":120,"description":"Nombre de la entidad a buscar, p. ej. `GOOGLE LLC`. Por palabras, sin distinguir mayúsculas."},"exact":{"type":"boolean","default":false,"description":"Si es `true`, solo entidades cuyo nombre es exactamente el buscado (opcional)."}},"additionalProperties":false},"example":{"query":"GOOGLE LLC","exact":true}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DelawareEntitiesSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/delaware/entity/v1":{"post":{"operationId":"delaware_entity","summary":"Delaware Entity by File Number","description":"Look up one Delaware business entity by its file number and return the Division of Corporations' free record: name, incorporation or formation date, entity kind and type, residency, state of formation and the registered agent. `found: false` when the Division has no entity under that number. Live from the Division; not a statement of good standing.","tags":["United States","Delaware Division of Corporations"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/delaware"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_number"],"properties":{"file_number":{"type":"string","pattern":"^\\d{1,9}$","description":"Número de archivo (file number) de la entidad en Delaware, p. ej. `3582691`."}},"additionalProperties":false},"example":{"file_number":"3582691"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DelawareEntityResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/iapd/advisers-search/v1":{"post":{"operationId":"iapd_advisers_search","summary":"SEC Form ADV Advisers Search","description":"Search every investment adviser registered with the SEC or reporting to it as an exempt reporting adviser (most venture capital firms) by free text over its names, by firm type, state or country of the principal office, whether it manages private funds and minimum assets under management. By legal name, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Form ADV"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/iapd"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en los nombres (opcional)."},"firm_type":{"type":"string","enum":["","registered","exempt_reporting"],"default":"","description":"Tipo de asesor: `registered` (registrado ante la SEC) o `exempt_reporting` (exempt reporting adviser, la mayoría de las firmas de venture capital) (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Z]{2})?$","default":"","description":"Código de estado de dos letras, p. ej. `FL` (opcional)."},"country":{"type":"string","maxLength":60,"default":"","description":"País tal como lo escribe el formulario, p. ej. `United States`, `Cayman Islands` (opcional)."},"private_funds":{"type":"string","enum":["any","only","none"],"default":"any","description":"Qué hacer con los fondos privados: `any` (por defecto), `only` para ver solo asesores que administran fondos privados, `none` para ver solo los que no."},"min_aum":{"type":"number","minimum":0,"default":0,"description":"Monto mínimo en dólares (opcional)."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"query":"andreessen"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IapdAdvisersSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/iapd/adviser/v1":{"post":{"operationId":"iapd_adviser","summary":"SEC Form ADV Adviser","description":"Resolve one investment adviser by its CRD number and return the full roster record plus the private funds it currently reports: total, gross asset value, a breakdown by fund type and the funds themselves, largest first. `found: false` when the SEC's roster has no adviser under that CRD. Served by Croma (`as_of` says how current the data is), brought up to date daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Form ADV"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/iapd"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["crd"],"properties":{"crd":{"type":"string","pattern":"^\\d{1,10}$","description":"Número CRD del asesor, p. ej. `160489`."}},"additionalProperties":false},"example":{"crd":"160489"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IapdAdviserResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/iapd/private-funds-search/v1":{"post":{"operationId":"iapd_private_funds_search","summary":"SEC Form ADV Private Funds Search","description":"Search every private fund reported to the SEC on Form ADV since 2011 (venture capital, private equity, hedge, real estate and other funds) by free text over the fund, its adviser and general partners, by adviser CRD, fund type, state or country of domicile, minimum gross asset value and filing-date window, current funds only or former ones too. Largest first, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date monthly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Form ADV"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/iapd"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en los nombres (opcional)."},"adviser_crd":{"type":"string","pattern":"^\\d{0,10}$","default":"","description":"Número CRD del asesor que administra el fondo (opcional)."},"fund_type":{"type":"string","enum":["","venture_capital","private_equity","hedge","real_estate","securitized_asset","liquidity","other"],"default":"","description":"Tipo de fondo privado: `venture_capital`, `private_equity`, `hedge`, `real_estate`, `securitized_asset`, `liquidity` u `other` (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Z]{2})?$","default":"","description":"Código de estado de dos letras, p. ej. `FL` (opcional)."},"country":{"type":"string","maxLength":60,"default":"","description":"País tal como lo escribe el formulario, p. ej. `United States`, `Cayman Islands` (opcional)."},"min_gross_asset_value":{"type":"number","minimum":0,"default":0,"description":"Monto mínimo en dólares (opcional)."},"include_former":{"type":"boolean","default":false,"description":"Incluir también los fondos que el asesor dejó de reportar (por defecto solo los vigentes)."},"reported_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"reported_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"fund_type":"venture_capital","min_gross_asset_value":1000000000}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IapdPrivateFundsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/iapd/private-fund/v1":{"post":{"operationId":"iapd_private_fund","summary":"SEC Form ADV Private Fund","description":"Resolve one private fund by its Form ADV fund id (`805-` and ten digits) and return the full record from the latest filing that reports it: adviser, type, domicile, gross asset value, minimum investment, investors, ownership, master/feeder links, auditor, general partners, Form D file numbers and whether the adviser still reports it. `found: false` when no filing carries that id. Served by Croma (`as_of` says how current the data is), brought up to date monthly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Form ADV"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/iapd"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["fund_id"],"properties":{"fund_id":{"type":"string","pattern":"^805-\\d{10}$","description":"Id del fondo privado, p. ej. `805-8573539182`."}},"additionalProperties":false},"example":{"fund_id":"805-8573539182"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IapdPrivateFundResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/sec-13f/filings-search/v1":{"post":{"operationId":"sec_13f_filings_search","summary":"SEC Form 13F Filings Search","description":"Search every Form 13F filed with the SEC since 2013 (the quarterly report of what an institutional manager holds in US public equities) by free text over the manager's name, by manager CIK or CRD, state, the quarter reported and the minimum total value of the positions. Newest quarter first, pages of up to 50. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Form 13F"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sec-13f"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en los nombres (opcional)."},"manager_cik":{"type":"string","pattern":"^\\d{0,10}$","default":"","description":"CIK del emisor en EDGAR, con o sin ceros a la izquierda (opcional)."},"manager_crd":{"type":"string","pattern":"^\\d{0,10}$","default":"","description":"Número CRD del asesor que administra el fondo (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Z]{2})?$","default":"","description":"Código de estado de dos letras, p. ej. `FL` (opcional)."},"period_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"period_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"min_value":{"type":"number","minimum":0,"default":0,"description":"Monto mínimo en dólares (opcional)."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"query":"berkshire hathaway"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sec13fFilingsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/sec-13f/filing/v1":{"post":{"operationId":"sec_13f_filing","summary":"SEC Form 13F Filing","description":"Resolve one Form 13F by its EDGAR accession number and return the filing with its positions, largest first: the manager, the quarter, the totals, and each position's issuer, CUSIP, value, shares, options and voting authority. `found: false` when no Form 13F carries that number. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Form 13F"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sec-13f"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accession_number"],"properties":{"accession_number":{"type":"string","pattern":"^\\d{10}-\\d{2}-\\d{6}$","description":"Número de acceso de EDGAR del filing, p. ej. `0001587468-26-000001`."}},"additionalProperties":false},"example":{"accession_number":"0001193125-26-226661"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sec13fFilingResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/sec-13f/holdings-search/v1":{"post":{"operationId":"sec_13f_holdings_search","summary":"SEC Form 13F Holdings Search","description":"Search the positions institutional managers reported on Form 13F by free text over the issuer and the manager, by CUSIP, manager CIK or CRD, options only, the quarter reported and a minimum position value. Largest first, pages of up to 50. Answers both who holds one security and what one manager holds. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Form 13F"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sec-13f"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en los nombres (opcional)."},"cusip":{"type":"string","pattern":"^(?:[A-Za-z0-9]{9})?$","default":"","description":"CUSIP del valor, nueve caracteres, p. ej. `037833100` (opcional)."},"manager_cik":{"type":"string","pattern":"^\\d{0,10}$","default":"","description":"CIK del emisor en EDGAR, con o sin ceros a la izquierda (opcional)."},"manager_crd":{"type":"string","pattern":"^\\d{0,10}$","default":"","description":"Número CRD del asesor que administra el fondo (opcional)."},"put_call":{"type":"string","enum":["","PUT","CALL"],"default":"","description":"`PUT` o `CALL` para ver solo posiciones en opciones; vacío incluye todas (opcional)."},"period_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"period_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"min_value":{"type":"number","minimum":0,"default":0,"description":"Monto mínimo en dólares (opcional)."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"query":"nvidia","min_value":1000000000}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sec13fHoldingsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/ofac/sanctions-search/v1":{"post":{"operationId":"ofac_sanctions_search","summary":"OFAC Sanctions Search","description":"Search every party on the US Treasury's OFAC sanctions lists by free text over the primary name and every alias, by list, party type, sanctions program and country of an address. By name, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","OFAC Sanctions"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/ofac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en los nombres (opcional)."},"list":{"type":"string","enum":["","sdn","non_sdn"],"default":"","description":"`sdn` para la lista de Specially Designated Nationals, `non_sdn` para la lista consolidada de los demás programas (opcional)."},"party_type":{"type":"string","enum":["","individual","entity","vessel","aircraft"],"default":"","description":"Tipo de parte: `individual`, `entity` (empresa u organización), `vessel` o `aircraft` (opcional)."},"program":{"type":"string","pattern":"^[A-Za-z0-9 ._/-]{0,40}$","default":"","description":"Código del programa de sanciones, p. ej. `RUSSIA-EO14024`, `SDGT`, `CUBA` (opcional)."},"country":{"type":"string","maxLength":60,"default":"","description":"País tal como lo escribe el formulario, p. ej. `United States`, `Cayman Islands` (opcional)."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"query":"aerocaribbean"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfacSanctionsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/us/ofac/sanctioned-party/v1":{"post":{"operationId":"ofac_sanctioned_party","summary":"OFAC Sanctioned Party","description":"Resolve one sanctioned party by its id and return the full record: names and aliases, addresses, sanctions programs, vessel details and the identifiers OFAC records in its note. `found: false` when no list carries that id. Served by Croma (`as_of` says how current the data is), brought up to date daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","OFAC Sanctions"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/ofac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^(?:sdn|non_sdn)-\\d{1,9}$","description":"Id de la parte sancionada, p. ej. `sdn-36`."}},"additionalProperties":false},"example":{"id":"sdn-36"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfacSanctionedPartyResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/djen/publications-search/v1":{"post":{"operationId":"djen_publications_search","summary":"DJEN Publications Search","description":"Search Brazil's national court publications (Diário de Justiça Eletrônico Nacional, CNJ) by party name, lawyer name, OAB number, CNJ case number, court, free text and availability date: intimações, citações, editais and listas de distribuição from every state, federal, labour, electoral and military court and the superior courts, newest first, with the full text and the parties and lawyers each publication is addressed to. At least one of party, lawyer, OAB number, case number, court or text is required; `total` is exact for a single day and stops at 10,000 for a range.","tags":["Brazil","Diário de Justiça Eletrônico Nacional (CNJ)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/djen"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"party_name":{"type":"string","maxLength":200,"default":"","description":"Nombre de una parte tal como aparece en la publicación, p. ej. `BANCO DO BRASIL` (opcional). Coincide por palabras completas, sin distinguir mayúsculas ni acentos."},"lawyer_name":{"type":"string","maxLength":200,"default":"","description":"Nombre de un abogado destinatario de la publicación (opcional). Coincide por palabras completas, sin distinguir mayúsculas ni acentos."},"oab_number":{"type":"string","pattern":"^\\d{0,7}$","default":"","description":"Número de inscripción en la OAB de un abogado destinatario, solo dígitos, p. ej. `123456` (opcional)."},"oab_state":{"type":"string","pattern":"^(?:[A-Za-z]{2})?$","default":"","description":"Sigla del estado (UF) de la inscripción en la OAB, p. ej. `SP` (opcional)."},"registration_number":{"type":"string","pattern":"^(?:\\d{20}|\\d{7}-\\d{2}\\.\\d{4}\\.\\d\\.\\d{2}\\.\\d{4})?$","default":"","description":"Número único del proceso (CNJ): 20 dígitos o con el formato NNNNNNN-DD.AAAA.J.TR.OOOO, p. ej. `0001234-56.2026.8.26.0100` (opcional)."},"court_code":{"type":"string","default":"","description":"Sigla del tribunal en el DJEN, p. ej. `TJSP`, `TRT2`, `TRF1`, `STJ`, `TST`; los electorales llevan guion, `TRE-SP` (opcional). Sin distinguir mayúsculas."},"query":{"type":"string","maxLength":200,"default":"","description":"Texto a buscar en el cuerpo de la publicación (opcional)."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"medium":{"type":"string","enum":["any","diario","edital"],"default":"any","description":"`diario` para el Diário de Justiça Eletrônico Nacional, `edital` para la Plataforma Nacional de Editais, `any` para ambos."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":6,"maximum":50,"default":20,"description":"Resultados por página (6-50)."}},"additionalProperties":false},"example":{"party_name":"BANCO DO BRASIL","court_code":"TJSP","from_date":"2026-09-09","to_date":"2026-09-09","per_page":10}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DjenPublicationsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/cgu/sanctions-search/v1":{"post":{"operationId":"cgu_sanctions_search","summary":"CGU Sanctions Search","description":"Search Brazil's federal integrity registers kept by the Controladoria-Geral da União (CEIS, CNEP, CEAF, CEPIM and the leniency agreements) by free text over every name the register gives the party, by CNPJ or CPF (exact; CPFs come back masked), register, party type and the sanctioning body's state. One row per sanction, by name, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Brazil","Controladoria-Geral da União (CGU)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/cgu"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en los nombres (opcional)."},"document_number":{"type":"string","pattern":"^(?:\\d{11}|\\d{14}|\\d{3}\\.\\d{3}\\.\\d{3}-\\d{2}|\\d{2}\\.\\d{3}\\.\\d{3}\\/\\d{4}-\\d{2})?$","default":"","description":"CPF o CNPJ de la parte sancionada, con o sin puntuación, p. ej. `12.345.678/0001-90` (opcional). Coincidencia exacta."},"list":{"type":"string","enum":["","ceis","cnep","ceaf","cepim","leniency"],"default":"","description":"Registro: `ceis` (inidóneas y suspendidas), `cnep` (Ley Anticorrupción), `ceaf` (servidores federales expulsados), `cepim` (entidades sin fines de lucro impedidas), `leniency` (acuerdos de lenidad) (opcional)."},"party_type":{"type":"string","enum":["","individual","company"],"default":"","description":"Tipo de parte: `individual` (persona) o `company` (empresa u organización) (opcional)."},"sanctioning_body_state":{"type":"string","pattern":"^(?:[A-Za-z]{2})?$","default":"","description":"Sigla del estado (UF) del órgano que impuso la sanción, p. ej. `SP` (opcional). No es el estado de la parte."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"query":"construtora","list":"ceis","per_page":10}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CguSanctionsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/cgu/sanction/v1":{"post":{"operationId":"cgu_sanction","summary":"CGU Sanction","description":"Resolve one sanction on Brazil's federal integrity registers (CGU) by its id and return the full record: the party, its names and document (CPFs masked), the sanction, the sanctioning body, the dates, the legal basis, the process, and the fine, the expelled servant's post or the leniency agreement's terms where they apply. `found: false` when no register carries that id. Served by Croma (`as_of` says how current the data is), brought up to date daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Brazil","Controladoria-Geral da União (CGU)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/cgu"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^(?:ceis|cnep|ceaf|cepim|leniency)-[a-z0-9-]{1,80}$","description":"Id de la sanción, p. ej. `ceis-72529`, como lo devuelve la búsqueda."}},"additionalProperties":false},"example":{"id":"ceis-72529"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CguSanctionResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/pgfn/debts-search/v1":{"post":{"operationId":"pgfn_debts_search","summary":"PGFN Debts Search","description":"Search the active debts Brazilian companies owe the Union in the dívida ativa (Procuradoria-Geral da Fazenda Nacional): federal taxes, social security contributions and the FGTS, by company name, CNPJ or its 8-character root, regime, state, status, the company's role in the debt, whether it is in court, and an amount range. Largest amount first, pages of up to 50. Companies only. Served by Croma (`as_of` says how current the data is), refreshed with each quarterly release.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Brazil","Procuradoria-Geral da Fazenda Nacional (PGFN)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/pgfn"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en los nombres (opcional)."},"document_number":{"type":"string","pattern":"^(?:[A-Za-z0-9]{8}|[A-Za-z0-9]{12}\\d{2}|[A-Za-z0-9]{2}\\.[A-Za-z0-9]{3}\\.[A-Za-z0-9]{3}(?:\\/[A-Za-z0-9]{4}-\\d{2})?)?$","default":"","description":"CNPJ de la empresa deudora, con o sin puntuación, p. ej. `12.345.678/0001-90`, o su raíz de 8 caracteres para todos sus establecimientos (opcional)."},"regime":{"type":"string","enum":["","nao_previdenciario","previdenciario","fgts"],"default":"","description":"Tipo de deuda: `nao_previdenciario` (tributos y demás), `previdenciario` (contribuciones a la seguridad social) o `fgts` (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Za-z]{2})?$","default":"","description":"Sigla del estado (UF) de la empresa deudora, p. ej. `SP` (opcional)."},"status_type":{"type":"string","enum":["","in_collection","tax_benefit","guaranteed","suspended_by_court","in_negotiation"],"default":"","description":"Situación: `in_collection` (en cobro), `tax_benefit` (beneficio fiscal), `guaranteed` (garantizada), `suspended_by_court` (suspendida por decisión judicial), `in_negotiation` (en negociación) (opcional)."},"debtor_type":{"type":"string","enum":["","principal","co_responsible","joint"],"default":"","description":"Papel de la empresa en la deuda: `principal`, `co_responsible` (corresponsable) o `joint` (solidaria) (opcional)."},"in_court":{"type":"string","enum":["any","yes","no"],"default":"any","description":"`yes` solo deudas en ejecución judicial, `no` solo las que no, `any` ambas."},"amount_min":{"type":"number","minimum":0,"default":0,"description":"Monto mínimo de la deuda en reales (opcional)."},"amount_max":{"type":"number","minimum":0,"default":0,"description":"Monto máximo de la deuda en reales; `0` sin límite (opcional)."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"query":"construtora","in_court":"yes","per_page":10}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PgfnDebtsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/pgfn/debtor/v1":{"post":{"operationId":"pgfn_debtor","summary":"PGFN Debtor","description":"Total what one Brazilian company owes the Union in the dívida ativa (Procuradoria-Geral da Fazenda Nacional), by CNPJ or by its 8-character root for every establishment: the number of debts, the amount owed as principal debtor, the part in court, a breakdown by regime (federal taxes, social security, FGTS), and the 50 largest debts. `found: false` when PGFN has inscribed nothing. Served by Croma (`as_of` says how current the data is), refreshed with each quarterly release.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Brazil","Procuradoria-Geral da Fazenda Nacional (PGFN)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/pgfn"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","pattern":"^(?:[A-Za-z0-9]{8}|[A-Za-z0-9]{12}\\d{2}|[A-Za-z0-9]{2}\\.[A-Za-z0-9]{3}\\.[A-Za-z0-9]{3}(?:\\/[A-Za-z0-9]{4}-\\d{2})?)$","description":"CNPJ de la empresa, con o sin puntuación, p. ej. `12.345.678/0001-90`, o su raíz de 8 caracteres para sumar todos sus establecimientos."}},"additionalProperties":false},"example":{"document_number":"33.000.167/0001-01"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PgfnDebtorResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/tst/labour-certificate/v1":{"post":{"operationId":"tst_labour_certificate","summary":"TST Labour-Debt Certificate (CNDT)","description":"Issue Brazil's labour-debt certificate (Certidão Negativa de Débitos Trabalhistas) for a company by CNPJ, live from the Tribunal Superior do Trabalho: `clear`, `debts`, or `debts_secured` (every debt secured or suspended, with the legal effect of a clearance), the certificate number, issue time and validity, and each labour case with its court and whether the debt is secured. Optionally the official PDF. Async job; most calls finish inline.\n\nSupports async delivery: set `Prefer: wait=N` for an inline result, pass `callback_url` to receive a POST when ready, or poll `GET /jobs/{id}`.","tags":["Brazil","Tribunal Superior do Trabalho (TST)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/tst"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","pattern":"^(?:[A-Za-z0-9]{12}\\d{2}|[A-Za-z0-9]{2}\\.[A-Za-z0-9]{3}\\.[A-Za-z0-9]{3}\\/[A-Za-z0-9]{4}-\\d{2})$","description":"CNPJ de la empresa, con o sin puntuación, p. ej. `33.000.167/0001-01`. Solo empresas: un CPF no se acepta."},"include_pdf":{"type":"boolean","default":false,"description":"Si es `true`, la respuesta incluye `pdf_url`, el enlace a la certidão oficial en PDF (opcional)."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_number":"33.000.167/0001-01"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TstLabourCertificateResponse"}}}},"202":{"description":"Accepted — the result is being computed asynchronously. Poll `job.status_url` (GET /jobs/{id}) or supply `callback_url` to have the result POSTed to you. Returned when `Prefer: wait` elapses before completion, or immediately when `callback_url` is set.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"Location":{"description":"Absolute URL to poll for job status.","schema":{"type":"string","format":"uri","example":"https://api.croma.run/jobs/run_123"}},"X-Job-Id":{"description":"Id of the created job.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/caixa/fgts-certificate/v1":{"post":{"operationId":"caixa_fgts_certificate","summary":"Caixa FGTS Regularity Certificate (CRF)","description":"Check whether a Brazilian employer is up to date with the FGTS, by CNPJ, from Caixa Econômica Federal: `regular` with the current Certificado de Regularidade do FGTS (number, validity, establishment address), or `irregular` with which body reports the impediment (PGFN or Caixa). Optionally the certificates issued in the last 24 months. `found: false` when the CNPJ is not registered as an employer.","tags":["Brazil","Caixa Econômica Federal (FGTS)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/caixa"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number"],"properties":{"document_number":{"type":"string","pattern":"^(?:[A-Za-z0-9]{12}\\d{2}|[A-Za-z0-9]{2}\\.[A-Za-z0-9]{3}\\.[A-Za-z0-9]{3}\\/[A-Za-z0-9]{4}-\\d{2})$","description":"CNPJ de la empresa, con o sin puntuación, p. ej. `33.000.167/0001-01`. Solo empresas: un CPF no se acepta."},"include_history":{"type":"boolean","default":false,"description":"Si es `true`, la respuesta incluye `history`, los certificados emitidos en los últimos 24 meses (opcional)."}},"additionalProperties":false},"example":{"document_number":"33.000.167/0001-01"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaixaFgtsCertificateResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/mte/slave-labour-search/v1":{"post":{"operationId":"mte_slave_labour_search","summary":"MTE Slave Labour Register Search","description":"Search Brazil's register of employers caught keeping workers in conditions analogous to slavery (Cadastro de Empregadores, the \"Lista Suja\"), and the register of employers under a conduct-adjustment agreement, by CNPJ (or its 8-character root), CPF, name, state or inspection year. Each listing carries the establishment, workers found, activity, the final decision date and every period on the register. CPFs are matched exactly and returned masked. Updated daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Brazil","Ministério do Trabalho e Emprego (MTE)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/mte"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en los nombres (opcional)."},"document_number":{"type":"string","pattern":"^(?:\\d{11}|\\d{3}\\.\\d{3}\\.\\d{3}-\\d{2}|[A-Za-z0-9]{8}|[A-Za-z0-9]{12}\\d{2}|[A-Za-z0-9]{2}\\.[A-Za-z0-9]{3}\\.[A-Za-z0-9]{3}(?:\\/[A-Za-z0-9]{4}-\\d{2})?)?$","default":"","description":"CPF o CNPJ del empleador, con o sin puntuación, p. ej. `12.345.678/0001-90`, o la raíz de 8 caracteres de un CNPJ para todos sus establecimientos (opcional). Coincidencia exacta."},"list":{"type":"string","enum":["","slave_labour","conduct_adjustment"],"default":"","description":"Registro: `slave_labour` (empleadores que sometieron trabajadores a condiciones análogas a la esclavitud) o `conduct_adjustment` (empleadores en ajuste de conducta) (opcional; por defecto ambos)."},"party_type":{"type":"string","enum":["","individual","company"],"default":"","description":"Tipo de parte: `individual` (persona) o `company` (empresa u organización) (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Za-z]{2})?$","default":"","description":"Sigla del estado (UF) de la fiscalización, p. ej. `PA` (opcional)."},"inspection_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Año de la fiscalización, p. ej. `2024`; `0` sin filtro (opcional)."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"query":"fazenda"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MteSlaveLabourSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/mte/employer/v1":{"post":{"operationId":"mte_employer","summary":"MTE Slave Labour Register Listing","description":"One listing from Brazil's slave labour employer registers, by the `id` the search returns. `found: false` once the employer has left the register.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Brazil","Ministério do Trabalho e Emprego (MTE)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/mte"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^(?:slave_labour|conduct_adjustment)-[a-f0-9]{16}$","description":"Id del registro, p. ej. `slave_labour-3f9a0c12d4e5b6a7`, como lo devuelve la búsqueda."}},"additionalProperties":false},"example":{"id":"slave_labour-3f9a0c12d4e5b6a7"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MteSlaveLabourEmployerResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/ibama/embargoes-search/v1":{"post":{"operationId":"ibama_embargoes_search","summary":"IBAMA Environmental Embargoes Search","description":"Search every environmental embargo Brazil's federal environmental agency (IBAMA) has imposed since 1987, by CPF or CNPJ (or its 8-character root), name or property, state, municipality, term number or date. Each embargo carries its status (`active`, `lifted`, `cancelled`), the area in hectares, the place, the infraction and the process; the response counts how many matches are active. CPFs are matched exactly and returned masked. Updated daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Brazil","IBAMA (environmental embargoes)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/ibama"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Palabras a buscar en los nombres (opcional)."},"document_number":{"type":"string","pattern":"^(?:\\d{11}|\\d{3}\\.\\d{3}\\.\\d{3}-\\d{2}|[A-Za-z0-9]{8}|[A-Za-z0-9]{12}\\d{2}|[A-Za-z0-9]{2}\\.[A-Za-z0-9]{3}\\.[A-Za-z0-9]{3}(?:\\/[A-Za-z0-9]{4}-\\d{2})?)?$","default":"","description":"CPF o CNPJ de la persona o empresa embargada, con o sin puntuación, p. ej. `12.345.678/0001-90`, o la raíz de 8 caracteres de un CNPJ para todos sus establecimientos (opcional). Coincidencia exacta."},"status":{"type":"string","enum":["","active","lifted","cancelled"],"default":"","description":"Situación: `active` (embargo vigente), `lifted` (levantado) o `cancelled` (anulado) (opcional; por defecto todas)."},"state":{"type":"string","pattern":"^(?:[A-Za-z]{2})?$","default":"","description":"Sigla del estado (UF) del lugar embargado, p. ej. `PA` (opcional)."},"municipality_code":{"type":"string","pattern":"^(?:\\d{7})?$","default":"","description":"Código IBGE de 7 dígitos del municipio del lugar embargado, p. ej. `1500602` (opcional)."},"term_number":{"type":"string","maxLength":40,"default":"","description":"Número del término de embargo, tal como lo imprime IBAMA (opcional). Coincidencia exacta."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"state":"PA","status":"active","per_page":5}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbamaEmbargoesSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/ibama/embargo/v1":{"post":{"operationId":"ibama_embargo","summary":"IBAMA Environmental Embargo","description":"One environmental embargo from IBAMA by the `id` the search returns: the party, the place and area, the infraction and whether it is active, lifted or cancelled.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Brazil","IBAMA (environmental embargoes)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/ibama"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^(?:\\d{1,10}|aie-[a-z0-9]{1,20})$","description":"Id del embargo, p. ej. `1234567`, como lo devuelve la búsqueda."}},"additionalProperties":false},"example":{"id":"1234567"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbamaEmbargoResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/planalto/laws-search/v1":{"post":{"operationId":"planalto_laws_search","summary":"Planalto Laws Search","description":"Search Brazil's federal legislation as the Presidência da República publishes it: the Constitution of 1988 and its amendments, and every lei complementar, lei ordinária, lei delegada, decreto-lei, decreto and medida provisória. Filter by `type`, a medida provisória's `measure_status`, exact `number` (with or without the thousands dot), signature `year` or a signature date range (`from_date`, `to_date`), and match free text against the act's name, its ementa and its full text. Results come most recently signed first, without the text; read one act with the Planalto Law endpoint. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Brazil","Presidência da República (Planalto)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/planalto"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Términos de búsqueda en el nombre, la ementa y el texto completo del acto (opcional)."},"type":{"type":"string","enum":["","constitution","constitutional_amendment","complementary_law","ordinary_law","delegated_law","decree_law","decree","provisional_measure"],"default":"","description":"Tipo de acto: `constitution` (la Constitución de 1988), `constitutional_amendment` (enmiendas constitucionales, incluidas las de revisión), `complementary_law`, `ordinary_law`, `delegated_law`, `decree_law`, `decree` o `provisional_measure` (medida provisória) (opcional; por defecto todos)."},"measure_status":{"type":"string","enum":["","pending","converted","lapsed","rejected","prejudiced","revoked"],"default":"","description":"Situación de una medida provisória: `pending` (en trámite), `converted` (convertida en ley), `lapsed` (vigencia terminada sin votación), `rejected`, `prejudiced` (prejudicada) o `revoked` (opcional)."},"number":{"type":"string","pattern":"^(?:\\d[\\d.]{0,9}(?:\\s*-?\\s*[A-Za-z0-9]{1,3})?)?$","default":"","description":"Número del acto, con o sin punto de miles, p. ej. `13105` o `13.105` (opcional). Coincidencia exacta."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Año en que se firmó el acto, p. ej. `2015`; `0` sin filtro (opcional). Distingue actos que comparten número."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Resultados por página (1-50)."}},"additionalProperties":false},"example":{"type":"ordinary_law","number":"13105"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanaltoLawsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/br/planalto/law/v1":{"post":{"operationId":"planalto_law","summary":"Planalto Law","description":"Retrieve one Brazilian federal act by the `law_id` the search returns (`lei-13105-2015`, `cf-1988`): its current consolidated text, whole or one `article`, its ementa, signature and publication dates, whether it was revoked and by what, a medida provisória's standing and the law it became, the later acts that amended it article by article, and the earlier acts it amended in turn. The text comes back a character range at a time (`offset`, `limit`); follow `next_offset` until `has_more` is false.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Brazil","Presidência da República (Planalto)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/planalto"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["law_id"],"properties":{"law_id":{"type":"string","pattern":"^(?:cf-\\d{4}|(?:lei|lcp|ldl|del|emc|ecr|mpv|dec)-[0-9a-z]+(?:-[0-9a-z]+)*-\\d{4})$","description":"Id del acto, p. ej. `lei-13105-2015` o `cf-1988`, como lo devuelve la búsqueda."},"article":{"type":"string","pattern":"^(?:\\d[\\d.]{0,6}\\s*[º°o]?\\s*(?:-?\\s*[A-Za-z]{1,2})?)?$","default":"","description":"Número de un artículo, p. ej. `12`, `1.029` u `8-A`, para devolver solo ese artículo (opcional)."},"offset":{"type":"integer","minimum":0,"maximum":10000000,"default":0,"description":"First character of the range to return. Pass the previous response's `next_offset` to continue reading."},"limit":{"type":"integer","minimum":1000,"maximum":1000000,"default":200000,"description":"Maximum characters to return (1000-1000000)."}},"additionalProperties":false},"example":{"law_id":"lei-13105-2015","article":"1.029"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanaltoLawResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/corte-constitucional/rulings-search/v1":{"post":{"operationId":"corte_constitucional_rulings_search","summary":"Corte Constitucional Rulings Search","description":"Search every ruling the Corte Constitucional de Colombia has published since 1992: tutela (T), constitutionality (C) and unification (SU) judgments and autos (A). Free text matches the ruling's number, case file number, topics, synopsis, decision and full text. Filter by `type`, `year`, `registration_number` (the expediente), `reporting_judge` (the magistrado ponente) and the ruling date (`from_date`/`to_date`). Each result links to the ruling on the court's own site. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Corte Constitucional"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/corte-constitucional"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the ruling's number, case file number, topics, synopsis, decision and full text."},"type":{"type":"string","maxLength":40,"default":"","description":"Optional kind of ruling: `T` (tutela), `C` (constitucionalidad), `SU` (unificación) or `A` (auto). The Spanish names work too."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the ruling (the 2025 of T-013/25). 0 searches every year."},"registration_number":{"type":"string","maxLength":40,"default":"","description":"Optional case file number (expediente) as the court writes it: `T-10417884`, `D-15234`, `CJU-6063`. Case and spaces are ignored."},"reporting_judge":{"type":"string","maxLength":120,"default":"","description":"Optional magistrado ponente, by full name as it appears in `reporting_judges`. Case and accents are ignored."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"mínimo vital","type":"T"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorteConstitucionalRulingsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/corte-constitucional/ruling/v1":{"post":{"operationId":"corte_constitucional_ruling","summary":"Corte Constitucional Ruling","description":"Retrieve one ruling of the Corte Constitucional de Colombia by its number (`T-013/25`, `SU.502/25`, `A. 006/25`) or its `relatoria_id`: its full text, what the court decided, the rights at stake, the magistrado ponente, the case file number and the link to the ruling on the court's own site. The text comes back a character range at a time (`offset`, `limit`); follow `next_offset` until `has_more` is false.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Corte Constitucional"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/corte-constitucional"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ruling_id"],"properties":{"ruling_id":{"type":"string","pattern":"^\\s*(?:[A-Za-z]{1,2}\\s*[.\\-]?\\s*\\d{1,4}\\s*[A-Za-z]?\\s*[/\\-]\\s*\\d{2}|\\d{1,9})\\s*$","description":"The ruling's number in any of the court's notations (`T-013/25`, `SU.502/25`, `A. 006/25`, `T-013-25`) or its `relatoria_id` (`47977`)."},"offset":{"type":"integer","minimum":0,"maximum":10000000,"default":0,"description":"First character of the range to return. Pass the previous response's `next_offset` to continue reading."},"limit":{"type":"integer","minimum":1000,"maximum":1000000,"default":200000,"description":"Maximum characters to return (1000-1000000)."}},"additionalProperties":false},"example":{"ruling_id":"T-013/25"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorteConstitucionalRulingResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/corte-suprema/rulings-search/v1":{"post":{"operationId":"corte_suprema_rulings_search","summary":"Corte Suprema Rulings Search","description":"Search every ruling the Corte Suprema de Justicia de Colombia has published since 1886, from every chamber, tutelas included. Free text matches the ruling's number, case file number, ponente, summary, topics and full text. Filter by `chamber` (civil, laboral, penal, plena and the historic chambers), `type` (SENTENCIA, AUTO...), `is_tutela`, `year`, `registration_number` (the radicado), `reporting_judge` (the magistrado ponente) and the ruling date (`from_date`/`to_date`). Each result links to the ruling's document at the court. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Corte Suprema de Justicia"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/corte-suprema"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","maxLength":300,"default":"","description":"Optional search terms matched against the ruling's number, case file number, ponente, summary, topics and full text."},"chamber":{"type":"string","maxLength":60,"default":"","description":"Optional chamber: `civil`, `laboral`, `penal`, `plena`, or the historic `constitucional` and `negocios-generales`."},"type":{"type":"string","maxLength":60,"default":"","description":"Optional kind of ruling as the court names it (`SENTENCIA`, `AUTO`, `AUTO INTERLOCUTORIO`), matched from the start of the name."},"is_tutela":{"type":["boolean","null"],"default":null,"description":"Optional: `true` for tutela decisions only, `false` for the chambers' own matters only. Omit it for both."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the ruling. 0 searches every year."},"registration_number":{"type":"string","maxLength":60,"default":"","description":"Optional case file number (radicado), with or without dashes: `11001-02-03-000-2026-04999-00`. Only the digits are compared."},"reporting_judge":{"type":"string","maxLength":120,"default":"","description":"Optional magistrado ponente, by full name as it appears in `reporting_judges`. Case and accents are ignored."},"from_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"to_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"prescripción adquisitiva","chamber":"civil"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorteSupremaRulingsSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/co/corte-suprema/ruling/v1":{"post":{"operationId":"corte_suprema_ruling","summary":"Corte Suprema Ruling","description":"Retrieve one ruling of the Corte Suprema de Justicia de Colombia by its `id` (`978662`) or its number (`AC6049-2026`): its chamber, kind, case file number, magistrado ponente, the relatoría's summary and topics, its full text, and the link to the ruling's document at the court. The text comes back a character range at a time (`offset`, `limit`); follow `next_offset` until `has_more` is false. Served by Croma (`as_of` says how current the data is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Corte Suprema de Justicia"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/corte-suprema"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ruling_id"],"properties":{"ruling_id":{"type":"string","minLength":1,"maxLength":60,"pattern":"^\\s*[A-Za-z0-9][A-Za-z0-9 ./-]*\\s*$","description":"The ruling's `id` (`978662`) or its number as the court prints it (`AC6049-2026`)."},"offset":{"type":"integer","minimum":0,"maximum":10000000,"default":0,"description":"First character of the range to return. Pass the previous response's `next_offset` to continue reading."},"limit":{"type":"integer","minimum":1000,"maximum":1000000,"default":200000,"description":"Maximum characters to return (1000-1000000)."}},"additionalProperties":false},"example":{"ruling_id":"AC6049-2026"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorteSupremaRulingResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/global/web-search/v1":{"post":{"operationId":"web_search","summary":"Web Search","description":"AI-powered web search. Returns structured results with URLs, titles, authors, dates, highlights, and relevance scores.","tags":["Global","Croma"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/global/web-search"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string","minLength":3,"maxLength":300,"description":"Natural-language search query."},"limit":{"type":"integer","minimum":1,"maximum":25,"default":10,"description":"Number of results to return."}},"additionalProperties":false},"example":{"query":"croma api colombia"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebSearchResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/global/extract/markdown/v1":{"post":{"operationId":"extract_markdown","summary":"Extract Markdown","description":"Turn any public web page into clean Markdown. `scope` keeps either the article body or the whole page, and `include_metadata` adds the page's title, author, published date and image. Handles pages that render themselves in the browser at `effort: max`.","tags":["Global","Croma"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/global/extract"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","maxLength":2000,"description":"Public http or https URL of the page to read. Loopback and private addresses are not accepted."},"scope":{"type":"string","enum":["main","full"],"default":"main","description":"`main` keeps the article body and drops navigation and boilerplate; `full` keeps the whole page."},"effort":{"type":"string","enum":["min","standard","max"],"default":"standard","description":"Effort to spend on the page: `min` is fastest and may serve a recent copy, `standard` is the balanced default, `max` always reads the page live and handles pages that render themselves in the browser."},"include_metadata":{"type":"boolean","default":false,"description":"Include the page's title, author, published date and image in the response."}},"additionalProperties":false},"example":{"url":"https://www.funcionpublica.gov.co/eva/gestornormativo/norma.php?i=304"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractMarkdownResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found in upstream source","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/global/extract/json/v1":{"post":{"operationId":"extract_json","summary":"Extract JSON","description":"Pull structured data off any public web page. You supply a JSON Schema describing the object you want and the fields are located on the page and returned under `result`, already typed.","tags":["Global","Croma"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/global/extract"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url","json_schema"],"properties":{"url":{"type":"string","format":"uri","maxLength":2000,"description":"Public http or https URL of the page to read. Loopback and private addresses are not accepted."},"json_schema":{"type":"object","description":"JSON Schema for the object to return. Field names and nesting are yours; describe each field so it can be located on the page."},"effort":{"type":"string","enum":["min","standard","max"],"default":"standard","description":"Effort to spend on the page: `min` is fastest and may serve a recent copy, `standard` is the balanced default, `max` always reads the page live and handles pages that render themselves in the browser."}},"additionalProperties":false},"example":{"url":"https://www.funcionpublica.gov.co/eva/gestornormativo/norma.php?i=304","json_schema":{"type":"object","required":["title"],"properties":{"title":{"type":"string","description":"Nombre de la norma."},"issued_on":{"type":"string","description":"Fecha de expedición."}}}}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredDataResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found in upstream source","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/global/generate/json/v1":{"post":{"operationId":"generate_json","summary":"Generate JSON","description":"Read a public web page and return a new object built from it, following your `instructions` and your JSON Schema. Unlike `extract-json`, the fields need not appear on the page: summarize, classify, translate or reshape what is there.","tags":["Global","Croma"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/global/generate"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url","instructions","json_schema"],"properties":{"url":{"type":"string","format":"uri","maxLength":2000,"description":"Public http or https URL of the page to read. Loopback and private addresses are not accepted."},"instructions":{"type":"string","minLength":3,"maxLength":20000,"description":"What to do with the page: summarize, classify, translate, reformat. Write it as you would brief an analyst."},"json_schema":{"type":"object","description":"JSON Schema for the object to return. Field names and nesting are yours; describe each field so it can be located on the page."},"effort":{"type":"string","enum":["min","standard","max"],"default":"standard","description":"Effort to spend on the page: `min` is fastest and may serve a recent copy, `standard` is the balanced default, `max` always reads the page live and handles pages that render themselves in the browser."}},"additionalProperties":false},"example":{"url":"https://www.funcionpublica.gov.co/eva/gestornormativo/norma.php?i=304","instructions":"Resume la norma en dos frases y clasifica su materia principal.","json_schema":{"type":"object","required":["summary","subject"],"properties":{"summary":{"type":"string"},"subject":{"type":"string"}}}}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredDataResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found in upstream source","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/global/research/v1":{"post":{"operationId":"research","summary":"Research","description":"Answer an open question from live sources. Returns a written report in Markdown with numbered citations plus the list of sources behind it. Typically takes a few seconds; it is a research pass, not a lookup, so verify anything you act on against the primary source.","tags":["Global","Croma"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/global/research"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string","minLength":10,"maxLength":2000,"description":"The question to research, in plain language."}},"additionalProperties":false},"example":{"query":"¿Qué cambios trajo la Ley 2195 de 2022 en materia de responsabilidad de personas jurídicas en Colombia?"}}}},"responses":{"200":{"description":"Successful response","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"X-Cache":{"$ref":"#/components/headers/X-Cache"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchReportResponse"}}}},"400":{"description":"Invalid request body","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"},"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"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Upstream source returned an error","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/jobs/{id}":{"get":{"operationId":"get_job","summary":"Get Job Status","description":"Poll the status and result of an async job created by an async-capable endpoint. Returns the job envelope; `data` is populated once `status` is `completed`, `error` once it is `failed`. Jobs are org-scoped — another org's job reads as 404.","tags":["Jobs"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Job id returned as `job.id` / `X-Job-Id` when the job was created.","schema":{"type":"string"}}],"responses":{"200":{"description":"Job envelope (pending, completed, or failed).","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobEnvelope"}}}},"401":{"description":"Missing or invalid API key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Job not found","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Use Authorization: Bearer YOUR_API_KEY"}},"schemas":{"RamaJudicialSearchData":{"type":"object","properties":{"cases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"connection_id":{"type":"integer"},"registration_number":{"type":"string"},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_action_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"court":{"type":"string"},"department":{"type":"string"},"parties_text":{"type":"string"},"is_private":{"type":"boolean"}},"required":["id","connection_id","registration_number","start_date","last_action_date","court","department","parties_text","is_private"]}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"page_size":{"type":"integer"},"total_pages":{"type":"integer"},"page":{"type":"integer"}},"required":["total","page_size","total_pages","page"]}},"required":["cases","pagination"]},"RamaJudicialSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RamaJudicialSearchData"}}},"RamaJudicialCaseData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether a public case matched the radicado. When false, primary_case is null."},"registration_number":{"type":"string"},"case_ids":{"type":"array","items":{"type":"integer"}},"primary_case":{"anyOf":[{"type":"object","properties":{"id":{"type":"integer"},"connection_id":{"type":"integer"},"registration_number":{"type":"string"},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_action_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"court":{"type":"string"},"department":{"type":"string"},"parties_text":{"type":"string"},"is_private":{"type":"boolean"}},"required":["id","connection_id","registration_number","start_date","last_action_date","court","department","parties_text","is_private"]},{"type":"null"}]},"actions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"registration_number":{"type":"string"},"sequence":{"type":"integer"},"action_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"action_type":{"type":"string"},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_documents":{"type":"boolean"}},"required":["id","registration_number","sequence","action_date","action_type","note","start_date","end_date","registered_date","has_documents"]}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"page_size":{"type":"integer"},"total_pages":{"type":"integer"},"page":{"type":"integer"}},"required":["total","page_size","total_pages","page"]},"private_only":{"type":"boolean"}},"required":["found","registration_number","case_ids","primary_case","actions","pagination"]},"RamaJudicialCaseResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RamaJudicialCaseData"}}},"RamaJudicialBatchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["results","summary"],"properties":{"results":{"type":"array","description":"One entry per input item, in input order. `data` is present when status=completed; `error` when status=error.","items":{"type":"object","required":["index","status"],"properties":{"index":{"type":"integer","description":"0-based position in the request `items` array."},"status":{"type":"string","enum":["completed","error"]},"cache_hit":{"type":"boolean","description":"Present on completed items; true when served from cache."},"data":{"$ref":"#/components/schemas/RamaJudicialCaseData"},"error":{"$ref":"#/components/schemas/BatchItemError"}}}},"summary":{"$ref":"#/components/schemas/BatchSummary"}}}}},"RamaJudicialEmailDirectoryData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"corporation":{"anyOf":[{"type":"string"},{"type":"null"}]},"specialty":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"court_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"district":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":"The mailbox address, e.g. `jcctobog01@cendoj.ramajudicial.gov.co`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office or area as the directory names it, e.g. \"Juzgado 01 Civil Circuito - Bogotá - Bogotá D.C.\"."},"account_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the mailbox belongs to, as the directory labels it: \"Despacho Judicial\" (a court) or \"Área\" (an administrative or service area)."},"corporation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of office, as the directory writes it: \"Juzgado De Circuito\", \"Tribunal Superior\", \"Centro De Servicios Judiciales\", \"Corte Suprema De Justicia\" and others."},"corporation_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The corporation in canonical form, e.g. `juzgado-de-circuito`. Filter on this by prefix."},"specialty":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office's specialty, as the directory writes it: \"Civil\", \"Laboral\", \"Penal Con Función De Conocimiento\", \"No Aplica\" on administrative areas, and others."},"specialty_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The specialty in canonical form, e.g. `penal-con-funcion-de-conocimiento`. Filter on this by prefix."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department, as the directory writes it: \"Bogotá\", \"Santander\", \"N. De Santander\"."},"department_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department in canonical form, e.g. `n-de-santander`. Filter on this by prefix."},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The city, as the directory writes it: \"Bogotá D.C.\", \"Medellín\", \"Paz De Ariporo\"."},"city_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The city in canonical form, e.g. `bogota-d-c`. Filter on this by prefix."},"district":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judicial branch's administrative district for the office, as the directory writes it: \"Seccional Bucaramanga\", \"Seccional Nivel Central\"."},"district_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The district in canonical form with the `Seccional` prefix dropped, e.g. `bucaramanga`, `nivel-central`. Filter on this by prefix."},"court_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office's 12-digit code (código de despacho). It is the first 12 digits of every radicado filed at the office, so a case number resolves the mailbox of the court that holds it."}},"required":["email","name","account_type","corporation","corporation_key","specialty","specialty_key","department","department_key","city","city_key","district","district_key","court_code"]}}},"required":["as_of","query","department","city","corporation","specialty","account_type","court_code","district","total","page","per_page","total_pages","count","results"]},"RamaJudicialEmailDirectoryResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RamaJudicialEmailDirectoryData"}}},"RamaJudicialEmailsByCourtData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"Whether the directory holds any mailbox for this court code. When false, mailboxes is empty."},"court_code":{"type":"string"},"count":{"type":"number"},"mailboxes":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":"The mailbox address, e.g. `jcctobog01@cendoj.ramajudicial.gov.co`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office or area as the directory names it, e.g. \"Juzgado 01 Civil Circuito - Bogotá - Bogotá D.C.\"."},"account_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the mailbox belongs to, as the directory labels it: \"Despacho Judicial\" (a court) or \"Área\" (an administrative or service area)."},"corporation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of office, as the directory writes it: \"Juzgado De Circuito\", \"Tribunal Superior\", \"Centro De Servicios Judiciales\", \"Corte Suprema De Justicia\" and others."},"corporation_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The corporation in canonical form, e.g. `juzgado-de-circuito`. Filter on this by prefix."},"specialty":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office's specialty, as the directory writes it: \"Civil\", \"Laboral\", \"Penal Con Función De Conocimiento\", \"No Aplica\" on administrative areas, and others."},"specialty_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The specialty in canonical form, e.g. `penal-con-funcion-de-conocimiento`. Filter on this by prefix."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department, as the directory writes it: \"Bogotá\", \"Santander\", \"N. De Santander\"."},"department_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department in canonical form, e.g. `n-de-santander`. Filter on this by prefix."},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The city, as the directory writes it: \"Bogotá D.C.\", \"Medellín\", \"Paz De Ariporo\"."},"city_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The city in canonical form, e.g. `bogota-d-c`. Filter on this by prefix."},"district":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judicial branch's administrative district for the office, as the directory writes it: \"Seccional Bucaramanga\", \"Seccional Nivel Central\"."},"district_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The district in canonical form with the `Seccional` prefix dropped, e.g. `bucaramanga`, `nivel-central`. Filter on this by prefix."},"court_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office's 12-digit code (código de despacho). It is the first 12 digits of every radicado filed at the office, so a case number resolves the mailbox of the court that holds it."}},"required":["email","name","account_type","corporation","corporation_key","specialty","specialty_key","department","department_key","city","city_key","district","district_key","court_code"]}}},"required":["as_of","found","court_code","count","mailboxes"]},"RamaJudicialEmailsByCourtResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RamaJudicialEmailsByCourtData"}}},"VitalStatusData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the cédula is in the registry. When false, `status` is null."},"document_number":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["ALIVE","DECEASED","UNKNOWN"]},{"type":"null"}],"description":"Normalized vigilance status when found. null when the cédula isn't in the registry. UNKNOWN = an upstream value Croma doesn't recognize."}},"required":["found","document_number","status"]},"VitalStatusResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/VitalStatusData"}}},"RegistroCivilBirthRecordData":{"type":"object","properties":{"found":{"type":"boolean","description":"false when the register has no birth registry for this query."},"first_surname":{"type":"string","description":"The queried first surname, echoed back."},"first_name":{"type":"string","description":"The queried first name, echoed back."},"sex":{"type":"string","enum":["M","F"],"description":"The queried sex, echoed back."},"birth_date":{"type":"string","description":"The queried date of birth (yyyy-mm-dd), echoed back."},"records":{"type":"array","items":{"type":"object","properties":{"serial":{"type":"string","description":"Serial printed on the civil registry."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NUIP / NIP / Tarjeta de Identidad tied to the record, when the register lists one."},"first_surname":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Primer apellido on the record."},"second_surname":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Segundo apellido on the record."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Primer nombre on the record."},"second_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Segundo nombre on the record."},"full_name":{"type":"string","description":"The record's names and surnames joined into one string."},"sex":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sex as the register reports it (\"MASCULINO\" / \"FEMENINO\")."},"record_type":{"type":"string","description":"Kind of civil registry, e.g. \"REGISTRO CIVIL DE NACIMIENTO\"."},"registration_office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Office the registry was inscribed at, e.g. \"NOTARIA 4 BARRANQUILLA - ATLANTICO\". null on a multi-record list row."},"registered_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription date (yyyy-mm-dd), or null when the register does not expose it on this row."}},"required":["serial","document_number","first_surname","second_surname","first_name","second_name","full_name","sex","record_type","registration_office","registered_at"]},"description":"Matching civil registries; empty when none are found."},"checked_at":{"type":"string","description":"When this answer was read, as an ISO timestamp."}},"required":["found","first_surname","first_name","sex","birth_date","records","checked_at"]},"RegistroCivilBirthRecordResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RegistroCivilBirthRecordData"}}},"RuafData":{"type":"object","properties":{"found":{"type":"boolean","description":"false when the register has no record for this document."},"issue_date_matches":{"type":"boolean","description":"false when the register does not accept the document and issue_date together. It answers the same way whether the date is wrong or the document is not on file, so this does not on its own tell those apart. Nothing else is returned in that case."},"document_type":{"type":"string","enum":["CC","CE","TI","RC","PA","PEP","PPT"],"description":"The queried document type, echoed back."},"document_type_label":{"type":"string","description":"Human label for the document type."},"document_number":{"type":"string","description":"The queried document number, echoed back."},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered names and surnames, null when not found."},"sex":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sex as the register reports it (\"M\" / \"F\"), when present."},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own cut-off date for this report (yyyy-mm-dd)."},"affiliations":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","description":"Subsystem the affiliation belongs to: \"Salud\", \"Pensiones\", \"Riesgos Laborales\", \"Cesantías\", \"Compensación Familiar\", \"Pensionados\" or \"Programas de Asistencia Social\"."},"entity_name":{"type":"string","description":"Administrator the person is affiliated to."},"regime":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Regime or scheme, e.g. \"Contributivo\" or \"PENSIONES: AHORRO INDIVIDUAL\"."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Affiliation status as the source words it, e.g. \"Activo\", \"Retirado\", \"VIGENTE\"."},"affiliate_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the person is attached, e.g. \"COTIZANTE\" or \"BENEFICIARIO\". Health only."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Affiliation start date (yyyy-mm-dd), or null when the source omits it."},"economic_activity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Employer's economic activity. Occupational risk only."},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department and municipality the affiliation is registered in, when reported."}},"required":["system","entity_name","regime","status","affiliate_type","start_date","economic_activity","location"]},"description":"Affiliations on record; empty when there are none or the person is not found."},"checked_at":{"type":"string","description":"When this answer was read, as an ISO timestamp."}},"required":["found","issue_date_matches","document_type","document_type_label","document_number","full_name","sex","as_of","affiliations","checked_at"]},"RuafResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RuafData"}}},"RuesEntitySearchData":{"type":"object","properties":{"query":{"type":"string"},"capped":{"type":"boolean"},"entities":{"type":"array","items":{"type":"object","properties":{"registry_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification_digit":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"acronym":{"anyOf":[{"type":"string"},{"type":"null"}]},"chamber_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"chamber_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_organization":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_renewed_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"detail":{"anyOf":[{"type":"object","properties":{"registry_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification_digit":{"anyOf":[{"type":"string"},{"type":"null"}]},"identification_class":{"anyOf":[{"type":"string"},{"type":"null"}]},"secondary_identification":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"acronym":{"anyOf":[{"type":"string"},{"type":"null"}]},"chamber_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"chamber_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_category":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_organization":{"anyOf":[{"type":"string"},{"type":"null"}]},"society_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"society_type_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_renewed_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancellation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancellation_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"primary_activity":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"]},"secondary_activity":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"]},"ciiu_3":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"]},"ciiu_4":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"]},"commercial_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"commercial_municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"commercial_phones":{"type":"array","items":{"type":"string"}},"commercial_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_phones":{"type":"array","items":{"type":"string"}},"fiscal_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_bic":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_social_enterprise":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_law_1780":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_transport":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"domain_forfeiture":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"sipref_inactivation_control":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"certificates_sale_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["registry_id","nit","verification_digit","identification_class","secondary_identification","name","acronym","chamber_code","chamber_name","registration_number","registration_status","registration_category","legal_organization","society_type","society_type_code","registration_date","last_renewal_date","last_renewed_year","expiration_date","cancellation_date","cancellation_reason","updated_date","primary_activity","secondary_activity","ciiu_3","ciiu_4","commercial_address","commercial_municipality","commercial_phones","commercial_email","fiscal_address","fiscal_municipality","fiscal_phones","fiscal_email","is_bic","is_social_enterprise","is_law_1780","is_transport","domain_forfeiture","sipref_inactivation_control","certificates_sale_url"]},{"type":"null"}]}},"required":["registry_id","nit","verification_digit","name","acronym","chamber_code","chamber_name","registration_number","registration_status","legal_organization","last_renewed_year","category","document_type","detail"]}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"page_size":{"type":"integer"},"total_pages":{"type":"integer"},"page":{"type":"integer"}},"required":["total","page_size","total_pages","page"]}},"required":["query","capped","entities","pagination"]},"RuesEntitySearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RuesEntitySearchData"}}},"RuesEntityData":{"type":"object","properties":{"found":{"type":"boolean"},"document_number":{"type":"string"},"entity":{"anyOf":[{"type":"object","properties":{"registry_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification_digit":{"anyOf":[{"type":"string"},{"type":"null"}]},"identification_class":{"anyOf":[{"type":"string"},{"type":"null"}]},"secondary_identification":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"acronym":{"anyOf":[{"type":"string"},{"type":"null"}]},"chamber_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"chamber_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_category":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_organization":{"anyOf":[{"type":"string"},{"type":"null"}]},"society_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"society_type_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_renewed_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancellation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancellation_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"primary_activity":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"]},"secondary_activity":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"]},"ciiu_3":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"]},"ciiu_4":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"]},"commercial_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"commercial_municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"commercial_phones":{"type":"array","items":{"type":"string"}},"commercial_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_phones":{"type":"array","items":{"type":"string"}},"fiscal_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_bic":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_social_enterprise":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_law_1780":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_transport":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"domain_forfeiture":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"sipref_inactivation_control":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"certificates_sale_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["registry_id","nit","verification_digit","identification_class","secondary_identification","name","acronym","chamber_code","chamber_name","registration_number","registration_status","registration_category","legal_organization","society_type","society_type_code","registration_date","last_renewal_date","last_renewed_year","expiration_date","cancellation_date","cancellation_reason","updated_date","primary_activity","secondary_activity","ciiu_3","ciiu_4","commercial_address","commercial_municipality","commercial_phones","commercial_email","fiscal_address","fiscal_municipality","fiscal_phones","fiscal_email","is_bic","is_social_enterprise","is_law_1780","is_transport","domain_forfeiture","sipref_inactivation_control","certificates_sale_url"]},{"type":"null"}]},"financials":{"type":"array","items":{"type":"object","properties":{"year":{"anyOf":[{"type":"string"},{"type":"null"}]},"current_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_current_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_current_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"equity":{"anyOf":[{"type":"number"},{"type":"null"}]},"social_balance":{"anyOf":[{"type":"number"},{"type":"null"}]},"ordinary_revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"other_income":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_of_sales":{"anyOf":[{"type":"number"},{"type":"null"}]},"operating_expenses":{"anyOf":[{"type":"number"},{"type":"null"}]},"other_expenses":{"anyOf":[{"type":"number"},{"type":"null"}]},"tax_expenses":{"anyOf":[{"type":"number"},{"type":"null"}]},"operating_profit":{"anyOf":[{"type":"number"},{"type":"null"}]},"period_result":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["year","current_assets","non_current_assets","total_assets","current_liabilities","non_current_liabilities","total_liabilities","equity","social_balance","ordinary_revenue","other_income","cost_of_sales","operating_expenses","other_expenses","tax_expenses","operating_profit","period_result"]}},"renewals":{"type":"array","items":{"type":"object","properties":{"year":{"anyOf":[{"type":"string"},{"type":"null"}]},"renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["year","renewal_date"]}},"related_parties":{"type":"array","items":{"type":"object","properties":{"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"role":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["document_number","name","role"]}},"notices":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"act":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"chamber_name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","act","note","published_date","registered_date","chamber_name"]}}},"required":["found","document_number","entity","financials","renewals","related_parties","notices"]},"RuesEntityResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RuesEntityData"}}},"AntecedentesData":{"type":"object","properties":{"document_type":{"type":"string","enum":["CC","CE","PA","DPO"],"description":"The queried document type, echoed back."},"document_type_label":{"type":"string","description":"Human label for the document type, e.g. \"Cédula de Ciudadanía\"."},"document_number":{"type":"string","description":"The queried document number, echoed back."},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Full name as registered (\"Apellidos y Nombres\"); null when the source omits it."},"has_records":{"type":"boolean","description":"false when the person has no pending judicial matters; true when records / pending matters are registered."},"status":{"type":"string","description":"The verbatim verdict sentence from the source."},"message":{"type":"string","description":"Full plain-text result message, for audit/display."},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consultation timestamp the source prints, or null if absent."}},"required":["document_type","document_type_label","document_number","full_name","has_records","status","message","checked_at"]},"AntecedentesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AntecedentesData"}}},"SiataConditionsData":{"type":"object","properties":{"meteorology":{"type":"array","items":{"type":"object","properties":{"station":{"type":"string"},"station_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"distance_km":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Great-circle distance in km from the query point; null when no location filter was applied."},"temperature_c":{"anyOf":[{"type":"number"},{"type":"null"}]},"humidity_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"wind_speed_ms":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Wind speed in m/s."},"wind_direction_deg":{"anyOf":[{"type":"number"},{"type":"null"}]},"wind_direction_cardinal":{"anyOf":[{"type":"string"},{"type":"null"}]},"pressure_hpa":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["station","station_code","latitude","longitude","updated_at","distance_km","temperature_c","humidity_pct","wind_speed_ms","wind_direction_deg","wind_direction_cardinal","pressure_hpa"]}},"rain":{"type":"array","items":{"type":"object","properties":{"station":{"type":"string"},"station_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"distance_km":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Great-circle distance in km from the query point; null when no location filter was applied."},"accumulated_mm":{"anyOf":[{"type":"number"},{"type":"null"}]},"intensity_mm_h":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["station","station_code","latitude","longitude","updated_at","distance_km","accumulated_mm","intensity_mm_h"]}},"air_quality":{"type":"array","items":{"type":"object","properties":{"station":{"type":"string"},"station_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"distance_km":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Great-circle distance in km from the query point; null when no location filter was applied."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"pm25":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"24-hour average PM2.5 concentration (µg/m³)."},"air_quality_index":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Colombia's air-quality index (ICA), 24-hour average."}},"required":["station","station_code","latitude","longitude","updated_at","distance_km","municipality","pm25","air_quality_index"]}}},"required":["meteorology","rain","air_quality"]},"SiataConditionsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiataConditionsData"},"deprecation":{"type":"object","description":"Present only while this endpoint is being retired. Mirrors the Deprecation, Sunset and Link response headers.","required":["since","sunset","successor","message"],"properties":{"since":{"type":"string","format":"date"},"sunset":{"type":"string","format":"date"},"successor":{"type":"string","description":"Path of the endpoint to use instead."},"message":{"type":"string"}}}}},"SiataGeoportalWeatherData":{"type":"object","properties":{"stations":{"type":"array","items":{"type":"object","properties":{"station_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"station":{"type":"string"},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of the station's last update at the source."},"distance_km":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Great-circle distance in km from the query point; null when no location filter was applied."},"temperature_c":{"anyOf":[{"type":"number"},{"type":"null"}]},"humidity_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"wind_speed_ms":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Wind speed in m/s."},"wind_direction_deg":{"anyOf":[{"type":"number"},{"type":"null"}]},"wind_direction_cardinal":{"anyOf":[{"type":"string"},{"type":"null"}]},"pressure_hpa":{"anyOf":[{"type":"number"},{"type":"null"}]},"series_12h":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string"},"temperature_c":{"anyOf":[{"type":"number"},{"type":"null"}]},"humidity_pct":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["at","temperature_c","humidity_pct"]},"description":"Hourly temperature and humidity over the last 12 hours, oldest first."}},"required":["station_code","station","municipality","latitude","longitude","updated_at","distance_km","temperature_c","humidity_pct","wind_speed_ms","wind_direction_deg","wind_direction_cardinal","pressure_hpa","series_12h"]}},"uv":{"anyOf":[{"type":"object","properties":{"station_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"station":{"type":"string"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"index":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"UV index."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's UV category, e.g. `Bajo`, `Moderado`, `Alto`."},"temperature_c":{"anyOf":[{"type":"number"},{"type":"null"}]},"measured_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"series":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string"},"index":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["at","index"]},"description":"Hourly UV index today, oldest first."}},"required":["station_code","station","latitude","longitude","index","category","temperature_c","measured_at","series"]},{"type":"null"}],"description":"The valley's UV reading; null when the sensor has not reported."}},"required":["stations","uv"]},"SiataGeoportalWeatherResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiataGeoportalWeatherData"}}},"SiataGeoportalWeatherSeriesData":{"type":"object","properties":{"found":{"type":"boolean","description":"`false` when the source has no station with that code."},"station_code":{"type":"string"},"station":{"anyOf":[{"type":"string"},{"type":"null"}]},"window":{"type":"string","enum":["1h","6h"]},"resolution_minutes":{"type":"integer","description":"Spacing between points: 1 for the 1h window, 5 for the 6h window."},"points":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string"},"temperature_c":{"anyOf":[{"type":"number"},{"type":"null"}]},"humidity_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"wind_speed_ms":{"anyOf":[{"type":"number"},{"type":"null"}]},"pressure_hpa":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["at","temperature_c","humidity_pct","wind_speed_ms","pressure_hpa"]},"description":"Readings over the window, oldest first."},"mean":{"type":"object","properties":{"temperature_c":{"anyOf":[{"type":"number"},{"type":"null"}]},"humidity_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"wind_speed_ms":{"anyOf":[{"type":"number"},{"type":"null"}]},"pressure_hpa":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["temperature_c","humidity_pct","wind_speed_ms","pressure_hpa"],"description":"The source's mean over the whole window."},"mean_3h":{"anyOf":[{"type":"object","properties":{"temperature_c":{"anyOf":[{"type":"number"},{"type":"null"}]},"humidity_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"wind_speed_ms":{"anyOf":[{"type":"number"},{"type":"null"}]},"pressure_hpa":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["temperature_c","humidity_pct","wind_speed_ms","pressure_hpa"]},{"type":"null"}],"description":"The source's mean over the last three hours; only with the 6h window."},"temperature_percentiles":{"anyOf":[{"type":"object","properties":{"p10":{"anyOf":[{"type":"number"},{"type":"null"}]},"p25":{"anyOf":[{"type":"number"},{"type":"null"}]},"p50":{"anyOf":[{"type":"number"},{"type":"null"}]},"p75":{"anyOf":[{"type":"number"},{"type":"null"}]},"p90":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["p10","p25","p50","p75","p90"]},{"type":"null"}],"description":"The station's temperature percentiles as the source reports them, for context."}},"required":["found","station_code","station","window","resolution_minutes","points","mean","mean_3h","temperature_percentiles"]},"SiataGeoportalWeatherSeriesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiataGeoportalWeatherSeriesData"}}},"SiataGeoportalRiverLevelsData":{"type":"object","properties":{"stations":{"type":"array","items":{"type":"object","properties":{"station_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"station":{"type":"string"},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of the station's last update at the source."},"distance_km":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Great-circle distance in km from the query point; null when no location filter was applied."},"kind":{"type":"string","enum":["river","sewer"],"description":"`river` for a river or stream gauge, `sewer` for a storm-sewer sensor."},"sub_basin":{"anyOf":[{"type":"string"},{"type":"null"}]},"comuna":{"anyOf":[{"type":"string"},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string"},{"type":"null"}]},"level_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latest water level, in metres."},"measured_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of the latest reading."},"status":{"anyOf":[{"type":"string","enum":["normal","elevated","caution","minor_flood","major_flood"]},{"type":"null"}],"description":"Where the latest level sits against the station's thresholds; null when either is missing."},"thresholds":{"anyOf":[{"type":"object","properties":{"safe_m":{"anyOf":[{"type":"number"},{"type":"null"}]},"caution_m":{"anyOf":[{"type":"number"},{"type":"null"}]},"minor_flood_m":{"anyOf":[{"type":"number"},{"type":"null"}]},"major_flood_m":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["safe_m","caution_m","minor_flood_m","major_flood_m"]},{"type":"null"}],"description":"The station's flood thresholds, in metres; null for sewer sensors."},"max_level_3h_m":{"anyOf":[{"type":"number"},{"type":"null"}]},"mean_level_3h_m":{"anyOf":[{"type":"number"},{"type":"null"}]},"series_3h":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"at":{"type":"string"},"level_m":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["at","level_m"]}},{"type":"null"}],"description":"One reading per minute over the last three hours, oldest first; only with `include_series`."},"alert_color":{"anyOf":[{"type":"string","enum":["green","yellow","orange","red"]},{"type":"null"}],"description":"The source's alert colour for the reading; null when the station has no reading."},"alert_level":{"anyOf":[{"type":"integer","minimum":0,"maximum":3},{"type":"null"}],"description":"The source's alert level for the station, 0 (normal) to 3; null when not assessed."},"windows":{"anyOf":[{"type":"object","properties":{"last_30m":{"type":"object","properties":{"level_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Representative water level over the window, in metres."},"measured_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of that reading."},"alert_color":{"anyOf":[{"type":"string","enum":["green","yellow","orange","red"]},{"type":"null"}],"description":"The source's alert colour for the reading; null when the station has no reading."}},"required":["level_m","measured_at","alert_color"]},"last_1h":{"type":"object","properties":{"level_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Representative water level over the window, in metres."},"measured_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of that reading."},"alert_color":{"anyOf":[{"type":"string","enum":["green","yellow","orange","red"]},{"type":"null"}],"description":"The source's alert colour for the reading; null when the station has no reading."}},"required":["level_m","measured_at","alert_color"]},"last_3h":{"type":"object","properties":{"level_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Representative water level over the window, in metres."},"measured_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of that reading."},"alert_color":{"anyOf":[{"type":"string","enum":["green","yellow","orange","red"]},{"type":"null"}],"description":"The source's alert colour for the reading; null when the station has no reading."}},"required":["level_m","measured_at","alert_color"]},"last_24h":{"type":"object","properties":{"level_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Representative water level over the window, in metres."},"measured_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of that reading."},"alert_color":{"anyOf":[{"type":"string","enum":["green","yellow","orange","red"]},{"type":"null"}],"description":"The source's alert colour for the reading; null when the station has no reading."}},"required":["level_m","measured_at","alert_color"]},"last_72h":{"type":"object","properties":{"level_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Representative water level over the window, in metres."},"measured_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of that reading."},"alert_color":{"anyOf":[{"type":"string","enum":["green","yellow","orange","red"]},{"type":"null"}],"description":"The source's alert colour for the reading; null when the station has no reading."}},"required":["level_m","measured_at","alert_color"]},"last_30d":{"type":"object","properties":{"level_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Representative water level over the window, in metres."},"measured_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of that reading."},"alert_color":{"anyOf":[{"type":"string","enum":["green","yellow","orange","red"]},{"type":"null"}],"description":"The source's alert colour for the reading; null when the station has no reading."}},"required":["level_m","measured_at","alert_color"]}},"required":["last_30m","last_1h","last_3h","last_24h","last_72h","last_30d"]},{"type":"null"}]},"basin":{"anyOf":[{"type":"object","properties":{"area_km2":{"anyOf":[{"type":"number"},{"type":"null"}]},"perimeter_km":{"anyOf":[{"type":"number"},{"type":"null"}]},"channel_length_km":{"anyOf":[{"type":"number"},{"type":"null"}]},"max_elevation_m":{"anyOf":[{"type":"number"},{"type":"null"}]},"min_elevation_m":{"anyOf":[{"type":"number"},{"type":"null"}]},"relief_m":{"anyOf":[{"type":"number"},{"type":"null"}]},"channel_slope_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"mean_slope_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"drainage_density_km_per_km2":{"anyOf":[{"type":"number"},{"type":"null"}]},"concentration_time_min":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean time of concentration, in minutes."},"concentration_time_median_min":{"anyOf":[{"type":"number"},{"type":"null"}]},"urbanized_pct":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["area_km2","perimeter_km","channel_length_km","max_elevation_m","min_elevation_m","relief_m","channel_slope_pct","mean_slope_pct","drainage_density_km_per_km2","concentration_time_min","concentration_time_median_min","urbanized_pct"]},{"type":"null"}],"description":"Morphology of the drained basin; null when the source has none for the station."},"land_cover_pct":{"anyOf":[{"type":"object","properties":{"forest":{"anyOf":[{"type":"number"},{"type":"null"}]},"grass":{"anyOf":[{"type":"number"},{"type":"null"}]},"water":{"anyOf":[{"type":"number"},{"type":"null"}]},"bare_soil":{"anyOf":[{"type":"number"},{"type":"null"}]},"urban":{"anyOf":[{"type":"number"},{"type":"null"}]},"crops":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["forest","grass","water","bare_soil","urban","crops"]},{"type":"null"}],"description":"Land cover of the drained basin, in percent."}},"required":["station_code","station","municipality","latitude","longitude","updated_at","distance_km","kind","sub_basin","comuna","neighborhood","level_m","measured_at","status","thresholds","max_level_3h_m","mean_level_3h_m","series_3h","alert_color","alert_level","windows","basin","land_cover_pct"]}},"advisories":{"type":"array","items":{"type":"string"},"description":"Operational notices the source is currently showing for these layers."}},"required":["stations","advisories"]},"SiataGeoportalRiverLevelsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiataGeoportalRiverLevelsData"}}},"SiataGeoportalRainfallData":{"type":"object","properties":{"stations":{"type":"array","items":{"type":"object","properties":{"station_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"station":{"type":"string"},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of the station's last update at the source."},"distance_km":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Great-circle distance in km from the query point; null when no location filter was applied."},"comuna":{"anyOf":[{"type":"string"},{"type":"null"}]},"village":{"anyOf":[{"type":"string"},{"type":"null"}]},"district":{"anyOf":[{"type":"string"},{"type":"null"}]},"sub_basin":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_raining":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the gauge is registering rain right now."},"extreme_rain":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the source flags the current rain as extreme."},"extreme_category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's category for extreme rain, when flagged."},"accumulated_mm":{"type":"object","properties":{"last_5m":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_30m":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_1h":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_3h":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_24h":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_72h":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_30d":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["last_5m","last_30m","last_1h","last_3h","last_24h","last_72h","last_30d"]},"monthly":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string","description":"`YYYY-MM`."},"total_mm":{"anyOf":[{"type":"number"},{"type":"null"}]},"data_availability_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the month the gauge reported, in percent."}},"required":["month","total_mm","data_availability_pct"]}}},"required":["station_code","station","municipality","latitude","longitude","updated_at","distance_km","comuna","village","district","sub_basin","is_raining","extreme_rain","extreme_category","accumulated_mm","monthly"]}},"advisories":{"type":"array","items":{"type":"string"}}},"required":["stations","advisories"]},"SiataGeoportalRainfallResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiataGeoportalRainfallData"}}},"SiataGeoportalAirQualityData":{"type":"object","properties":{"stations":{"type":"array","items":{"type":"object","properties":{"station_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"station":{"type":"string"},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of the station's last update at the source."},"distance_km":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Great-circle distance in km from the query point; null when no location filter was applied."},"station_short":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's short station id, e.g. `BAR-TORR`."},"dominant_pollutant":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pollutant with the highest index at the station."},"dominant_index":{"anyOf":[{"type":"number"},{"type":"null"}]},"pm25":{"anyOf":[{"type":"object","properties":{"concentration":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","enum":["ug/m3","ppb"]},"index":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Colombia's air-quality index (ICA) for the reading."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ICA category, e.g. `Buena`, `Moderada`; null when there is no index."},"window_start":{"anyOf":[{"type":"string"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["concentration","unit","index","category","window_start","window_end"]},{"type":"null"}],"description":"24-hour PM2.5."},"pm10":{"anyOf":[{"type":"object","properties":{"concentration":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","enum":["ug/m3","ppb"]},"index":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Colombia's air-quality index (ICA) for the reading."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ICA category, e.g. `Buena`, `Moderada`; null when there is no index."},"window_start":{"anyOf":[{"type":"string"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["concentration","unit","index","category","window_start","window_end"]},{"type":"null"}],"description":"24-hour PM10."},"o3_8h":{"anyOf":[{"type":"object","properties":{"concentration":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","enum":["ug/m3","ppb"]},"index":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Colombia's air-quality index (ICA) for the reading."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ICA category, e.g. `Buena`, `Moderada`; null when there is no index."},"window_start":{"anyOf":[{"type":"string"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["concentration","unit","index","category","window_start","window_end"]},{"type":"null"}],"description":"8-hour ozone."},"no2_1h":{"anyOf":[{"type":"object","properties":{"concentration":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","enum":["ug/m3","ppb"]},"index":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Colombia's air-quality index (ICA) for the reading."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ICA category, e.g. `Buena`, `Moderada`; null when there is no index."},"window_start":{"anyOf":[{"type":"string"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["concentration","unit","index","category","window_start","window_end"]},{"type":"null"}],"description":"1-hour nitrogen dioxide."},"so2_1h":{"anyOf":[{"type":"object","properties":{"concentration":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","enum":["ug/m3","ppb"]},"index":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Colombia's air-quality index (ICA) for the reading."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ICA category, e.g. `Buena`, `Moderada`; null when there is no index."},"window_start":{"anyOf":[{"type":"string"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["concentration","unit","index","category","window_start","window_end"]},{"type":"null"}],"description":"1-hour sulphur dioxide."},"co_8h":{"anyOf":[{"type":"object","properties":{"concentration":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"type":"string","enum":["ug/m3","ppb"]},"index":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Colombia's air-quality index (ICA) for the reading."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ICA category, e.g. `Buena`, `Moderada`; null when there is no index."},"window_start":{"anyOf":[{"type":"string"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["concentration","unit","index","category","window_start","window_end"]},{"type":"null"}],"description":"8-hour carbon monoxide."}},"required":["station_code","station","municipality","latitude","longitude","updated_at","distance_km","station_short","dominant_pollutant","dominant_index","pm25","pm10","o3_8h","no2_1h","so2_1h","co_8h"]}}},"required":["stations"]},"SiataGeoportalAirQualityResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiataGeoportalAirQualityData"}}},"SiataGeoportalCitizenSensorsData":{"type":"object","properties":{"sensors":{"type":"array","items":{"type":"object","properties":{"station_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"station":{"type":"string"},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"available":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the sensor is currently reporting."},"pm25_1h":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"PM2.5 over the last hour, in ug/m3."},"index_daily":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Daily PM2.5 air-quality index (ICA)."},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"data_recovery_24h_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"data_recovery_15d_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"distance_km":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Great-circle distance in km from the query point; null when no location filter was applied."}},"required":["station_code","station","municipality","latitude","longitude","updated_at","available","pm25_1h","index_daily","category","data_recovery_24h_pct","data_recovery_15d_pct","distance_km"]}}},"required":["sensors"]},"SiataGeoportalCitizenSensorsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiataGeoportalCitizenSensorsData"}}},"SiataGeoportalForecastData":{"type":"object","properties":{"zones":{"type":"array","items":{"type":"object","properties":{"municipality":{"type":"string"},"zone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sub-zone within the municipality, when the source forecasts it separately."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"days":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","description":"`YYYY-MM-DD`."},"temperature_max_c":{"anyOf":[{"type":"number"},{"type":"null"}]},"temperature_min_c":{"anyOf":[{"type":"number"},{"type":"null"}]},"rain":{"type":"object","properties":{"early_morning":{"anyOf":[{"type":"string"},{"type":"null"}]},"morning":{"anyOf":[{"type":"string"},{"type":"null"}]},"afternoon":{"anyOf":[{"type":"string"},{"type":"null"}]},"night":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["early_morning","morning","afternoon","night"],"description":"Rain likelihood per part of the day as the source words it: `BAJA`, `MEDIA` or `ALTA`."}},"required":["date","temperature_max_c","temperature_min_c","rain"]}}},"required":["municipality","zone","issued_at","days"]}}},"required":["zones"]},"SiataGeoportalForecastResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiataGeoportalForecastData"}}},"SiataGeoportalAlertsData":{"type":"object","properties":{"alerts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"title":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The notice as plain text."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_active":{"type":"boolean"},"audience":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who the source addresses the notice to, e.g. `citizen`."}},"required":["id","title","description","start_date","end_date","is_active","audience"]}}},"required":["alerts"]},"SiataGeoportalAlertsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiataGeoportalAlertsData"}}},"SiataGeoportalSeismicEventsData":{"type":"object","properties":{"stations":{"type":"array","items":{"type":"object","properties":{"station_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"station":{"type":"string"},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of the station's last update at the source."},"distance_km":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Great-circle distance in km from the query point; null when no location filter was applied."},"station_short":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"type":"string","enum":["accelerograph","seismograph"]},"sensor":{"anyOf":[{"type":"string"},{"type":"null"}]},"technology":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"object","properties":{"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"magnitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"epicenter":{"anyOf":[{"type":"string"},{"type":"null"}]},"depth_km":{"anyOf":[{"type":"number"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"peak_acceleration_cm_s2":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Peak ground acceleration recorded at the station, accelerographs only."},"peak_velocity_cm_s":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Peak ground velocity recorded at the station, seismographs only."},"intensity_mmi":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Instrumental intensity on the Modified Mercalli scale, e.g. `IV`."}},"required":["occurred_at","magnitude","epicenter","depth_km","latitude","longitude","peak_acceleration_cm_s2","peak_velocity_cm_s","intensity_mmi"]},"description":"The last events the station recorded, most recent first."}},"required":["station_code","station","municipality","latitude","longitude","updated_at","distance_km","station_short","kind","sensor","technology","events"]}}},"required":["stations"]},"SiataGeoportalSeismicEventsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiataGeoportalSeismicEventsData"}}},"SiataGeoportalCamerasData":{"type":"object","properties":{"cameras":{"type":"array","items":{"type":"object","properties":{"camera_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"camera":{"type":"string"},"short_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`nivel`, `cielo`, `deprimido` or `capa_limite`."},"type_label":{"anyOf":[{"type":"string"},{"type":"null"}]},"snapshot_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The latest still from the camera; refreshed by the source about every minute."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"distance_km":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Great-circle distance in km from the query point; null when no location filter was applied."}},"required":["camera_code","camera","short_name","type","type_label","snapshot_url","latitude","longitude","distance_km"]}}},"required":["cameras"]},"SiataGeoportalCamerasResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiataGeoportalCamerasData"}}},"LegalizeLawsSearchData":{"type":"object","properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"short_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"law_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"article_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"title_snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Match highlight from the search, when the query hit the title."}},"required":["id","title","short_title","law_type","publication_date","status","jurisdiction","article_count","title_snippet"]}}},"required":["query","total","page","per_page","count","results"]},"LegalizeLawsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/LegalizeLawsSearchData"}}},"LegalizeLawData":{"type":"object","properties":{"found":{"type":"boolean"},"law_id":{"type":"string"},"law":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"short_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"law_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"article_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_updated":{"anyOf":[{"type":"string"},{"type":"null"}]},"content_md":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The consolidated text as Markdown."}},"required":["id","title","short_title","law_type","publication_date","status","jurisdiction","article_count","department","source","last_updated","content_md"]},{"type":"null"}]}},"required":["found","law_id","law"]},"LegalizeLawResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/LegalizeLawData"}}},"AncpConceptosSearchData":{"type":"object","properties":{"query":{"type":"string","description":"Search terms used; empty string when no text filter was applied."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tema (descriptor) filter applied, or null."},"total":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string","description":"Official concepto number, e.g. \"C-1094 de 2026\"."},"id":{"type":"number","description":"Record id (usable as the detail-lookup identifier)."},"slug":{"type":"string","description":"Concepto slug, e.g. \"c-1094-de-2026\"."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"modified_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public URL of the concepto."},"subjects":{"type":"array","items":{"type":"string"},"description":"Temas (descriptores) the concepto is indexed under."},"subtopics":{"type":"array","items":{"type":"string"},"description":"Subtemas (restrictores) the concepto is indexed under."}},"required":["number","id","slug","publication_date","modified_date","url","subjects","subtopics"]}}},"required":["query","subject","total","total_pages","page","per_page","count","results"]},"AncpConceptosSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AncpConceptosSearchData"}}},"AncpConceptoData":{"type":"object","properties":{"found":{"type":"boolean"},"identifier":{"type":"string","description":"The id or slug that was looked up."},"concepto":{"anyOf":[{"type":"object","properties":{"number":{"type":"string","description":"Official concepto number, e.g. \"C-1094 de 2026\"."},"id":{"type":"number","description":"Record id (usable as the detail-lookup identifier)."},"slug":{"type":"string","description":"Concepto slug, e.g. \"c-1094-de-2026\"."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"modified_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public URL of the concepto."},"subjects":{"type":"array","items":{"type":"string"},"description":"Temas (descriptores) the concepto is indexed under."},"subtopics":{"type":"array","items":{"type":"string"},"description":"Subtemas (restrictores) the concepto is indexed under."},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Full doctrinal text as plain text, or null when the body is empty."}},"required":["number","id","slug","publication_date","modified_date","url","subjects","subtopics","text"]},{"type":"null"}]}},"required":["found","identifier","concepto"]},"AncpConceptoResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AncpConceptoData"}}},"CndjRulingsSearchData":{"type":"object","properties":{"query":{"type":"string","description":"Echo of the terms searched (general text or the joined advanced filters)."},"total":{"type":"number","description":"Total matches reported by the source."},"count":{"type":"number","description":"How many summaries this response carries (bounded by `limit`)."},"limit":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"numero_unico":{"type":"string","description":"23-digit numero unico de radicación. Part of the record key."},"numero_ficha":{"type":"number","description":"Ficha number within the radicación. Part of the record key."},"magistrado_ponente":{"anyOf":[{"type":"string"},{"type":"null"}]},"contenido_radicacion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the filing is about (subject line of the radicación)."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The decision / ruling text."},"fecha":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Providencia date (ISO `YYYY-MM-DD`); null when the source omits it."}},"required":["numero_unico","numero_ficha","magistrado_ponente","contenido_radicacion","decision","fecha"]}}},"required":["query","total","count","limit","results"]},"CndjRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CndjRulingsSearchData"}}},"CndjRulingData":{"type":"object","properties":{"found":{"type":"boolean"},"numero_unico":{"type":"string"},"numero_ficha":{"type":"number"},"ruling":{"anyOf":[{"type":"object","properties":{"numero_unico":{"type":"string"},"numero_ficha":{"type":"number"},"titulacion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Editorial title of the ficha."},"notas_relatorias":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Editorial notes."},"descriptores":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Topic descriptors."},"fuentes_normativas":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Normative sources cited."},"salvamento_aclaraciones":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Dissenting / clarifying opinions."},"pdf_url":{"type":"string","description":"Public URL of the full ruling PDF."},"texto":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Extracted full text of the PDF; null when it carries no text layer."}},"required":["numero_unico","numero_ficha","titulacion","notas_relatorias","descriptores","fuentes_normativas","salvamento_aclaraciones","pdf_url","texto"]},{"type":"null"}]}},"required":["found","numero_unico","numero_ficha","ruling"]},"CndjRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CndjRulingData"}}},"ContraloriaData":{"type":"object","properties":{"found":{"type":"boolean","description":"true when a certificate was issued (SIBOR always certifies valid lookups)."},"document_type":{"type":"string","enum":["CC","CE","TI","PA","PEP","PPT"]},"document_type_label":{"type":"string"},"document_number":{"type":"string"},"is_fiscal_responsible":{"type":"boolean","description":"true → \"SE ENCUENTRA REPORTADO COMO RESPONSABLE FISCAL\". false → \"NO SE ENCUENTRA REPORTADO COMO RESPONSABLE FISCAL\"."},"verification_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Código de Verificación (document + yymmdd + hhmmss), to re-verify the PDF."},"certified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Certificate timestamp (ISO, local Colombia time) from the code, or null."},"status":{"type":"string","description":"Verbatim CERTIFICA sentence from the certificate."},"message":{"type":"string","description":"Full plain-text certificate body, for audit/display."}},"required":["found","document_type","document_type_label","document_number","is_fiscal_responsible","verification_code","certified_at","status","message"]},"ContraloriaResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ContraloriaData"}}},"DianDoctrinaSearchData":{"type":"object","properties":{"query":{"type":"string"},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"string"},{"type":"null"}]},"page":{"type":"number"},"per_page":{"type":"number"},"total":{"type":"number","description":"Matches after the filters, across all pages."},"count":{"type":"number","description":"Results on this page."},"capped":{"type":"boolean","description":"True when the search hit its result cap and may be incomplete."},"results":{"type":"array","items":{"type":"object","properties":{"document_id":{"type":"string","description":"Pass it to the document lookup."},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer":{"anyOf":[{"type":"string"},{"type":"null"}]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The epígrafe, when the record carries one."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Match context from the search index, HTML stripped."},"url":{"type":"string"}},"required":["document_id","title","document_type","number","year","issuer","summary","excerpt","url"]}}},"required":["query","document_type","year","page","per_page","total","count","capped","results"]},"DianDoctrinaSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianDoctrinaSearchData"}}},"DianDoctrinaDocumentData":{"type":"object","properties":{"found":{"type":"boolean"},"document_id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string"},"offset":{"type":"number"},"total_length":{"type":"number"},"has_more":{"type":"boolean"},"next_offset":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["text","offset","total_length","has_more","next_offset"]},{"type":"null"}]},"url":{"type":"string"}},"required":["found","document_id","title","content","url"]},"DianDoctrinaDocumentResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianDoctrinaDocumentData"}}},"DianElectronicDocumentData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the document is registered."},"cufe":{"type":"string","description":"The queried CUFE, echoed back."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"series":{"anyOf":[{"type":"string"},{"type":"null"}]},"folio":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issue date (yyyy-mm-dd when parseable)."},"issuer":{"type":"object","properties":{"nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["nit","name"]},"recipient":{"type":"object","properties":{"nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["nit","name"]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"taxes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","value"]}},"legitimate_holder":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Current legitimate holder, when the document names one."},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Official DIAN PDF of the document; its password is the `document_number` used in the lookup. Null when not requested or not found."},"validations":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The validation the authority performed."},"result":{"type":"string","description":"Its verdict, in the authority's own words."},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The explanation the page attaches to the verdict."}},"required":["name","result","detail"]}},"events":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["description","date"]}}},"required":["found","cufe","document_type","series","folio","issue_date","issuer","recipient","total","taxes","legitimate_holder","pdf_url","validations","events"]},"DianElectronicDocumentResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianElectronicDocumentData"}}},"FuncionPublicaNormsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The register's own identifier for the norm, e.g. `34488`."},"title":{"type":"string","description":"How the norm is cited, e.g. \"Ley 1266 de 2008\"."},"document_type":{"type":"string","description":"The kind of instrument, as the register writes it: \"Ley\", \"Decreto\", \"Concepto\", \"Sentencia\", \"Acuerdo\", \"Circular Externa\", \"Acto Legislativo\" and twenty more."},"document_type_key":{"type":"string","description":"The kind in canonical form: lowercased, unaccented, spaces hyphenated (\"Circular Externa\" becomes \"circular-externa\"). Filter on this so a caller need not reproduce the register's capitalisation, which is not consistent."},"number":{"type":"string","description":"The norm's number as the register prints it: \"1266\", \"100-010\", \"2017-00230\"."},"number_key":{"type":"string","description":"The number in canonical form: lowercased, leading zeros dropped, anything but letters and digits collapsed to a hyphen (\"007\" becomes \"7\", \"100-010\" becomes \"100-10\")."},"year":{"type":"number","description":"The year in the norm's own designation (the 2008 of `Ley 1266 de 2008`). This is what the register files it under, and it is not always the year it was issued in."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who issued the norm, as the register names it: \"Congreso de la República\", \"Departamento Administrativo de la Función Pública\", \"Consejo de Estado\", or \"Nivel Nacional\" for a norm of the national executive."},"entity_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer in canonical form (\"congreso-de-la-republica\"). Filter on this by prefix, so \"ministerio-de-hacienda\" also matches the full ministry name."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's one-line description of what the norm does. Null on the many entries it publishes without one."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the norm was issued. Null when the register prints no date, which it marks with a placeholder rather than leaving blank."},"effective_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the norm entered into force, when the register states one."},"published_in":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the norm was officially published, as the register writes it, e.g. \"Diario Oficial 47.219 de diciembre 31 de 2008.\" Null for the many instruments that are not gazetted, such as conceptos."},"subjects":{"type":"array","items":{"type":"string"},"column":"string[]","description":"The subject headings the register files the norm under, for filtering. `topics` carries the same headings with their subheadings and editorial notes."},"topics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string","description":"The subject heading, e.g. \"HABEAS DATA\"."},"subtopic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subheading under it, e.g. \"Regulación y Reglamentación\", or null."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the register says the norm does on this subject, in its own editorial words. Null when it files the norm under the subject without a note."}},"required":["topic","subtopic","note"]},"description":"What the norm is about, as the register classifies it. Empty when it files no subject."},"amendments":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"The change in the register's own words, e.g. \"Adicionado por Ley 2157 de 2021\" on the norm that was changed, or \"Adiciona Ley 1266 de 2008\" on the one that changed it."},"norm_id":{"type":"string","description":"Identifier of the other norm, to look it up in turn. The register occasionally points at an id it no longer serves, so a lookup can come back `found: false`."}},"required":["description","norm_id"]},"description":"Later norms that added to, modified or repealed this one, as the register records them. Empty when it records none; this is the register's own editorial tracking, not a guarantee that the norm is in force."},"official_url":{"type":"string","description":"The register page for this norm."},"document_url":{"type":"string","description":"The register's PDF of the norm."}},"required":["id","title","document_type","document_type_key","number","number_key","year","entity","entity_key","summary","issued_at","effective_at","published_in","subjects","topics","amendments","official_url","document_url"]}}},"required":["as_of","query","document_type","year","number","entity","subject","issued_from","issued_to","total","page","per_page","total_pages","count","results"]},"FuncionPublicaNormsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FuncionPublicaNormsSearchData"}}},"FuncionPublicaNormData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"norm_id":{"type":"string"},"norm":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The register's own identifier for the norm, e.g. `34488`."},"title":{"type":"string","description":"How the norm is cited, e.g. \"Ley 1266 de 2008\"."},"document_type":{"type":"string","description":"The kind of instrument, as the register writes it: \"Ley\", \"Decreto\", \"Concepto\", \"Sentencia\", \"Acuerdo\", \"Circular Externa\", \"Acto Legislativo\" and twenty more."},"document_type_key":{"type":"string","description":"The kind in canonical form: lowercased, unaccented, spaces hyphenated (\"Circular Externa\" becomes \"circular-externa\"). Filter on this so a caller need not reproduce the register's capitalisation, which is not consistent."},"number":{"type":"string","description":"The norm's number as the register prints it: \"1266\", \"100-010\", \"2017-00230\"."},"number_key":{"type":"string","description":"The number in canonical form: lowercased, leading zeros dropped, anything but letters and digits collapsed to a hyphen (\"007\" becomes \"7\", \"100-010\" becomes \"100-10\")."},"year":{"type":"number","description":"The year in the norm's own designation (the 2008 of `Ley 1266 de 2008`). This is what the register files it under, and it is not always the year it was issued in."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who issued the norm, as the register names it: \"Congreso de la República\", \"Departamento Administrativo de la Función Pública\", \"Consejo de Estado\", or \"Nivel Nacional\" for a norm of the national executive."},"entity_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer in canonical form (\"congreso-de-la-republica\"). Filter on this by prefix, so \"ministerio-de-hacienda\" also matches the full ministry name."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's one-line description of what the norm does. Null on the many entries it publishes without one."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the norm was issued. Null when the register prints no date, which it marks with a placeholder rather than leaving blank."},"effective_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the norm entered into force, when the register states one."},"published_in":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the norm was officially published, as the register writes it, e.g. \"Diario Oficial 47.219 de diciembre 31 de 2008.\" Null for the many instruments that are not gazetted, such as conceptos."},"subjects":{"type":"array","items":{"type":"string"},"column":"string[]","description":"The subject headings the register files the norm under, for filtering. `topics` carries the same headings with their subheadings and editorial notes."},"topics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string","description":"The subject heading, e.g. \"HABEAS DATA\"."},"subtopic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subheading under it, e.g. \"Regulación y Reglamentación\", or null."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the register says the norm does on this subject, in its own editorial words. Null when it files the norm under the subject without a note."}},"required":["topic","subtopic","note"]},"description":"What the norm is about, as the register classifies it. Empty when it files no subject."},"amendments":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"The change in the register's own words, e.g. \"Adicionado por Ley 2157 de 2021\" on the norm that was changed, or \"Adiciona Ley 1266 de 2008\" on the one that changed it."},"norm_id":{"type":"string","description":"Identifier of the other norm, to look it up in turn. The register occasionally points at an id it no longer serves, so a lookup can come back `found: false`."}},"required":["description","norm_id"]},"description":"Later norms that added to, modified or repealed this one, as the register records them. Empty when it records none; this is the register's own editorial tracking, not a guarantee that the norm is in force."},"official_url":{"type":"string","description":"The register page for this norm."},"document_url":{"type":"string","description":"The register's PDF of the norm."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the norm's text."},"offset":{"type":"number","description":"First character of the range, which is where the reading actually started."},"total_length":{"type":"number","description":"Length of the whole text in characters, however much of it this response carries."},"has_more":{"type":"boolean","description":"Whether the text continues past this range."},"next_offset":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pass this back as `offset` to read the next range. Null at the end of the text."}},"required":["text","offset","total_length","has_more","next_offset"]},{"type":"null"}],"description":"A range of the norm's text, or null when the register published no body."}},"required":["id","title","document_type","document_type_key","number","number_key","year","entity","entity_key","summary","issued_at","effective_at","published_in","subjects","topics","amendments","official_url","document_url","content"]},{"type":"null"}]}},"required":["as_of","found","norm_id","norm"]},"FuncionPublicaNormResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FuncionPublicaNormData"}}},"ImprentaGacetaDocumentsData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"query":{"type":"string"},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string"},{"type":"null"}]},"bill_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"bill_year":{"anyOf":[{"type":"number"},{"type":"null"}]},"published_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The consecutivo the Imprenta keys the document on, e.g. `87176`. Unique across every gaceta and both chambers."},"gaceta_id":{"type":"string","description":"Id of the gaceta this document was published in."},"gaceta_number":{"type":"string","description":"Number of the gaceta this document was published in."},"chamber":{"type":"string","enum":["camara","senado"],"description":"The chamber whose run the gaceta belongs to: `senado` or `camara`."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the gaceta carrying this document was published."},"title":{"type":"string","description":"How the document is cited, e.g. \"Informe de Ponencia para Primer Debate al Proyecto de Ley 318 de 2009 Senado\" or \"Acta de Plenaria 22 del 16 de Octubre de 2013 Senado\"."},"summary":{"type":"string","description":"The epígrafe the Imprenta prints under the title — for a bill, the \"por la cual se...\" clause. Empty when the document has none."},"kind":{"type":"string","enum":["proyecto","ponencia","acta","texto","conciliacion","objecion","concepto","ley","otro"],"description":"What the title says the document is: `proyecto` (a bill as filed), `ponencia` (a committee report on one), `acta` (the minutes of a sitting), `texto` (an approved or definitive text), `conciliacion`, `objecion` (a presidential objection), `concepto`, `ley` (a law as enacted), or `otro`. Read off the title, because the Imprenta's own label is blank after 2020."},"bill_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the proyecto de ley or acto legislativo the document is about, when the title names one. Null for actas and anything not tied to a bill."},"bill_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Year of the bill the document is about, when the title names one."},"bill_chamber":{"anyOf":[{"type":"string","enum":["camara","senado"]},{"type":"null"}],"description":"The chamber the bill was filed in, when the title names it. A bill keeps its filing chamber's number as it moves, so this is not always the chamber that published the gaceta."},"official_url":{"type":"string","description":"The Imprenta's page for this document, inside its gaceta."}},"required":["id","gaceta_id","gaceta_number","chamber","published_at","title","summary","kind","bill_number","bill_year","bill_chamber","official_url"]}}},"required":["as_of","total","page","per_page","total_pages","count","query","chamber","kind","bill_number","bill_year","published_from","published_to","results"]},"ImprentaGacetaDocumentsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ImprentaGacetaDocumentsData"}}},"ImprentaGacetaDocumentData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"document_id":{"type":"string"},"document":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The consecutivo the Imprenta keys the document on, e.g. `87176`. Unique across every gaceta and both chambers."},"gaceta_id":{"type":"string","description":"Id of the gaceta this document was published in."},"gaceta_number":{"type":"string","description":"Number of the gaceta this document was published in."},"chamber":{"type":"string","enum":["camara","senado"],"description":"The chamber whose run the gaceta belongs to: `senado` or `camara`."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the gaceta carrying this document was published."},"title":{"type":"string","description":"How the document is cited, e.g. \"Informe de Ponencia para Primer Debate al Proyecto de Ley 318 de 2009 Senado\" or \"Acta de Plenaria 22 del 16 de Octubre de 2013 Senado\"."},"summary":{"type":"string","description":"The epígrafe the Imprenta prints under the title — for a bill, the \"por la cual se...\" clause. Empty when the document has none."},"kind":{"type":"string","enum":["proyecto","ponencia","acta","texto","conciliacion","objecion","concepto","ley","otro"],"description":"What the title says the document is: `proyecto` (a bill as filed), `ponencia` (a committee report on one), `acta` (the minutes of a sitting), `texto` (an approved or definitive text), `conciliacion`, `objecion` (a presidential objection), `concepto`, `ley` (a law as enacted), or `otro`. Read off the title, because the Imprenta's own label is blank after 2020."},"bill_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the proyecto de ley or acto legislativo the document is about, when the title names one. Null for actas and anything not tied to a bill."},"bill_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Year of the bill the document is about, when the title names one."},"bill_chamber":{"anyOf":[{"type":"string","enum":["camara","senado"]},{"type":"null"}],"description":"The chamber the bill was filed in, when the title names it. A bill keeps its filing chamber's number as it moves, so this is not always the chamber that published the gaceta."},"text":{"type":"string","description":"The document's full text, as the Imprenta publishes it. This is the document itself, not a summary or an extract."},"official_url":{"type":"string","description":"The Imprenta's page for this document, inside its gaceta."}},"required":["id","gaceta_id","gaceta_number","chamber","published_at","title","summary","kind","bill_number","bill_year","bill_chamber","text","official_url"]},{"type":"null"}]}},"required":["as_of","found","document_id","document"]},"ImprentaGacetaDocumentResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ImprentaGacetaDocumentData"}}},"ImprentaGacetasData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"query":{"type":"string"},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier: chamber, the date as the Imprenta prints it, and the number, e.g. `camara:28-08-2026:1161`. Built from the three values the Imprenta itself keys a gaceta on, so the handful of issues carrying an impossible date still have an id."},"number":{"type":"string","description":"The number as the Imprenta prints it, leading zeros included: \"1161\", \"02\", \"010\". Numbering restarts each year and each chamber keeps its own run."},"number_key":{"type":"string","description":"The same number with leading zeros dropped (\"02\" becomes \"2\"). Filter on this to match a gaceta whether the caller writes the zeros or not."},"chamber":{"type":"string","enum":["camara","senado"],"description":"`senado` (Senado de la República) or `camara` (Cámara de Representantes). Each chamber publishes its own numbered run of the shared gazette."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the gaceta was published. Null on the nine issues whose printed year is impossible (`0009`, `0200`, `0209` and the like) — typos in the source that this connector refuses to guess at."},"printed_date":{"type":"string","description":"The date exactly as the Imprenta prints it (`dd/MM/yyyy`), including the impossible ones. Kept because it is part of the gaceta's upstream identity."},"legacy_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Imprenta labelled the issue's main document (\"Acta de Comisión\", \"Proyecto de Ley\"). Null on about 13,100 of the issues: the practice was abandoned around 2020. Use the documents' own titles to classify, not this."},"official_url":{"type":"string","description":"The Imprenta's page for this gaceta, which serves the issue's PDF."}},"required":["id","number","number_key","chamber","published_at","printed_date","legacy_label","official_url"]}}},"required":["as_of","total","page","per_page","total_pages","count","query","chamber","number","published_from","published_to","results"]},"ImprentaGacetasResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ImprentaGacetasData"}}},"ImprentaDiariosData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"edition":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The issue number without its thousands separator, e.g. `53609`. The Imprenta prints the separator on recent issues (`53.609`) and not on older ones (`40254`)."},"number":{"type":"string","description":"The issue number as the Imprenta prints it, e.g. \"53.609\" or \"40254\"."},"number_key":{"type":"string","description":"The same number with the thousands separator dropped (\"53.609\" becomes \"53609\"). Filter on this to match an issue whichever way the caller writes it."},"edition":{"type":"string","enum":["ordinaria","extraordinaria","especial","oficio_tributario","otra"],"description":"`ordinaria` (the daily edition), `extraordinaria`, `especial`, `oficio_tributario`, or `otra`. Almost every issue is ordinaria."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the issue was published."},"official_url":{"type":"string","description":"The Diario Oficial search, where the issue can be opened by its number."}},"required":["id","number","number_key","edition","published_at","official_url"]}}},"required":["as_of","total","page","per_page","total_pages","count","number","edition","published_from","published_to","results"]},"ImprentaDiariosResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ImprentaDiariosData"}}},"ProcuraduriaData":{"type":"object","properties":{"found":{"type":"boolean","description":"false → the document isn't registered in SIRI; other fields then empty."},"document_type":{"type":"string","enum":["CC","CE","NIT","PEP","PPT"]},"document_type_label":{"type":"string"},"document_number":{"type":"string"},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered name, null when not found or omitted."},"has_records":{"type":"boolean","description":"true → the certificate lists one or more antecedente sections (see `records`). false → \"El ciudadano no presenta antecedentes\", or a document-state notice (e.g. cédula cancelled) where no antecedentes are reported; read `status` for that case."},"status":{"type":"string","description":"Verbatim verdict, the sections present, or a document-state notice."},"message":{"type":"string","description":"Full plain-text result message, for audit/display."},"records":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","description":"Section title shown on the certificate."},"siri":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"Registro SIRI No.\" for the section, or null when it has none."},"tables":{"type":"array","items":{"type":"object","properties":{"heading":{"type":"string","description":"Heading above the table (\"Sanciones\", \"Delitos\", …)."},"columns":{"type":"array","items":{"type":"string"},"description":"Header cells, left to right."},"rows":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"Data rows; each row's cells align with `columns`."}},"required":["heading","columns","rows"]},"description":"Tables under the section, in document order."}},"required":["category","siri","tables"]},"description":"Structured antecedente sections, reproducing the certificate. Empty when the citizen has no records."},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consultation timestamp the portal prints, or null if absent."}},"required":["found","document_type","document_type_label","document_number","full_name","has_records","status","message","records","checked_at"]},"ProcuraduriaResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ProcuraduriaData"}}},"SamaiProcessesData":{"type":"object","properties":{"search_type":{"type":"string","enum":["radicado","clase","parte"],"description":"The search field used."},"criterio":{"type":"string","description":"The value searched for."},"corporacion":{"type":"string","description":"Corporación code the search was scoped to."},"total":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"radicado":{"type":"string","description":"23-digit case number (radicado)."},"corporacion":{"type":"string","description":"Corporación (despacho) code the process belongs to."},"ponente":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reporting magistrate (magistrado ponente)."},"clase":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Process class / type (e.g. `Nulidad y restablecimiento del derecho`)."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filing date, ISO `YYYY-MM-DD`; null when unparseable."},"is_current":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the process is still active."},"internal_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Internal reference number the corporación assigns."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Subject / matter summary."},"plaintiff":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Plaintiff party name(s)."},"defendant":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Defendant party name(s)."},"is_private":{"type":"boolean","description":"Reserved / restricted process — party detail withheld at the source."},"guid":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Opaque detail key (radicado + corporación code)."},"official_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Official public detail URL; null when not provided."}},"required":["radicado","corporacion","ponente","clase","filing_date","is_current","internal_number","subject","plaintiff","defendant","is_private","guid","official_url"]}}},"required":["search_type","criterio","corporacion","total","total_pages","page","per_page","count","results"]},"SamaiProcessesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SamaiProcessesData"}}},"SamaiCorporacionesData":{"type":"object","properties":{"count":{"type":"number"},"corporaciones":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["code","name"],"description":"Corporación (despacho) code, e.g. `1100103` = Consejo de Estado."}}},"required":["count","corporaciones"]},"SamaiCorporacionesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SamaiCorporacionesData"}}},"SamaiSeccionesData":{"type":"object","properties":{"corporacion":{"type":"string"},"count":{"type":"number"},"secciones":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["code","name"]}}},"required":["corporacion","count","secciones"]},"SamaiSeccionesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SamaiSeccionesData"}}},"SamaiRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"reporting_judge":{"anyOf":[{"type":"string"},{"type":"null"}]},"plaintiff":{"anyOf":[{"type":"string"},{"type":"null"}]},"defendant":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's identifier: the 64-character hexadecimal certificate of its document, as the court prints it. One case (`registration_number`) groups several rulings, each with its own `id`."},"registration_number":{"type":"string","description":"The 23-digit case number (radicado) the ruling belongs to."},"internal_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's internal number at the Consejo de Estado. Null when it has none."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The deciding chamber as the court names it, e.g. \"Sección Tercera (Subsección B)\", \"Sala de Consulta y Servicio Civil\"."},"chamber_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber in canonical form (lowercased, unaccented, hyphenated: \"seccion-tercera-subseccion-b\"), which is what the `chamber` filter matches from the start."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of ruling as the court names it, e.g. \"Sentencia\", \"Auto interlocutorio\", \"Salvamento voto\", \"Aclaración voto\"."},"type_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of ruling in canonical form (\"auto-interlocutorio\"), which is what the `type` filter matches from the start."},"proceeding_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The class of proceeding (medio de control), as the court records it, e.g. \"LEY 1437 NULIDAD Y RESTABLECIMIENTO DEL DERECHO\"."},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the ruling does in the case, e.g. \"Auto que admite demanda\", \"Sentencia\"."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the court records for the ruling: the date a sentencia or auto is handed down, which its document opens with; for an aclaración or salvamento de voto, the date the court recorded the vote."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the case entered the Consejo de Estado. Null when the court records none."},"year":{"type":"number","description":"The year of `ruling_date`."},"reporting_judges":{"type":"array","items":{"type":"string"},"description":"The consejero or consejera ponente, as the court names them."},"reporting_judge_keys":{"type":"array","items":{"type":"string"},"description":"The same names in canonical form (lowercased, unaccented, hyphenated: \"alberto-montana-plata\"), which is what the `reporting_judge` filter matches."},"plaintiff":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The plaintiff (actor) as the court lists it. Null when it lists none."},"plaintiff_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The plaintiff in canonical form, cut to its first 200 characters, which is what the `plaintiff` filter matches from the start."},"defendant":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The defendant (demandado) as the court lists it. Null when it lists none."},"defendant_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The defendant in canonical form, cut to its first 200 characters, which is what the `defendant` filter matches from the start."},"descriptors":{"type":"array","items":{"type":"string"},"description":"Every thesaurus descriptor the relatoría recorded for the ruling, across its headnotes, without repeats."},"legal_problem":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal problem the ruling resolves; with several headnotes, each one in order, separated by a blank line."},"legal_problem_answer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The answer to each legal problem, \"Si\" or \"No\", in the same order and separated the same way. `headnotes[]` pairs each problem with its answer."},"thesis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's thesis or extract of the ruling; with several headnotes, each one in order, separated by a blank line."},"formal_sources":{"type":"array","items":{"type":"string"},"description":"Every norm the headnotes rest on, without repeats."},"relatoria_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's notes on related rulings and precedent; with several headnotes, each one in order, separated by a blank line."},"headnotes":{"type":"array","items":{"type":"object","properties":{"descriptors":{"type":"array","items":{"type":"string"},"description":"The thesaurus descriptors of this headnote, in the order the relatoría chains them."},"legal_problem":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal problem this headnote poses. Null when it poses none."},"legal_problem_answer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's answer to the legal problem, as it prints it: \"Si\" or \"No\". Null when there is none."},"thesis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The thesis or extract of the ruling this headnote records."},"formal_sources":{"type":"array","items":{"type":"string"},"description":"The norms the headnote rests on, one per entry, e.g. \"LEY 1437 DE 2011 - ARTÍCULO 188\"."},"challenged_norms":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The challenged norms, as the relatoría records them, when the proceeding attacks one."},"relatoria_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's note: related rulings and precedent it points to."}},"required":["descriptors","legal_problem","legal_problem_answer","thesis","formal_sources","challenged_norms","relatoria_note"]},"description":"The relatoría's headnotes (titulación), one per legal problem, in order."},"text_status":{"type":"string","enum":["extracted","no_text_layer","unavailable"],"description":"`extracted` when `text` holds the document's text, `no_text_layer` when the document is a scan without one, `unavailable` when the document could not be read yet."},"document_format":{"anyOf":[{"type":"string","enum":["pdf","docx","doc"]},{"type":"null"}],"description":"The format of the ruling's document: `pdf`, or `docx` or `doc` (Word) for some of the oldest rulings."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ruling's document (PDF, or Word for some of the oldest rulings), always available at this address. Null only while `text_status` is `unavailable`."},"official_url":{"type":"string","description":"The case's page on the Consejo de Estado's own site (SAMAI), where the court publishes its record and documents."}},"required":["id","registration_number","internal_number","chamber","chamber_key","type","type_key","proceeding_class","action","ruling_date","filing_date","year","reporting_judges","reporting_judge_keys","plaintiff","plaintiff_key","defendant","defendant_key","descriptors","legal_problem","legal_problem_answer","thesis","formal_sources","relatoria_note","headnotes","text_status","document_format","document_url","official_url"]}}},"required":["as_of","query","chamber","type","year","registration_number","reporting_judge","plaintiff","defendant","from_date","to_date","total","page","per_page","total_pages","count","results"]},"SamaiRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SamaiRulingsSearchData"}}},"SamaiRulingData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"ruling_id":{"type":"string"},"ruling":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The ruling's identifier: the 64-character hexadecimal certificate of its document, as the court prints it. One case (`registration_number`) groups several rulings, each with its own `id`."},"registration_number":{"type":"string","description":"The 23-digit case number (radicado) the ruling belongs to."},"internal_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's internal number at the Consejo de Estado. Null when it has none."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The deciding chamber as the court names it, e.g. \"Sección Tercera (Subsección B)\", \"Sala de Consulta y Servicio Civil\"."},"chamber_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber in canonical form (lowercased, unaccented, hyphenated: \"seccion-tercera-subseccion-b\"), which is what the `chamber` filter matches from the start."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of ruling as the court names it, e.g. \"Sentencia\", \"Auto interlocutorio\", \"Salvamento voto\", \"Aclaración voto\"."},"type_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of ruling in canonical form (\"auto-interlocutorio\"), which is what the `type` filter matches from the start."},"proceeding_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The class of proceeding (medio de control), as the court records it, e.g. \"LEY 1437 NULIDAD Y RESTABLECIMIENTO DEL DERECHO\"."},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the ruling does in the case, e.g. \"Auto que admite demanda\", \"Sentencia\"."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the court records for the ruling: the date a sentencia or auto is handed down, which its document opens with; for an aclaración or salvamento de voto, the date the court recorded the vote."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the case entered the Consejo de Estado. Null when the court records none."},"year":{"type":"number","description":"The year of `ruling_date`."},"reporting_judges":{"type":"array","items":{"type":"string"},"description":"The consejero or consejera ponente, as the court names them."},"reporting_judge_keys":{"type":"array","items":{"type":"string"},"description":"The same names in canonical form (lowercased, unaccented, hyphenated: \"alberto-montana-plata\"), which is what the `reporting_judge` filter matches."},"plaintiff":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The plaintiff (actor) as the court lists it. Null when it lists none."},"plaintiff_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The plaintiff in canonical form, cut to its first 200 characters, which is what the `plaintiff` filter matches from the start."},"defendant":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The defendant (demandado) as the court lists it. Null when it lists none."},"defendant_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The defendant in canonical form, cut to its first 200 characters, which is what the `defendant` filter matches from the start."},"descriptors":{"type":"array","items":{"type":"string"},"description":"Every thesaurus descriptor the relatoría recorded for the ruling, across its headnotes, without repeats."},"legal_problem":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal problem the ruling resolves; with several headnotes, each one in order, separated by a blank line."},"legal_problem_answer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The answer to each legal problem, \"Si\" or \"No\", in the same order and separated the same way. `headnotes[]` pairs each problem with its answer."},"thesis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's thesis or extract of the ruling; with several headnotes, each one in order, separated by a blank line."},"formal_sources":{"type":"array","items":{"type":"string"},"description":"Every norm the headnotes rest on, without repeats."},"relatoria_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's notes on related rulings and precedent; with several headnotes, each one in order, separated by a blank line."},"headnotes":{"type":"array","items":{"type":"object","properties":{"descriptors":{"type":"array","items":{"type":"string"},"description":"The thesaurus descriptors of this headnote, in the order the relatoría chains them."},"legal_problem":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal problem this headnote poses. Null when it poses none."},"legal_problem_answer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's answer to the legal problem, as it prints it: \"Si\" or \"No\". Null when there is none."},"thesis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The thesis or extract of the ruling this headnote records."},"formal_sources":{"type":"array","items":{"type":"string"},"description":"The norms the headnote rests on, one per entry, e.g. \"LEY 1437 DE 2011 - ARTÍCULO 188\"."},"challenged_norms":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The challenged norms, as the relatoría records them, when the proceeding attacks one."},"relatoria_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's note: related rulings and precedent it points to."}},"required":["descriptors","legal_problem","legal_problem_answer","thesis","formal_sources","challenged_norms","relatoria_note"]},"description":"The relatoría's headnotes (titulación), one per legal problem, in order."},"text_status":{"type":"string","enum":["extracted","no_text_layer","unavailable"],"description":"`extracted` when `text` holds the document's text, `no_text_layer` when the document is a scan without one, `unavailable` when the document could not be read yet."},"document_format":{"anyOf":[{"type":"string","enum":["pdf","docx","doc"]},{"type":"null"}],"description":"The format of the ruling's document: `pdf`, or `docx` or `doc` (Word) for some of the oldest rulings."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ruling's document (PDF, or Word for some of the oldest rulings), always available at this address. Null only while `text_status` is `unavailable`."},"official_url":{"type":"string","description":"The case's page on the Consejo de Estado's own site (SAMAI), where the court publishes its record and documents."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the ruling's text."},"offset":{"type":"number","description":"First character of the range, which is where the reading actually started."},"total_length":{"type":"number","description":"Length of the whole text in characters, however much of it this response carries."},"has_more":{"type":"boolean","description":"Whether the text continues past this range."},"next_offset":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pass this back as `offset` to read the next range. Null at the end of the text."}},"required":["text","offset","total_length","has_more","next_offset"]},{"type":"null"}],"description":"A range of the ruling's text, or null when there is none (see `text_status`)."}},"required":["id","registration_number","internal_number","chamber","chamber_key","type","type_key","proceeding_class","action","ruling_date","filing_date","year","reporting_judges","reporting_judge_keys","plaintiff","plaintiff_key","defendant","defendant_key","descriptors","legal_problem","legal_problem_answer","thesis","formal_sources","relatoria_note","headnotes","text_status","document_format","document_url","official_url","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"SamaiRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SamaiRulingData"}}},"SecopProcessData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether a process matched the noticeUID. When false, `process` is null."},"notice_uid":{"type":"string"},"process":{"anyOf":[{"type":"object","properties":{"notice_uid":{"anyOf":[{"type":"string"},{"type":"null"}]},"process_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Process id (CO1.REQ.*)."},"portfolio_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Portfolio id (CO1.BDOS.*); the join key to the awarded contracts."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_order":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_department":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_city":{"anyOf":[{"type":"string"},{"type":"null"}]},"procurement_unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"procurement_unit_city":{"anyOf":[{"type":"string"},{"type":"null"}]},"modality":{"anyOf":[{"type":"string"},{"type":"null"}]},"modality_justification":{"anyOf":[{"type":"string"},{"type":"null"}]},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"contract_subtype":{"anyOf":[{"type":"string"},{"type":"null"}]},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"additional_categories":{"anyOf":[{"type":"string"},{"type":"null"}]},"duration":{"anyOf":[{"type":"string"},{"type":"null"}]},"duration_unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"lots":{"anyOf":[{"type":"number"},{"type":"null"}]},"base_price":{"anyOf":[{"type":"number"},{"type":"null"}]},"phase":{"anyOf":[{"type":"string"},{"type":"null"}]},"status_summary":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"opening_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_published_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"bid_deadline":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Deadline for providers to submit offers (fecha de recepción de ofertas)."},"awarded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"From the process dataset; lags reality. Trust `contracts` for who won."},"awarded_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total adjudicated across every award of the process (a process can award many providers, e.g. framework agreements)."},"award_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Number of individual awards behind `awarded_value`; 0 when unawarded."},"award_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"invited_providers":{"anyOf":[{"type":"number"},{"type":"null"}]},"directly_invited_providers":{"anyOf":[{"type":"number"},{"type":"null"}]},"interested_providers":{"anyOf":[{"type":"number"},{"type":"null"}]},"responses":{"anyOf":[{"type":"number"},{"type":"null"}]},"external_responses":{"anyOf":[{"type":"number"},{"type":"null"}]},"offer_responses":{"anyOf":[{"type":"number"},{"type":"null"}]},"unique_responding_providers":{"anyOf":[{"type":"number"},{"type":"null"}]},"views":{"anyOf":[{"type":"number"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["notice_uid","process_id","portfolio_id","reference","name","description","entity","entity_nit","entity_code","entity_order","entity_department","entity_city","procurement_unit","procurement_unit_city","modality","modality_justification","contract_type","contract_subtype","unspsc_code","additional_categories","duration","duration_unit","lots","base_price","phase","status_summary","procedure_status","opening_status","published_date","last_published_date","bid_deadline","awarded","awarded_value","award_count","award_date","invited_providers","directly_invited_providers","interested_providers","responses","external_responses","offer_responses","unique_responding_providers","views","url"]},{"type":"null"}]},"awards":{"type":"array","items":{"type":"object","properties":{"provider":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_department":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_city":{"anyOf":[{"type":"string"},{"type":"null"}]},"awarded_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"This provider's slice of the process award."},"award_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["provider","provider_nit","provider_code","provider_department","provider_city","awarded_value","award_date"]},"description":"Per-provider award rows. `process.awarded_value`/`award_count` stay authoritative beyond the cap."},"awards_capped":{"type":"boolean"},"contract_count":{"type":"number"},"contracts_capped":{"type":"boolean","description":"True when the contracts join hit its cap and the list may be incomplete."},"contracts":{"type":"array","items":{"type":"object","properties":{"contract_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"centralized_entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"Centralizada\" / \"Descentralizada\" (not a boolean upstream)."},"provider":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_sme":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_group":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the provider is a plural structure (consortium / unión temporal)."},"legal_rep_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_rep_document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_rep_document":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the contract was procured (open tender, direct contracting, ...)."},"modality_justification":{"anyOf":[{"type":"string"},{"type":"null"}]},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"object":{"anyOf":[{"type":"string"},{"type":"null"}]},"delivery_conditions":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"invoiced_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending_execution_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending_payment_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"advance_payment_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"advance_payment_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"amortized_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending_amortization_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"sign_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"added_days":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"anyOf":[{"type":"string"},{"type":"null"}]},"can_be_extended":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"extension_notice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the entity gave notice of an extension (prórroga)."},"requires_liquidation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract carries a liquidation stage at its end."},"liquidation_start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"liquidation_end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_environmental_obligation":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"has_post_consumption_obligations":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"has_reversion":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"location":{"anyOf":[{"type":"string"},{"type":"null"}]},"supervisor":{"anyOf":[{"type":"string"},{"type":"null"}]},"expense_orderer":{"anyOf":[{"type":"string"},{"type":"null"}]},"funding_origin":{"anyOf":[{"type":"string"},{"type":"null"}]},"expense_destination":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"Inversión\" or \"Funcionamiento\"."},"sector":{"anyOf":[{"type":"string"},{"type":"null"}]},"branch":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["contract_id","reference","entity","entity_nit","centralized_entity","provider","provider_document","provider_document_type","provider_code","is_sme","is_group","legal_rep_name","legal_rep_document_type","legal_rep_document","status","contract_type","modality","modality_justification","unspsc_code","object","delivery_conditions","value","invoiced_value","paid_value","pending_execution_value","pending_payment_value","advance_payment_enabled","advance_payment_value","amortized_value","pending_amortization_value","sign_date","start_date","end_date","added_days","duration","can_be_extended","extension_notice_date","requires_liquidation","liquidation_start_date","liquidation_end_date","has_environmental_obligation","has_post_consumption_obligations","has_reversion","location","supervisor","expense_orderer","funding_origin","expense_destination","sector","branch","updated_date","url"]}}},"required":["found","notice_uid","process","awards","awards_capped","contract_count","contracts_capped","contracts"]},"SecopProcessResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopProcessData"}}},"SecopContractSearchData":{"type":"object","properties":{"document_number":{"type":"string","description":"Echoes the request's `document_number` (the provider cédula/NIT)."},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"count":{"type":"number","description":"Returned count for this page."},"capped":{"type":"boolean","description":"True when this page is full; later pages may exist."},"contracts":{"type":"array","items":{"type":"object","properties":{"contract_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"centralized_entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"Centralizada\" / \"Descentralizada\" (not a boolean upstream)."},"provider":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_sme":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_group":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the provider is a plural structure (consortium / unión temporal)."},"legal_rep_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_rep_document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_rep_document":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the contract was procured (open tender, direct contracting, ...)."},"modality_justification":{"anyOf":[{"type":"string"},{"type":"null"}]},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"object":{"anyOf":[{"type":"string"},{"type":"null"}]},"delivery_conditions":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"invoiced_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending_execution_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending_payment_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"advance_payment_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"advance_payment_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"amortized_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending_amortization_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"sign_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"added_days":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"anyOf":[{"type":"string"},{"type":"null"}]},"can_be_extended":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"extension_notice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the entity gave notice of an extension (prórroga)."},"requires_liquidation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract carries a liquidation stage at its end."},"liquidation_start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"liquidation_end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_environmental_obligation":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"has_post_consumption_obligations":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"has_reversion":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"location":{"anyOf":[{"type":"string"},{"type":"null"}]},"supervisor":{"anyOf":[{"type":"string"},{"type":"null"}]},"expense_orderer":{"anyOf":[{"type":"string"},{"type":"null"}]},"funding_origin":{"anyOf":[{"type":"string"},{"type":"null"}]},"expense_destination":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"Inversión\" or \"Funcionamiento\"."},"sector":{"anyOf":[{"type":"string"},{"type":"null"}]},"branch":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["contract_id","reference","entity","entity_nit","centralized_entity","provider","provider_document","provider_document_type","provider_code","is_sme","is_group","legal_rep_name","legal_rep_document_type","legal_rep_document","status","contract_type","modality","modality_justification","unspsc_code","object","delivery_conditions","value","invoiced_value","paid_value","pending_execution_value","pending_payment_value","advance_payment_enabled","advance_payment_value","amortized_value","pending_amortization_value","sign_date","start_date","end_date","added_days","duration","can_be_extended","extension_notice_date","requires_liquidation","liquidation_start_date","liquidation_end_date","has_environmental_obligation","has_post_consumption_obligations","has_reversion","location","supervisor","expense_orderer","funding_origin","expense_destination","sector","branch","updated_date","url"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["document_number","entity_nit","from_date","to_date","count","capped","contracts","pagination"]},"SecopContractSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopContractSearchData"},"deprecation":{"type":"object","description":"Present only while this endpoint is being retired. Mirrors the Deprecation, Sunset and Link response headers.","required":["since","sunset","successor","message"],"properties":{"since":{"type":"string","format":"date"},"sunset":{"type":"string","format":"date"},"successor":{"type":"string","description":"Path of the endpoint to use instead."},"message":{"type":"string"}}}}},"SecopProcessSearchData":{"type":"object","properties":{"document_number":{"type":"string","description":"Echoes the request's `document_number` (the entity NIT)."},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"count":{"type":"number","description":"Returned count for this page."},"capped":{"type":"boolean","description":"True when this page is full; later pages may exist."},"processes":{"type":"array","items":{"type":"object","properties":{"notice_uid":{"anyOf":[{"type":"string"},{"type":"null"}]},"process_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"modality":{"anyOf":[{"type":"string"},{"type":"null"}]},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"base_price":{"anyOf":[{"type":"number"},{"type":"null"}]},"phase":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["notice_uid","process_id","reference","name","entity","entity_nit","modality","contract_type","base_price","phase","procedure_status","published_date","url"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["document_number","from_date","to_date","count","capped","processes","pagination"]},"SecopProcessSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopProcessSearchData"},"deprecation":{"type":"object","description":"Present only while this endpoint is being retired. Mirrors the Deprecation, Sunset and Link response headers.","required":["since","sunset","successor","message"],"properties":{"since":{"type":"string","format":"date"},"sunset":{"type":"string","format":"date"},"successor":{"type":"string","description":"Path of the endpoint to use instead."},"message":{"type":"string"}}}}},"SecopContractLookupData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether a contract matched the id. When false, `contract` is null."},"contract_id":{"type":"string"},"contract":{"anyOf":[{"type":"object","properties":{"contract_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"centralized_entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"Centralizada\" / \"Descentralizada\" (not a boolean upstream)."},"provider":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_sme":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_group":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the provider is a plural structure (consortium / unión temporal)."},"legal_rep_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_rep_document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_rep_document":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the contract was procured (open tender, direct contracting, ...)."},"modality_justification":{"anyOf":[{"type":"string"},{"type":"null"}]},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"object":{"anyOf":[{"type":"string"},{"type":"null"}]},"delivery_conditions":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"invoiced_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending_execution_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending_payment_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"advance_payment_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"advance_payment_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"amortized_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending_amortization_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"sign_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"added_days":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"anyOf":[{"type":"string"},{"type":"null"}]},"can_be_extended":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"extension_notice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the entity gave notice of an extension (prórroga)."},"requires_liquidation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract carries a liquidation stage at its end."},"liquidation_start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"liquidation_end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_environmental_obligation":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"has_post_consumption_obligations":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"has_reversion":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"location":{"anyOf":[{"type":"string"},{"type":"null"}]},"supervisor":{"anyOf":[{"type":"string"},{"type":"null"}]},"expense_orderer":{"anyOf":[{"type":"string"},{"type":"null"}]},"funding_origin":{"anyOf":[{"type":"string"},{"type":"null"}]},"expense_destination":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"Inversión\" or \"Funcionamiento\"."},"sector":{"anyOf":[{"type":"string"},{"type":"null"}]},"branch":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["contract_id","reference","entity","entity_nit","centralized_entity","provider","provider_document","provider_document_type","provider_code","is_sme","is_group","legal_rep_name","legal_rep_document_type","legal_rep_document","status","contract_type","modality","modality_justification","unspsc_code","object","delivery_conditions","value","invoiced_value","paid_value","pending_execution_value","pending_payment_value","advance_payment_enabled","advance_payment_value","amortized_value","pending_amortization_value","sign_date","start_date","end_date","added_days","duration","can_be_extended","extension_notice_date","requires_liquidation","liquidation_start_date","liquidation_end_date","has_environmental_obligation","has_post_consumption_obligations","has_reversion","location","supervisor","expense_orderer","funding_origin","expense_destination","sector","branch","updated_date","url"]},{"type":"null"}]},"additions":{"type":"array","items":{"type":"object","properties":{"addition_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["addition_id","type","description","registered_date"]}},"additions_capped":{"type":"boolean"},"guarantees":{"type":"array","items":{"type":"object","properties":{"insurer":{"anyOf":[{"type":"string"},{"type":"null"}]},"policy_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"insured":{"anyOf":[{"type":"string"},{"type":"null"}]},"beneficiary":{"anyOf":[{"type":"string"},{"type":"null"}]},"policy_created_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"policy_sent_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"policy_end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"policy_side":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"policy_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"policy_subtype":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"created_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["insurer","policy_number","insured","beneficiary","policy_created_date","policy_sent_date","policy_end_date","policy_side","status","policy_type","policy_subtype","value","created_date"]}},"guarantees_capped":{"type":"boolean"},"execution_items":{"type":"array","items":{"type":"object","properties":{"execution_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"plan_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"expected_delivery_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expected_progress_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"actual_delivery_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"actual_progress_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"contract_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"item_reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"awarded_quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"planned_quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"received_quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending_quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"created_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["execution_type","plan_name","expected_delivery_date","expected_progress_percent","actual_delivery_date","actual_progress_percent","contract_status","item_reference","description","unit","awarded_quantity","planned_quantity","received_quantity","pending_quantity","created_date"]}},"execution_items_capped":{"type":"boolean"}},"required":["found","contract_id","contract","additions","additions_capped","guarantees","guarantees_capped","execution_items","execution_items_capped"]},"SecopContractLookupResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopContractLookupData"}}},"SecopSanctionSearchData":{"type":"object","properties":{"document_number":{"type":"string","description":"Echoes the request's `document_number` (the contractor cédula/NIT)."},"count":{"type":"number","description":"Returned count (capped, not the true total)."},"capped":{"type":"boolean","description":"True when the result cap was hit; results are then incomplete."},"sanctions":{"type":"array","items":{"type":"object","properties":{"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_level":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_order":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider":{"anyOf":[{"type":"string"},{"type":"null"}]},"contract_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"sanction_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"final_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the sanction became final (fecha de firmeza)."},"url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["entity","entity_nit","entity_level","entity_order","municipality","resolution_number","provider","contract_number","sanction_value","published_date","final_date","url"]}}},"required":["document_number","count","capped","sanctions"]},"SecopSanctionSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopSanctionSearchData"},"deprecation":{"type":"object","description":"Present only while this endpoint is being retired. Mirrors the Deprecation, Sunset and Link response headers.","required":["since","sunset","successor","message"],"properties":{"since":{"type":"string","format":"date"},"sunset":{"type":"string","format":"date"},"successor":{"type":"string","description":"Path of the endpoint to use instead."},"message":{"type":"string"}}}}},"SecopProcessesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data is: the moment this dataset was last brought up to date, as an ISO timestamp. Null before the first sync."},"total":{"type":"number","description":"Records matching the filters, regardless of the page size."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number","description":"Records returned on this page."},"query":{"type":"string"},"platform":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"modality":{"anyOf":[{"type":"string"},{"type":"null"}]},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"max_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"sort":{"type":"string"},"awarded":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier, `<platform>:<process id>` (e.g. `secop_ii:CO1.REQ.1234567`, `secop_i:20-11-10442331`)."},"platform":{"type":"string","enum":["secop_i","secop_ii"],"description":"Which system published the row: `secop_ii` (the transactional platform, 2015 onward) or `secop_i` (the publication register, 2004 onward)."},"process_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The process id as its own platform numbers it, without the platform prefix."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's own reference for the process (número del proceso)."},"notice_uid":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SECOP II noticeUID (`CO1.NTC.*`), the id the public portal addresses a process by. Null on SECOP I."},"portfolio_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SECOP II portfolio id (`CO1.BDOS.*`), the join key to the awarded contracts. Null on SECOP I."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the contracting entity."},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of the contracting entity, digits only, no verification digit."},"entity_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's internal SECOP code."},"entity_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nivel: `NACIONAL` or `TERRITORIAL`. Published by SECOP I; null on most SECOP II rows."},"entity_order":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Orden: `NACIONAL CENTRALIZADO`, `TERRITORIAL DEPARTAMENTAL`, and so on."},"entity_department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department the entity sits in."},"entity_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality the entity sits in."},"procurement_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unidad de contratación that ran the process (SECOP II)."},"procurement_unit_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City of the unidad de contratación (SECOP II)."},"sub_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sub unidad ejecutora, when the entity splits its budget (SECOP I)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nombre del procedimiento: the short title of the process."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the entity says it is buying (descripción del procedimiento / detalle del objeto a contratar)."},"object_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Objeto a contratar, SECOP I's own classification of the purchase."},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Main UNSPSC category code of the purchase."},"unspsc_additional":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Further UNSPSC categories, as the platform prints them."},"unspsc_segment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UNSPSC segment name (SECOP I `nombre grupo`)."},"unspsc_family":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UNSPSC family name (SECOP I)."},"unspsc_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UNSPSC class name (SECOP I)."},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Modalidad de contratación: licitación pública, contratación directa, mínima cuantía, and so on."},"modality_justification":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal ground the entity gave for the modality."},"modality_cause":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Causal for the other forms of direct contracting (SECOP I)."},"regime":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Régimen de contratación the process runs under (SECOP I)."},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tipo de contrato the process would produce (obra, prestación de servicios, suministro, ...)."},"contract_subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Subtipo de contrato (SECOP II)."},"base_price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Estimated value of the process in COP (precio base / cuantía del proceso)."},"awarded_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total adjudicated in COP, summed across every award of the process. A framework agreement awards many providers, so this is not one provider's slice."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Currency the amounts are stated in. COP unless the process says otherwise."},"phase":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fase of the procedure (SECOP II): planeación, selección, and so on."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado del procedimiento in the platform's own words (`Adjudicado`, `Celebrado`, `Convocado`, `Descartado`, ...)."},"status_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado resumen, the platform's rolled-up status (SECOP II)."},"opening_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado de apertura del proceso (SECOP II)."},"awarded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the process reached an award. On SECOP II this lags reality; the contracts dataset is authoritative for who actually won."},"award_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How many awards the process made. 0 when unawarded."},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the process was first published, `yyyy-mm-dd`."},"last_published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the process was last republished, `yyyy-mm-dd`. This is the freshest change signal the source offers."},"bid_deadline":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Deadline for providers to submit offers, `yyyy-mm-dd`."},"award_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the process was awarded, `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Calendar year of `published_date`, for cheap year filters and grouping."},"invited_providers":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Providers invited to the process."},"directly_invited_providers":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Providers invited directly."},"interested_providers":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Providers that declared interest."},"responses":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Responses received to the procedure."},"external_responses":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Responses submitted outside the platform."},"offer_responses":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Responses to offers counted on the procedure."},"unique_responding_providers":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Distinct providers that responded. With `invited_providers`, the plainest measure of how contested a process was."},"lots":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Number of lots the process was split into."},"views":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Times the procedure was viewed on the platform."},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the awarded provider, when the process row names one."},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the awarded provider (NIT for a company, cédula for a natural person)."},"provider_department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department of the awarded provider."},"provider_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality of the awarded provider."},"execution_locations":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipalities the contract is to be executed in (SECOP I)."},"duration":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stated duration of the resulting contract."},"duration_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unit `duration` is counted in (días, meses, ...)."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public page for the process on its own platform."}},"required":["id","platform","process_id","reference","notice_uid","portfolio_id","entity","entity_nit","entity_code","entity_level","entity_order","entity_department","entity_city","procurement_unit","procurement_unit_city","sub_unit","name","description","object_type","unspsc_code","unspsc_additional","unspsc_segment","unspsc_family","unspsc_class","modality","modality_justification","modality_cause","regime","contract_type","contract_subtype","base_price","awarded_value","currency","phase","status","status_summary","opening_status","awarded","award_count","published_date","last_published_date","bid_deadline","award_date","year","invited_providers","directly_invited_providers","interested_providers","responses","external_responses","offer_responses","unique_responding_providers","lots","views","provider","provider_document","provider_department","provider_city","execution_locations","duration","duration_unit","url"]}}},"required":["as_of","total","page","per_page","total_pages","count","query","platform","entity_nit","department","modality","contract_type","status","unspsc_code","year","from_date","to_date","min_value","max_value","sort","awarded","results"]},"SecopProcessesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopProcessesSearchData"}}},"SecopContractsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data is: the moment this dataset was last brought up to date, as an ISO timestamp. Null before the first sync."},"total":{"type":"number","description":"Records matching the filters, regardless of the page size."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number","description":"Records returned on this page."},"query":{"type":"string"},"platform":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"modality":{"anyOf":[{"type":"string"},{"type":"null"}]},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"max_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"sort":{"type":"string"},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}]},"sector":{"anyOf":[{"type":"string"},{"type":"null"}]},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier, `<platform>:<contract id>` (e.g. `secop_ii:CO1.PCCNTR.4168447`)."},"platform":{"type":"string","enum":["secop_i","secop_ii"],"description":"Which system published the row: `secop_ii` (the transactional platform, 2015 onward) or `secop_i` (the publication register, 2004 onward)."},"contract_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contract id as its own platform numbers it."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's own reference for the contract."},"process_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Id of the process the contract came out of, prefixed like `id`, so it joins the processes dataset."},"portfolio_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SECOP II proceso de compra (`CO1.BDOS.*`) the contract belongs to."},"award_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Id of the adjudicación the contract implements (SECOP I)."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the contracting entity."},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of the contracting entity, digits only, no verification digit."},"entity_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's internal SECOP code."},"entity_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nivel: `NACIONAL` or `TERRITORIAL`."},"entity_order":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Orden of the entity within the state."},"entity_sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sector the entity belongs to (salud, educación, defensa, ...)."},"entity_branch":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Rama of the state the entity belongs to."},"entity_centralized":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Centralizada` or `Descentralizada`; a label upstream, not a boolean."},"entity_department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department the entity sits in."},"entity_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality the entity sits in."},"sub_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sub unidad ejecutora (SECOP I)."},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name or razón social of the contractor."},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Contractor's document, digits only: a NIT for a company, a cédula when the contractor is a natural person. The one field to filter by to see everything a person or company has contracted with the state."},"provider_document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Kind of document `provider_document` is (NIT, cédula de ciudadanía, ...)."},"provider_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provider's internal SECOP code."},"provider_department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department of the contractor."},"provider_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality of the contractor."},"provider_is_group":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the contractor is a plural structure: a consorcio or a unión temporal."},"provider_is_sme":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the contractor is registered as a PyME / MiPyme."},"provider_size":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tamaño MiPyme as SECOP I states it (micro, pequeña, mediana)."},"legal_rep_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the contractor's legal representative."},"legal_rep_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the legal representative."},"legal_rep_document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Kind of document the legal representative holds."},"legal_rep_nationality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nationality of the legal representative."},"legal_rep_domicile":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Domicile of the legal representative."},"legal_rep_gender":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Gender of the legal representative, as the platform records it."},"object":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Objeto del contrato: what the contract is for, at signature."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Descripción del proceso the contract came out of."},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Main UNSPSC category code."},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tipo de contrato (obra, prestación de servicios, suministro, consultoría, ...)."},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Modalidad the contract was procured under."},"modality_justification":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal ground given for the modality."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado del contrato in the platform's own words."},"delivery_conditions":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Condiciones de entrega."},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Localización recorded for the contract."},"execution_address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address the contract is executed at (SECOP II)."},"execution_locations":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipalities of execution (SECOP I)."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value of the contract in COP at signature, before additions."},"additions_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total added to the contract afterwards, in COP."},"value_with_additions":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value including every addition, in COP. The number to rank spending by."},"invoiced_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Invoiced to date, in COP (SECOP II)."},"paid_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Paid to date, in COP (SECOP II)."},"pending_payment_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Still to be paid, in COP (SECOP II)."},"pending_execution_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Still to be executed, in COP (SECOP II)."},"advance_payment_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract allows an advance payment."},"advance_payment_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Advance payment agreed, in COP."},"amortized_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Advance amortized to date, in COP."},"pending_amortization_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Advance still to be amortized, in COP."},"cdp_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Saldo CDP (certificado de disponibilidad presupuestal), in COP."},"vigencia_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Saldo vigencia, in COP."},"funding_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Origen de los recursos, as the platform labels it."},"funding_national_budget":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded by the Presupuesto General de la Nación, in COP."},"funding_participations":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded by the Sistema General de Participaciones, in COP."},"funding_royalties":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded by the Sistema General de Regalías, in COP."},"funding_own_territorial":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded by a mayor's or governor's own resources, in COP."},"funding_credit":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded by credit, in COP."},"funding_other":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded from other sources (in kind, private, cooperation), in COP."},"expense_destination":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Destino del gasto: `Inversión` or `Funcionamiento`."},"budget_position":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Posición del rubro presupuestal (SECOP I)."},"budget_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nombre del rubro presupuestal (SECOP I)."},"budget_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value charged to that rubro, in COP (SECOP I)."},"bpin_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"BPIN code of the investment project the contract belongs to."},"sign_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the contract was signed, `yyyy-mm-dd`."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When execution starts, `yyyy-mm-dd`."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When execution ends, `yyyy-mm-dd`."},"liquidation_start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start of the liquidation stage, `yyyy-mm-dd`."},"liquidation_end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End of the liquidation stage, `yyyy-mm-dd`."},"liquidation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fecha de liquidación, `yyyy-mm-dd` (SECOP I)."},"extension_notice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the entity gave notice of an extension."},"updated_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the source last touched the row, `yyyy-mm-dd`. Null on 42% of SECOP II contracts, so never treat it as complete."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Calendar year of `sign_date`."},"duration":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stated duration of the contract."},"duration_days":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Plazo de ejecución in days (SECOP I)."},"added_days":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Days added to the contract by its modifications."},"can_be_extended":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract may be extended."},"requires_liquidation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract carries a liquidation stage."},"has_environmental_obligation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract carries an environmental obligation."},"has_post_consumption_obligations":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether it carries post-consumption obligations."},"has_reversion":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether assets revert to the state at the end."},"is_post_conflict":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract is marked as post-conflict spending."},"peace_pillar":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pilar del Acuerdo de Paz the spending is attributed to."},"peace_point":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Punto del Acuerdo de Paz the spending is attributed to."},"standard_documents":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Documentos tipo / pliegos tipo applied to the process."},"standard_documents_sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sector of the pliegos tipo applied."},"supervisor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the contract's supervisor."},"supervisor_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the supervisor."},"expense_orderer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the ordenador del gasto."},"expense_orderer_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the ordenador del gasto."},"payment_orderer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the ordenador de pago."},"payment_orderer_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the ordenador de pago."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public page for the contract or its process."}},"required":["id","platform","contract_id","reference","process_id","portfolio_id","award_id","entity","entity_nit","entity_code","entity_level","entity_order","entity_sector","entity_branch","entity_centralized","entity_department","entity_city","sub_unit","provider","provider_document","provider_document_type","provider_code","provider_department","provider_city","provider_is_group","provider_is_sme","provider_size","legal_rep_name","legal_rep_document","legal_rep_document_type","legal_rep_nationality","legal_rep_domicile","legal_rep_gender","object","description","unspsc_code","contract_type","modality","modality_justification","status","delivery_conditions","location","execution_address","execution_locations","value","additions_value","value_with_additions","invoiced_value","paid_value","pending_payment_value","pending_execution_value","advance_payment_enabled","advance_payment_value","amortized_value","pending_amortization_value","cdp_balance","vigencia_balance","funding_origin","funding_national_budget","funding_participations","funding_royalties","funding_own_territorial","funding_credit","funding_other","expense_destination","budget_position","budget_name","budget_value","bpin_code","sign_date","start_date","end_date","liquidation_start_date","liquidation_end_date","liquidation_date","extension_notice_date","updated_date","year","duration","duration_days","added_days","can_be_extended","requires_liquidation","has_environmental_obligation","has_post_consumption_obligations","has_reversion","is_post_conflict","peace_pillar","peace_point","standard_documents","standard_documents_sector","supervisor","supervisor_document","expense_orderer","expense_orderer_document","payment_orderer","payment_orderer_document","url"]}}},"required":["as_of","total","page","per_page","total_pages","count","query","platform","entity_nit","department","modality","contract_type","status","unspsc_code","year","from_date","to_date","min_value","max_value","sort","provider_document","sector","results"]},"SecopContractsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopContractsSearchData"}}},"SecopModificationsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data is: the moment this dataset was last brought up to date, as an ISO timestamp. Null before the first sync."},"total":{"type":"number","description":"Records matching the filters, regardless of the page size."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number","description":"Records returned on this page."},"query":{"type":"string"},"contract_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"platform":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"sort":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier of the modification."},"platform":{"type":"string","enum":["secop_i","secop_ii"],"description":"Which system published the row: `secop_ii` (the transactional platform, 2015 onward) or `secop_i` (the publication register, 2004 onward)."},"contract_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Id of the contract that was modified, prefixed like the contracts dataset's `id`."},"contract_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's own reference for the contract."},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of the contracting entity."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the contracting entity."},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What kind of change this is, in the platform's own words (adición, prórroga, suspensión, ...)."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the modification says it does."},"added_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Money added by this modification, in COP."},"added_days":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Days added by this modification."},"registered_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the modification was registered, `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Calendar year of `registered_date`."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public page for the contract the modification belongs to."}},"required":["id","platform","contract_id","contract_reference","entity_nit","entity","kind","description","added_value","added_days","registered_date","year","url"]}}},"required":["as_of","total","page","per_page","total_pages","count","query","contract_id","platform","year","from_date","to_date","min_value","sort","results"]},"SecopModificationsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopModificationsSearchData"}}},"SecopSuppliersSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data is: the moment this dataset was last brought up to date, as an ISO timestamp. Null before the first sync."},"total":{"type":"number","description":"Records matching the filters, regardless of the page size."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number","description":"Records returned on this page."},"query":{"type":"string"},"document":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"active":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier, `secop_ii:<supplier code>`."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The supplier's own SECOP II code."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name or razón social of the supplier."},"document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or cédula of the supplier, digits only, no verification digit."},"is_entity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the account belongs to a state entity rather than a vendor."},"is_group":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the account is a consorcio or unión temporal."},"is_sme":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the supplier is registered as a PyME."},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the account is currently active."},"company_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tipo de empresa as the platform classifies it."},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Main UNSPSC category the supplier registered under."},"unspsc_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of that main category."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country of the supplier."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department of the supplier."},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality of the supplier."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered address."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered telephone."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered contact email."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered web site."},"legal_rep_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the legal representative."},"legal_rep_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the legal representative."},"legal_rep_document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Kind of document the legal representative holds."},"legal_rep_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Telephone of the legal representative."},"legal_rep_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Email of the legal representative."},"registered_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the account was created, `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Calendar year of `registered_date`."}},"required":["id","code","name","document","is_entity","is_group","is_sme","is_active","company_type","unspsc_code","unspsc_description","country","department","city","address","phone","email","website","legal_rep_name","legal_rep_document","legal_rep_document_type","legal_rep_phone","legal_rep_email","registered_date","year"]}}},"required":["as_of","total","page","per_page","total_pages","count","query","document","department","unspsc_code","active","results"]},"SecopSuppliersSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopSuppliersSearchData"}}},"SecopBiddersSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data is: the moment this dataset was last brought up to date, as an ISO timestamp. Null before the first sync."},"total":{"type":"number","description":"Records matching the filters, regardless of the page size."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number","description":"Records returned on this page."},"process_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"bidder_document":{"anyOf":[{"type":"string"},{"type":"null"}]},"platform":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier, `<platform>:<process id>:<bidder document>`."},"platform":{"type":"string","enum":["secop_i","secop_ii"],"description":"Which system published the row: `secop_ii` (the transactional platform, 2015 onward) or `secop_i` (the publication register, 2004 onward)."},"process_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Id of the process bid on, prefixed like the processes dataset's `id`."},"bidder":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name or razón social of the bidder."},"bidder_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the bidder, digits only."},"bidder_document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Kind of document the bidder holds."},"score":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Calificación the bid received, as the platform prints it."},"awarded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this bidder won."},"contract_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Contract number that followed, when this bidder won."},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the process was published, `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Calendar year of `published_date`."}},"required":["id","platform","process_id","bidder","bidder_document","bidder_document_type","score","awarded","contract_number","published_date","year"]}}},"required":["as_of","total","page","per_page","total_pages","count","process_id","bidder_document","platform","year","results"]},"SecopBiddersSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopBiddersSearchData"}}},"SecopSanctionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data is: the moment this dataset was last brought up to date, as an ISO timestamp. Null before the first sync."},"total":{"type":"number","description":"Records matching the filters, regardless of the page size."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number","description":"Records returned on this page."},"query":{"type":"string"},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier of the sanction."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Entity that imposed the sanction."},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of that entity, digits only."},"entity_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nivel of the entity."},"entity_order":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Orden of the entity."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality of the entity."},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the resolution that imposed the sanction."},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the sanctioned contractor."},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the sanctioned contractor, digits only."},"contract_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Contract the sanction was imposed under."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value of the sanction in COP."},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the sanction was published, `yyyy-mm-dd`."},"final_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the sanction became final (fecha de firmeza), `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Calendar year of `published_date`."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public page for the process the sanction belongs to."}},"required":["id","entity","entity_nit","entity_level","entity_order","municipality","resolution_number","provider","provider_document","contract_number","value","published_date","final_date","year","url"]}}},"required":["as_of","total","page","per_page","total_pages","count","query","provider_document","entity_nit","year","from_date","to_date","results"]},"SecopSanctionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopSanctionsSearchData"}}},"SecopPlansSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data is: the moment this dataset was last brought up to date, as an ISO timestamp. Null before the first sync."},"total":{"type":"number","description":"Records matching the filters, regardless of the page size."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number","description":"Records returned on this page."},"query":{"type":"string"},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier, `<platform>:<plan id>`."},"platform":{"type":"string","enum":["secop_i","secop_ii"],"description":"Which system published the row: `secop_ii` (the transactional platform, 2015 onward) or `secop_i` (the publication register, 2004 onward)."},"plan_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The plan's id as its own platform numbers it."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Year the plan covers."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the entity."},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of the entity, digits only."},"entity_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's internal SECOP code."},"mission":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Misión y visión the entity states in the plan."},"strategy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Perspectiva estratégica the entity states in the plan."},"total_budget":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total budget the plan announces, in COP."},"lesser_amount_threshold":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Menor cuantía threshold for the entity that year, in COP."},"minimum_amount_threshold":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mínima cuantía threshold for the entity that year, in COP."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado of the plan (SECOP II)."},"version":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Version of the plan (SECOP II republishes on every change)."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department of the entity."},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality of the entity."},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Contact named on the plan."},"contact_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Contact telephone."},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Contact email."},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the plan was published, `yyyy-mm-dd`."},"updated_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the plan was last modified, `yyyy-mm-dd`."}},"required":["id","platform","plan_id","year","entity","entity_nit","entity_code","mission","strategy","total_budget","lesser_amount_threshold","minimum_amount_threshold","status","version","department","city","contact_name","contact_phone","contact_email","published_date","updated_date"]}}},"required":["as_of","total","page","per_page","total_pages","count","query","department","year","results"]},"SecopPlansSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopPlansSearchData"}}},"SecopProfileData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data is: the moment these datasets were last brought up to date."},"document":{"type":"string","description":"The document as it was matched, digits only, no verification digit."},"found":{"type":"boolean","description":"Whether the corpus holds anything at all for this document. False means no contracts, awards, bids, sanctions or supplier account."},"supplier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier, `secop_ii:<supplier code>`."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The supplier's own SECOP II code."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name or razón social of the supplier."},"document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or cédula of the supplier, digits only, no verification digit."},"is_entity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the account belongs to a state entity rather than a vendor."},"is_group":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the account is a consorcio or unión temporal."},"is_sme":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the supplier is registered as a PyME."},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the account is currently active."},"company_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tipo de empresa as the platform classifies it."},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Main UNSPSC category the supplier registered under."},"unspsc_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of that main category."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country of the supplier."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department of the supplier."},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality of the supplier."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered address."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered telephone."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered contact email."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered web site."},"legal_rep_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the legal representative."},"legal_rep_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the legal representative."},"legal_rep_document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Kind of document the legal representative holds."},"legal_rep_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Telephone of the legal representative."},"legal_rep_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Email of the legal representative."},"registered_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the account was created, `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Calendar year of `registered_date`."}},"required":["id","code","name","document","is_entity","is_group","is_sme","is_active","company_type","unspsc_code","unspsc_description","country","department","city","address","phone","email","website","legal_rep_name","legal_rep_document","legal_rep_document_type","legal_rep_phone","legal_rep_email","registered_date","year"]},{"type":"null"}],"description":"The SECOP II supplier account, when the document has one. Null for a contractor that never registered, which is common on SECOP I."},"as_contractor":{"type":"object","properties":{"contracts":{"type":"number","description":"Exact number of contracts signed, across both platforms."},"contracts_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Summed value of `largest_contracts` only, in COP. Not a lifetime total; use `contracts` with the contracts search to page the rest."},"first_contract_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Signature date of the earliest contract found."},"last_contract_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Signature date of the most recent contract found."},"largest_contracts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string"},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"object":{"anyOf":[{"type":"string"},{"type":"null"}]},"value_with_additions":{"anyOf":[{"type":"number"},{"type":"null"}]},"sign_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","platform","entity","entity_nit","object","value_with_additions","sign_date","status"]},"description":"The largest contracts by value, newest first within equal values."},"awards":{"type":"number","description":"Exact number of awards won on SECOP II processes."},"largest_awards":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"process_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"awarded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","process_id","entity","value","awarded_at"]},"description":"The largest awards by value."},"bids":{"type":"number","description":"Exact number of processes this document is recorded as having bid on."},"sanctions":{"type":"number","description":"Exact number of fines or sanctions imposed on this contractor."},"sanction_records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier of the sanction."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Entity that imposed the sanction."},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of that entity, digits only."},"entity_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nivel of the entity."},"entity_order":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Orden of the entity."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality of the entity."},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the resolution that imposed the sanction."},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the sanctioned contractor."},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the sanctioned contractor, digits only."},"contract_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Contract the sanction was imposed under."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value of the sanction in COP."},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the sanction was published, `yyyy-mm-dd`."},"final_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the sanction became final (fecha de firmeza), `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Calendar year of `published_date`."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public page for the process the sanction belongs to."}},"required":["id","entity","entity_nit","entity_level","entity_order","municipality","resolution_number","provider","provider_document","contract_number","value","published_date","final_date","year","url"]},"description":"The sanctions themselves; the register is small enough to return them."}},"required":["contracts","contracts_value","first_contract_date","last_contract_date","largest_contracts","awards","largest_awards","bids","sanctions","sanction_records"],"description":"What this document has done as a seller to the state."},"as_entity":{"type":"object","properties":{"contracts":{"type":"number","description":"Exact number of contracts this entity has signed as the buyer."},"processes":{"type":"number","description":"Exact number of procurement processes this entity has published."},"largest_contracts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string"},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"object":{"anyOf":[{"type":"string"},{"type":"null"}]},"value_with_additions":{"anyOf":[{"type":"number"},{"type":"null"}]},"sign_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","platform","entity","entity_nit","object","value_with_additions","sign_date","status"]},"description":"The largest contracts this entity has signed, by value."}},"required":["contracts","processes","largest_contracts"],"description":"What this document has done as a buyer. All zero for a document that is not a public entity."}},"required":["as_of","document","found","supplier","as_contractor","as_entity"]},"SecopProfileResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopProfileData"}}},"SecopAwardsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data is: the moment this dataset was last brought up to date, as an ISO timestamp. Null before the first sync."},"total":{"type":"number","description":"Records matching the filters, regardless of the page size."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number","description":"Records returned on this page."},"query":{"type":"string"},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"process_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"max_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"sort":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier of the award."},"process_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Id of the process awarded, prefixed like the processes dataset's `id`."},"award_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The platform's own id for the adjudicación."},"notice_uid":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"noticeUID of the process (`CO1.NTC.*`)."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the contracting entity."},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of the contracting entity, digits only."},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the awarded provider."},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the awarded provider, digits only, no verification digit."},"provider_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provider's internal SECOP code."},"provider_department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department of the awarded provider."},"provider_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality of the awarded provider."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"This provider's own slice of the award, in COP. Not the process total."},"awarded_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the award was made, `yyyy-mm-dd`."},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the process was published, `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Calendar year of `awarded_at`."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public page for the process."}},"required":["id","process_id","award_id","notice_uid","entity","entity_nit","provider","provider_document","provider_code","provider_department","provider_city","value","awarded_at","published_date","year","url"]}}},"required":["as_of","total","page","per_page","total_pages","count","query","provider_document","entity_nit","process_id","year","from_date","to_date","min_value","max_value","sort","results"]},"SecopAwardsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopAwardsSearchData"}}},"SecopProcessRecordData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}]},"found":{"type":"boolean","description":"Whether a process carries this id. When false, `process` is null."},"record_id":{"type":"string"},"process":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier, `<platform>:<process id>` (e.g. `secop_ii:CO1.REQ.1234567`, `secop_i:20-11-10442331`)."},"platform":{"type":"string","enum":["secop_i","secop_ii"],"description":"Which system published the row: `secop_ii` (the transactional platform, 2015 onward) or `secop_i` (the publication register, 2004 onward)."},"process_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The process id as its own platform numbers it, without the platform prefix."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's own reference for the process (número del proceso)."},"notice_uid":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SECOP II noticeUID (`CO1.NTC.*`), the id the public portal addresses a process by. Null on SECOP I."},"portfolio_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SECOP II portfolio id (`CO1.BDOS.*`), the join key to the awarded contracts. Null on SECOP I."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the contracting entity."},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of the contracting entity, digits only, no verification digit."},"entity_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's internal SECOP code."},"entity_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nivel: `NACIONAL` or `TERRITORIAL`. Published by SECOP I; null on most SECOP II rows."},"entity_order":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Orden: `NACIONAL CENTRALIZADO`, `TERRITORIAL DEPARTAMENTAL`, and so on."},"entity_department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department the entity sits in."},"entity_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality the entity sits in."},"procurement_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unidad de contratación that ran the process (SECOP II)."},"procurement_unit_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City of the unidad de contratación (SECOP II)."},"sub_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sub unidad ejecutora, when the entity splits its budget (SECOP I)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nombre del procedimiento: the short title of the process."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the entity says it is buying (descripción del procedimiento / detalle del objeto a contratar)."},"object_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Objeto a contratar, SECOP I's own classification of the purchase."},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Main UNSPSC category code of the purchase."},"unspsc_additional":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Further UNSPSC categories, as the platform prints them."},"unspsc_segment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UNSPSC segment name (SECOP I `nombre grupo`)."},"unspsc_family":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UNSPSC family name (SECOP I)."},"unspsc_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UNSPSC class name (SECOP I)."},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Modalidad de contratación: licitación pública, contratación directa, mínima cuantía, and so on."},"modality_justification":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal ground the entity gave for the modality."},"modality_cause":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Causal for the other forms of direct contracting (SECOP I)."},"regime":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Régimen de contratación the process runs under (SECOP I)."},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tipo de contrato the process would produce (obra, prestación de servicios, suministro, ...)."},"contract_subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Subtipo de contrato (SECOP II)."},"base_price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Estimated value of the process in COP (precio base / cuantía del proceso)."},"awarded_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total adjudicated in COP, summed across every award of the process. A framework agreement awards many providers, so this is not one provider's slice."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Currency the amounts are stated in. COP unless the process says otherwise."},"phase":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fase of the procedure (SECOP II): planeación, selección, and so on."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado del procedimiento in the platform's own words (`Adjudicado`, `Celebrado`, `Convocado`, `Descartado`, ...)."},"status_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado resumen, the platform's rolled-up status (SECOP II)."},"opening_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado de apertura del proceso (SECOP II)."},"awarded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the process reached an award. On SECOP II this lags reality; the contracts dataset is authoritative for who actually won."},"award_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How many awards the process made. 0 when unawarded."},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the process was first published, `yyyy-mm-dd`."},"last_published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the process was last republished, `yyyy-mm-dd`. This is the freshest change signal the source offers."},"bid_deadline":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Deadline for providers to submit offers, `yyyy-mm-dd`."},"award_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the process was awarded, `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Calendar year of `published_date`, for cheap year filters and grouping."},"invited_providers":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Providers invited to the process."},"directly_invited_providers":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Providers invited directly."},"interested_providers":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Providers that declared interest."},"responses":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Responses received to the procedure."},"external_responses":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Responses submitted outside the platform."},"offer_responses":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Responses to offers counted on the procedure."},"unique_responding_providers":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Distinct providers that responded. With `invited_providers`, the plainest measure of how contested a process was."},"lots":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Number of lots the process was split into."},"views":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Times the procedure was viewed on the platform."},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the awarded provider, when the process row names one."},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the awarded provider (NIT for a company, cédula for a natural person)."},"provider_department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department of the awarded provider."},"provider_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality of the awarded provider."},"execution_locations":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipalities the contract is to be executed in (SECOP I)."},"duration":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stated duration of the resulting contract."},"duration_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unit `duration` is counted in (días, meses, ...)."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public page for the process on its own platform."}},"required":["id","platform","process_id","reference","notice_uid","portfolio_id","entity","entity_nit","entity_code","entity_level","entity_order","entity_department","entity_city","procurement_unit","procurement_unit_city","sub_unit","name","description","object_type","unspsc_code","unspsc_additional","unspsc_segment","unspsc_family","unspsc_class","modality","modality_justification","modality_cause","regime","contract_type","contract_subtype","base_price","awarded_value","currency","phase","status","status_summary","opening_status","awarded","award_count","published_date","last_published_date","bid_deadline","award_date","year","invited_providers","directly_invited_providers","interested_providers","responses","external_responses","offer_responses","unique_responding_providers","lots","views","provider","provider_document","provider_department","provider_city","execution_locations","duration","duration_unit","url"]},{"type":"null"}]}},"required":["as_of","found","record_id","process"]},"SecopProcessRecordResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopProcessRecordData"}}},"SecopContractRecordData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}]},"found":{"type":"boolean","description":"Whether a contract carries this id. When false, `contract` is null."},"record_id":{"type":"string"},"contract":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier, `<platform>:<contract id>` (e.g. `secop_ii:CO1.PCCNTR.4168447`)."},"platform":{"type":"string","enum":["secop_i","secop_ii"],"description":"Which system published the row: `secop_ii` (the transactional platform, 2015 onward) or `secop_i` (the publication register, 2004 onward)."},"contract_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contract id as its own platform numbers it."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's own reference for the contract."},"process_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Id of the process the contract came out of, prefixed like `id`, so it joins the processes dataset."},"portfolio_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SECOP II proceso de compra (`CO1.BDOS.*`) the contract belongs to."},"award_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Id of the adjudicación the contract implements (SECOP I)."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the contracting entity."},"entity_nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of the contracting entity, digits only, no verification digit."},"entity_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's internal SECOP code."},"entity_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nivel: `NACIONAL` or `TERRITORIAL`."},"entity_order":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Orden of the entity within the state."},"entity_sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sector the entity belongs to (salud, educación, defensa, ...)."},"entity_branch":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Rama of the state the entity belongs to."},"entity_centralized":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Centralizada` or `Descentralizada`; a label upstream, not a boolean."},"entity_department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department the entity sits in."},"entity_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality the entity sits in."},"sub_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sub unidad ejecutora (SECOP I)."},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name or razón social of the contractor."},"provider_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Contractor's document, digits only: a NIT for a company, a cédula when the contractor is a natural person. The one field to filter by to see everything a person or company has contracted with the state."},"provider_document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Kind of document `provider_document` is (NIT, cédula de ciudadanía, ...)."},"provider_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provider's internal SECOP code."},"provider_department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department of the contractor."},"provider_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipality of the contractor."},"provider_is_group":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the contractor is a plural structure: a consorcio or a unión temporal."},"provider_is_sme":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the contractor is registered as a PyME / MiPyme."},"provider_size":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tamaño MiPyme as SECOP I states it (micro, pequeña, mediana)."},"legal_rep_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the contractor's legal representative."},"legal_rep_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the legal representative."},"legal_rep_document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Kind of document the legal representative holds."},"legal_rep_nationality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nationality of the legal representative."},"legal_rep_domicile":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Domicile of the legal representative."},"legal_rep_gender":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Gender of the legal representative, as the platform records it."},"object":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Objeto del contrato: what the contract is for, at signature."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Descripción del proceso the contract came out of."},"unspsc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Main UNSPSC category code."},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tipo de contrato (obra, prestación de servicios, suministro, consultoría, ...)."},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Modalidad the contract was procured under."},"modality_justification":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal ground given for the modality."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado del contrato in the platform's own words."},"delivery_conditions":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Condiciones de entrega."},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Localización recorded for the contract."},"execution_address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address the contract is executed at (SECOP II)."},"execution_locations":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Municipalities of execution (SECOP I)."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value of the contract in COP at signature, before additions."},"additions_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total added to the contract afterwards, in COP."},"value_with_additions":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value including every addition, in COP. The number to rank spending by."},"invoiced_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Invoiced to date, in COP (SECOP II)."},"paid_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Paid to date, in COP (SECOP II)."},"pending_payment_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Still to be paid, in COP (SECOP II)."},"pending_execution_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Still to be executed, in COP (SECOP II)."},"advance_payment_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract allows an advance payment."},"advance_payment_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Advance payment agreed, in COP."},"amortized_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Advance amortized to date, in COP."},"pending_amortization_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Advance still to be amortized, in COP."},"cdp_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Saldo CDP (certificado de disponibilidad presupuestal), in COP."},"vigencia_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Saldo vigencia, in COP."},"funding_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Origen de los recursos, as the platform labels it."},"funding_national_budget":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded by the Presupuesto General de la Nación, in COP."},"funding_participations":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded by the Sistema General de Participaciones, in COP."},"funding_royalties":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded by the Sistema General de Regalías, in COP."},"funding_own_territorial":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded by a mayor's or governor's own resources, in COP."},"funding_credit":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded by credit, in COP."},"funding_other":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share funded from other sources (in kind, private, cooperation), in COP."},"expense_destination":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Destino del gasto: `Inversión` or `Funcionamiento`."},"budget_position":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Posición del rubro presupuestal (SECOP I)."},"budget_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nombre del rubro presupuestal (SECOP I)."},"budget_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value charged to that rubro, in COP (SECOP I)."},"bpin_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"BPIN code of the investment project the contract belongs to."},"sign_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the contract was signed, `yyyy-mm-dd`."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When execution starts, `yyyy-mm-dd`."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When execution ends, `yyyy-mm-dd`."},"liquidation_start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start of the liquidation stage, `yyyy-mm-dd`."},"liquidation_end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End of the liquidation stage, `yyyy-mm-dd`."},"liquidation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fecha de liquidación, `yyyy-mm-dd` (SECOP I)."},"extension_notice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the entity gave notice of an extension."},"updated_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the source last touched the row, `yyyy-mm-dd`. Null on 42% of SECOP II contracts, so never treat it as complete."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Calendar year of `sign_date`."},"duration":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stated duration of the contract."},"duration_days":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Plazo de ejecución in days (SECOP I)."},"added_days":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Days added to the contract by its modifications."},"can_be_extended":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract may be extended."},"requires_liquidation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract carries a liquidation stage."},"has_environmental_obligation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract carries an environmental obligation."},"has_post_consumption_obligations":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether it carries post-consumption obligations."},"has_reversion":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether assets revert to the state at the end."},"is_post_conflict":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the contract is marked as post-conflict spending."},"peace_pillar":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pilar del Acuerdo de Paz the spending is attributed to."},"peace_point":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Punto del Acuerdo de Paz the spending is attributed to."},"standard_documents":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Documentos tipo / pliegos tipo applied to the process."},"standard_documents_sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sector of the pliegos tipo applied."},"supervisor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the contract's supervisor."},"supervisor_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the supervisor."},"expense_orderer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the ordenador del gasto."},"expense_orderer_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the ordenador del gasto."},"payment_orderer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the ordenador de pago."},"payment_orderer_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document of the ordenador de pago."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public page for the contract or its process."}},"required":["id","platform","contract_id","reference","process_id","portfolio_id","award_id","entity","entity_nit","entity_code","entity_level","entity_order","entity_sector","entity_branch","entity_centralized","entity_department","entity_city","sub_unit","provider","provider_document","provider_document_type","provider_code","provider_department","provider_city","provider_is_group","provider_is_sme","provider_size","legal_rep_name","legal_rep_document","legal_rep_document_type","legal_rep_nationality","legal_rep_domicile","legal_rep_gender","object","description","unspsc_code","contract_type","modality","modality_justification","status","delivery_conditions","location","execution_address","execution_locations","value","additions_value","value_with_additions","invoiced_value","paid_value","pending_payment_value","pending_execution_value","advance_payment_enabled","advance_payment_value","amortized_value","pending_amortization_value","cdp_balance","vigencia_balance","funding_origin","funding_national_budget","funding_participations","funding_royalties","funding_own_territorial","funding_credit","funding_other","expense_destination","budget_position","budget_name","budget_value","bpin_code","sign_date","start_date","end_date","liquidation_start_date","liquidation_end_date","liquidation_date","extension_notice_date","updated_date","year","duration","duration_days","added_days","can_be_extended","requires_liquidation","has_environmental_obligation","has_post_consumption_obligations","has_reversion","is_post_conflict","peace_pillar","peace_point","standard_documents","standard_documents_sector","supervisor","supervisor_document","expense_orderer","expense_orderer_document","payment_orderer","payment_orderer_document","url"]},{"type":"null"}]}},"required":["as_of","found","record_id","contract"]},"SecopContractRecordResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecopContractRecordData"}}},"SimitAccountStatusData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the lookup returned an account (false only on a genuinely empty result)."},"document_number":{"type":"string","description":"Echoes the request value (spaces stripped, uppercased)."},"is_plate":{"type":"boolean","description":"True when the value was matched as a vehicle plate rather than a document."},"clear":{"type":"boolean","description":"True when there is nothing outstanding (paz y salvo)."},"summary":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_fines":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_agreements":{"anyOf":[{"type":"number"},{"type":"null"}]},"payable_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"payable_fines_count":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["total","total_fines","total_agreements","payable_total","payable_fines_count"]},"fines":{"type":"array","items":{"type":"object","properties":{"ticket_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_comparendo":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"plate":{"anyOf":[{"type":"string"},{"type":"null"}]},"traffic_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount_payable":{"anyOf":[{"type":"number"},{"type":"null"}]},"infraction_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Infraction date (yyyy-mm-dd), or null."},"offender":{"type":"object","properties":{"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Offender name. The source masks it before publishing."}},"required":["document_type","document_number","name"]},"infractions":{"type":"array","items":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["code","description","amount"]}},"payment_projections":{"type":"array","items":{"type":"object","properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Deadline date (yyyy-mm-dd), or null when not a parseable date."},"days":{"anyOf":[{"type":"number"},{"type":"null"}]},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["description","amount","date","days","instructions"]}}},"required":["ticket_number","status","is_comparendo","plate","traffic_authority","department","amount","amount_payable","infraction_date","offender","infractions","payment_projections"]}},"payment_agreements":{"type":"array","items":{},"description":"Payment agreements (acuerdos de pago), passed through from the source."},"driving_courses":{"type":"array","items":{},"description":"Driving courses (cursos viales), passed through from the source."}},"required":["found","document_number","is_plate","clear","summary","fines","payment_agreements","driving_courses"]},"SimitAccountStatusResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SimitAccountStatusData"}}},"SuperfinancieraRegulationsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"bulletin":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier: kind, year and number, e.g. `ce:2026:7` (Circular Externa 007 de 2026), `cc:2026:56`, `res:2026:1195`. On the two occasions in twenty years where the register printed the same number twice in one year, the bulletin is appended to both (`res:2010:2484:b192`)."},"kind":{"type":"string","enum":["circular_externa","carta_circular","resolucion"],"description":"`circular_externa` (general instructions binding on supervised entities), `carta_circular` (informative, creates no obligation) or `resolucion` (an administrative act)."},"number":{"type":"string","description":"The number as the register prints it, leading zeros included: \"007\", \"56\", \"1195\". A handful are written out, e.g. \"Conjunta 002\" for a circular issued jointly with another superintendencia."},"number_key":{"type":"string","description":"The number in the canonical form the `id` uses: lowercased, leading zeros dropped, anything but letters and digits collapsed to a hyphen (\"007\" becomes \"7\", \"Conjunta 002\" becomes \"conjunta-002\"). Filter on this to match an act whether the caller writes the zeros or not."},"year":{"type":"number","description":"Year the act was issued, 2005 or later."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act is dated. Null on the few rows where the register prints a date this connector will not guess at rather than inventing one."},"title":{"type":"string","description":"The act as it is cited, e.g. \"Circular Externa 007 de 2026\"."},"description":{"type":"string","description":"What the act does, in the Superintendencia's own words. This is the official one-line summary the register publishes, not a generated one."},"bulletin":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issue number of the Boletín del Ministerio de Hacienda y Crédito Público, Capítulo Superintendencia Financiera, where the act was published. Null when the register lists none."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address of the act itself. Null on the few entries the register lists without a file. The format follows the era: PDF for recent acts, Word for the oldest ones."},"attachments":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"How the register names the file, e.g. \"Anexo\"."},"url":{"type":"string","description":"Address the register links it at."}},"required":["label","url"]},"description":"Anexos and other files the register links from the description. Empty when there are none."},"official_url":{"type":"string","description":"The register page the act is listed on."}},"required":["id","kind","number","number_key","year","issued_at","title","description","bulletin","document_url","attachments","official_url"]}}},"required":["as_of","query","kind","year","number","bulletin","issued_from","issued_to","total","page","per_page","total_pages","count","results"]},"SuperfinancieraRegulationsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SuperfinancieraRegulationsSearchData"}}},"SuperfinancieraRegulationData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"regulation_id":{"type":"string"},"regulation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier: kind, year and number, e.g. `ce:2026:7` (Circular Externa 007 de 2026), `cc:2026:56`, `res:2026:1195`. On the two occasions in twenty years where the register printed the same number twice in one year, the bulletin is appended to both (`res:2010:2484:b192`)."},"kind":{"type":"string","enum":["circular_externa","carta_circular","resolucion"],"description":"`circular_externa` (general instructions binding on supervised entities), `carta_circular` (informative, creates no obligation) or `resolucion` (an administrative act)."},"number":{"type":"string","description":"The number as the register prints it, leading zeros included: \"007\", \"56\", \"1195\". A handful are written out, e.g. \"Conjunta 002\" for a circular issued jointly with another superintendencia."},"number_key":{"type":"string","description":"The number in the canonical form the `id` uses: lowercased, leading zeros dropped, anything but letters and digits collapsed to a hyphen (\"007\" becomes \"7\", \"Conjunta 002\" becomes \"conjunta-002\"). Filter on this to match an act whether the caller writes the zeros or not."},"year":{"type":"number","description":"Year the act was issued, 2005 or later."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act is dated. Null on the few rows where the register prints a date this connector will not guess at rather than inventing one."},"title":{"type":"string","description":"The act as it is cited, e.g. \"Circular Externa 007 de 2026\"."},"description":{"type":"string","description":"What the act does, in the Superintendencia's own words. This is the official one-line summary the register publishes, not a generated one."},"bulletin":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issue number of the Boletín del Ministerio de Hacienda y Crédito Público, Capítulo Superintendencia Financiera, where the act was published. Null when the register lists none."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address of the act itself. Null on the few entries the register lists without a file. The format follows the era: PDF for recent acts, Word for the oldest ones."},"attachments":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"How the register names the file, e.g. \"Anexo\"."},"url":{"type":"string","description":"Address the register links it at."}},"required":["label","url"]},"description":"Anexos and other files the register links from the description. Empty when there are none."},"official_url":{"type":"string","description":"The register page the act is listed on."}},"required":["id","kind","number","number_key","year","issued_at","title","description","bulletin","document_url","attachments","official_url"]},{"type":"null"}]}},"required":["as_of","found","regulation_id","regulation"]},"SuperfinancieraRegulationResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SuperfinancieraRegulationData"}}},"SuperfinancieraData":{"type":"object","properties":{"actions":{"type":"array","items":{"type":"object","properties":{"action_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the action (yyyy-mm-dd), or null when the source prints none."},"record_id":{"type":"string","description":"The action record id, e.g. \"2024051440-001-000\"."},"party":{"type":"string","description":"Party or office involved in the action (petitioner, court unit, or entity)."},"action":{"type":"string","description":"The action performed, e.g. \"AUTO ADMISORIO VERBAL SUMARIO\"."},"attachments":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Documents filed with the action, or null."},"annexes":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Annexes to the action, or null."}},"required":["action_date","record_id","party","action","attachments","annexes"]},"description":"The complaint's action history (actuaciones), one entry per step."}},"required":["actions"]},"SuperfinancieraResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SuperfinancieraData"}}},"SuperfinancieraDoctrineSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"collection":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer":{"anyOf":[{"type":"string"},{"type":"null"}]},"topic":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"text_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The document's identifier in the Superintendencia's catalog, e.g. `18717`. The lookup takes it, and the catalog's own page for the document (`official_url`) carries it."},"collection":{"type":"string","enum":["concept","jurisdictional_ruling","financial_case_law","other"],"description":"Which part of the catalog: `concept` (doctrine: the SFC's answers to consultations), `jurisdictional_ruling` (rulings of its Delegatura para Funciones Jurisdiccionales, which decides consumer disputes with supervised entities), `financial_case_law` (rulings of the Corte Constitucional, the Consejo de Estado and the Corte Suprema de Justicia that the SFC catalogues as financial case law), or `other` for the few entries it files under none of them."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of document as the SFC labels it: \"Concepto\", \"Fallo\" or \"Sentencia\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's number as the SFC prints it, e.g. \"2020311455-001\" (a concepto), \"2017-1900\" (a fallo), \"T-123\" or \"SL1234-2025\" (a sentencia). Null when it prints none, as on many sentencias and on the most recently catalogued fallos."},"number_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number in canonical form: lowercased, spaces dropped, leading zeros of each group of digits dropped (\"2020311455 - 001\" becomes \"2020311455-1\"). The `number` filter matches this."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number (expediente or radicado) as the SFC prints it. Present on fallos and sentencias, null on conceptos."},"registration_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number uppercased, with everything but letters and digits dropped. The `registration_number` filter matches this."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year the SFC files the document under, which is the year it was issued in almost every case."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the document is dated, as the SFC prints it. Null when it prints no date."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The title the SFC gives the document, usually a subject and a reference separated by ` / `."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subject part of `title`: what comes before ` / `."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SFC's own summary of the document. Null on the few it publishes without one."},"topics":{"type":"array","items":{"type":"string"},"description":"The subject descriptors the SFC files the document under, as it publishes them."},"topic_keys":{"type":"array","items":{"type":"string"},"description":"The same descriptors in canonical form (lowercased, unaccented, spaces hyphenated: \"proteccion-al-consumidor-financiero\"), which is what the `topic` filter matches."},"issuer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who issued the document, as the SFC records it: \"Colombia. Superintendencia Financiera de Colombia\", \"Superintendencia Financiera de Colombia. Delegatura para Funciones Jurisdiccionales\", \"Colombia. Superintendencia Bancaria\" (conceptos before 2005), or the court, for a sentencia."},"issuer_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer in canonical form, without the leading \"Colombia.\" (\"corte-constitucional\", \"superintendencia-financiera-de-colombia-delegatura-para-funciones-jurisdiccionales\"). The `issuer` filter matches it from the start."},"reporting_judges":{"type":"array","items":{"type":"string"},"description":"For a sentencia, the magistrado ponente as the SFC records it. Empty otherwise."},"series":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SFC series the document is collected in, e.g. \"Superintendencia Financiera de Colombia. Conceptos 2021\". Null when it records none."},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SFC's own notes on the entry, e.g. \"Formato de archivo de sonido\" on a fallo published as a recording. Null when there are none."},"withdrawn_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the SFC withdrew the concepto from its catalog, when it did. Null otherwise."},"text_status":{"type":"string","enum":["extracted","no_text_layer","audio","dead_link","withdrawn","no_document"],"description":"Whether `text` holds the document's full text, and why not when it does not: `extracted` (it does), `no_text_layer` (the document is a scan, or in a format with no text to read), `audio` (a hearing the SFC published as a recording), `dead_link` (the SFC's link does not lead to a document), `withdrawn` (the SFC withdrew the entry) or `no_document` (the SFC published the entry without a document)."},"document_format":{"type":"string","enum":["docx","doc","rtf","html","pdf","audio","other","none"],"description":"What the linked document is: `docx`, `doc` (Word 97-2003), `rtf`, `html`, `pdf`, `audio`, `other`, or `none` when there is no document."},"official_url":{"type":"string","description":"The document's entry in the Superintendencia's own catalog."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address the Superintendencia publishes the document itself at. Null when it publishes none."}},"required":["id","collection","type","number","number_key","registration_number","registration_key","year","issued_at","title","subject","summary","topics","topic_keys","issuer","issuer_key","reporting_judges","series","notes","withdrawn_at","text_status","document_format","official_url","document_url"]}}},"required":["as_of","query","collection","year","number","registration_number","issuer","topic","from_date","to_date","text_status","total","page","per_page","total_pages","count","results"]},"SuperfinancieraDoctrineSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SuperfinancieraDoctrineSearchData"}}},"SuperfinancieraDoctrineEntryData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"entry_id":{"type":"string"},"entry":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The document's identifier in the Superintendencia's catalog, e.g. `18717`. The lookup takes it, and the catalog's own page for the document (`official_url`) carries it."},"collection":{"type":"string","enum":["concept","jurisdictional_ruling","financial_case_law","other"],"description":"Which part of the catalog: `concept` (doctrine: the SFC's answers to consultations), `jurisdictional_ruling` (rulings of its Delegatura para Funciones Jurisdiccionales, which decides consumer disputes with supervised entities), `financial_case_law` (rulings of the Corte Constitucional, the Consejo de Estado and the Corte Suprema de Justicia that the SFC catalogues as financial case law), or `other` for the few entries it files under none of them."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of document as the SFC labels it: \"Concepto\", \"Fallo\" or \"Sentencia\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's number as the SFC prints it, e.g. \"2020311455-001\" (a concepto), \"2017-1900\" (a fallo), \"T-123\" or \"SL1234-2025\" (a sentencia). Null when it prints none, as on many sentencias and on the most recently catalogued fallos."},"number_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number in canonical form: lowercased, spaces dropped, leading zeros of each group of digits dropped (\"2020311455 - 001\" becomes \"2020311455-1\"). The `number` filter matches this."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number (expediente or radicado) as the SFC prints it. Present on fallos and sentencias, null on conceptos."},"registration_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number uppercased, with everything but letters and digits dropped. The `registration_number` filter matches this."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year the SFC files the document under, which is the year it was issued in almost every case."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the document is dated, as the SFC prints it. Null when it prints no date."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The title the SFC gives the document, usually a subject and a reference separated by ` / `."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subject part of `title`: what comes before ` / `."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SFC's own summary of the document. Null on the few it publishes without one."},"topics":{"type":"array","items":{"type":"string"},"description":"The subject descriptors the SFC files the document under, as it publishes them."},"topic_keys":{"type":"array","items":{"type":"string"},"description":"The same descriptors in canonical form (lowercased, unaccented, spaces hyphenated: \"proteccion-al-consumidor-financiero\"), which is what the `topic` filter matches."},"issuer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who issued the document, as the SFC records it: \"Colombia. Superintendencia Financiera de Colombia\", \"Superintendencia Financiera de Colombia. Delegatura para Funciones Jurisdiccionales\", \"Colombia. Superintendencia Bancaria\" (conceptos before 2005), or the court, for a sentencia."},"issuer_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer in canonical form, without the leading \"Colombia.\" (\"corte-constitucional\", \"superintendencia-financiera-de-colombia-delegatura-para-funciones-jurisdiccionales\"). The `issuer` filter matches it from the start."},"reporting_judges":{"type":"array","items":{"type":"string"},"description":"For a sentencia, the magistrado ponente as the SFC records it. Empty otherwise."},"series":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SFC series the document is collected in, e.g. \"Superintendencia Financiera de Colombia. Conceptos 2021\". Null when it records none."},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SFC's own notes on the entry, e.g. \"Formato de archivo de sonido\" on a fallo published as a recording. Null when there are none."},"withdrawn_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the SFC withdrew the concepto from its catalog, when it did. Null otherwise."},"text_status":{"type":"string","enum":["extracted","no_text_layer","audio","dead_link","withdrawn","no_document"],"description":"Whether `text` holds the document's full text, and why not when it does not: `extracted` (it does), `no_text_layer` (the document is a scan, or in a format with no text to read), `audio` (a hearing the SFC published as a recording), `dead_link` (the SFC's link does not lead to a document), `withdrawn` (the SFC withdrew the entry) or `no_document` (the SFC published the entry without a document)."},"document_format":{"type":"string","enum":["docx","doc","rtf","html","pdf","audio","other","none"],"description":"What the linked document is: `docx`, `doc` (Word 97-2003), `rtf`, `html`, `pdf`, `audio`, `other`, or `none` when there is no document."},"official_url":{"type":"string","description":"The document's entry in the Superintendencia's own catalog."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address the Superintendencia publishes the document itself at. Null when it publishes none."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the document's text."},"offset":{"type":"number","description":"First character of the range, which is where the reading actually started."},"total_length":{"type":"number","description":"Length of the whole text in characters, however much of it this response carries."},"has_more":{"type":"boolean","description":"Whether the text continues past this range."},"next_offset":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pass this back as `offset` to read the next range. Null at the end of the text."}},"required":["text","offset","total_length","has_more","next_offset"]},{"type":"null"}],"description":"A range of the document's text, or null when `text_status` is anything but `extracted`."}},"required":["id","collection","type","number","number_key","registration_number","registration_key","year","issued_at","title","subject","summary","topics","topic_keys","issuer","issuer_key","reporting_judges","series","notes","withdrawn_at","text_status","document_format","official_url","document_url","content"]},{"type":"null"}]}},"required":["as_of","found","entry_id","entry"]},"SuperfinancieraDoctrineEntryResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SuperfinancieraDoctrineEntryData"}}},"AdresAffiliationData":{"type":"object","properties":{"found":{"type":"boolean","description":"false when the document is not registered in BDUA."},"document_type":{"type":"string","enum":["CC","TI","CE","RC","PA","PEP","PPT"],"description":"The queried document type, echoed back."},"document_type_label":{"type":"string","description":"Human label for the document type."},"document_number":{"type":"string","description":"The queried document number, echoed back."},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered names and surnames, null when not found."},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"affiliations":{"type":"array","items":{"type":"object","properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Affiliation state, e.g. \"ACTIVO\" or \"RETIRADO\"."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity (EPS / caja de compensación) that reported the affiliation."},"regime":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"CONTRIBUTIVO\" or \"SUBSIDIADO\"."},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Effective affiliation start date (DD/MM/YYYY)."},"termination_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Affiliation end date (DD/MM/YYYY); 31/12/2999 means still active."},"affiliate_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Affiliate type, e.g. \"COTIZANTE\" or \"BENEFICIARIO\"."}},"required":["status","entity","regime","effective_date","termination_date","affiliate_type"]},"description":"Reported affiliations; empty when not found."}},"required":["found","document_type","document_type_label","document_number","full_name","department","municipality","affiliations"]},"AdresAffiliationResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AdresAffiliationData"}}},"DnpSocialClassificationData":{"type":"object","properties":{"found":{"type":"boolean","description":"true when the person has a Sisbén IV group, a RUI classification, or both."},"document_type":{"type":"string","enum":["CC","TI","CE","RC","PA","PEP","PPT"],"description":"The queried document type, echoed back."},"document_number":{"type":"string","description":"The queried document number, echoed back."},"sisben":{"anyOf":[{"type":"object","properties":{"group":{"type":"string","description":"The Sisbén IV group: a letter and a level, from `A1` to `D21`, e.g. `C3`."},"category":{"anyOf":[{"type":"string","enum":["A","B","C","D"]},{"type":"null"}],"description":"The group's letter: `A` extreme poverty, `B` moderate poverty, `C` vulnerable, `D` neither poor nor vulnerable. null for a group Croma does not recognize."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The group's label as the register prints it, e.g. `Vulnerable`."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality where the person was surveyed."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"That municipality's department."}},"required":["group","category","label","municipality","department"]},{"type":"null"}],"description":"The Sisbén IV classification; null when the person has none."},"rui":{"anyOf":[{"type":"object","properties":{"classification":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The RUI classification as the register prints it."},"category":{"anyOf":[{"type":"string","enum":["A","B","C","D"]},{"type":"null"}],"description":"The classification's letter, on the same `A` to `D` scale as Sisbén IV."},"income_group":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The income group the register assigns."},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registered name."},"sex":{"anyOf":[{"type":"string"},{"type":"null"}]},"age":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Age in years."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["classification","category","income_group","full_name","sex","age","municipality","department"]},{"type":"null"}],"description":"The RUI classification; null when the person has none."}},"required":["found","document_type","document_number","sisben","rui"]},"DnpSocialClassificationResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DnpSocialClassificationData"}}},"DnpSisbenOfficesData":{"type":"object","properties":{"department_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department queried; null when every departmental coordinator was listed."},"total":{"type":"integer","description":"Offices in `offices`."},"offices":{"type":"array","items":{"type":"object","properties":{"level":{"type":"string","enum":["departmental","municipal"],"description":"`departmental`: the department's Sisbén coordinator. `municipal`: a municipality's Sisbén administrator."},"department":{"type":"string"},"department_code":{"type":"string","description":"The department's two-digit DIVIPOLA code, e.g. `05`."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality the office serves; for a departmental coordinator, the department's capital."},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality's five-digit DIVIPOLA code; null for a departmental coordinator."},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The official in charge."},"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As published: sometimes several numbers, or an extension."},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["level","department","department_code","municipality","municipality_code","contact_name","address","phone","email"]}}},"required":["department_code","total","offices"]},"DnpSisbenOfficesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DnpSisbenOfficesData"}}},"SupersociedadesFinancialStatementsData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when the NIT has never filed."},"document_number":{"type":"string","description":"Echoes the request's `document_number` (NIT, no check digit)."},"company":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State on the filing cover (\"Estado actual\", e.g. \"ACTIVA\"); not the RUES matrícula status."},"society_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Corporate form (e.g. \"08. SOCIEDAD POR ACCIONES SIMPLIFICADA SAS\")."},"primary_activity":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"],"description":"Primary CIIU economic activity, split from the filed \"code - label\" string."},"incorporation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of incorporation (fecha de constitución), yyyy-mm-dd."},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Matrícula mercantil."}},"required":["name","status","society_type","primary_activity","incorporation_date","city","department","registration_number"]},{"type":"null"}]},"count":{"type":"number","description":"Fiscal years returned."},"capped":{"type":"boolean","description":"True when the result cap was hit; results are then incomplete."},"statements":{"type":"array","items":{"type":"object","properties":{"year":{"type":"number"},"cutoff_date":{"type":"string","description":"Fiscal-year cutoff (yyyy-mm-dd, always Dec 31)."},"filing_id":{"type":"string","description":"Filing number (radicado); re-submissions replace earlier ones."},"statement_type":{"anyOf":[{"type":"string","enum":["individual","separado","consolidado","combinado"]},{"type":"null"}]},"niif_group":{"anyOf":[{"type":"string","enum":["plenas","pymes"]},{"type":"null"}],"description":"NIIF reporting group: \"plenas\" (group 1) or \"pymes\" (group 2)."},"reporting_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unit the filer declared (\"MILES DE PESOS\"); null when the filing declared none (fiscal years before 2025)."},"income_statement":{"anyOf":[{"type":"object","properties":{"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_of_sales":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross_profit":{"anyOf":[{"type":"number"},{"type":"null"}]},"administrative_expenses":{"anyOf":[{"type":"number"},{"type":"null"}]},"selling_expenses":{"anyOf":[{"type":"number"},{"type":"null"}]},"other_income":{"anyOf":[{"type":"number"},{"type":"null"}]},"other_expenses":{"anyOf":[{"type":"number"},{"type":"null"}]},"finance_income":{"anyOf":[{"type":"number"},{"type":"null"}]},"finance_costs":{"anyOf":[{"type":"number"},{"type":"null"}]},"operating_profit":{"anyOf":[{"type":"number"},{"type":"null"}]},"profit_before_tax":{"anyOf":[{"type":"number"},{"type":"null"}]},"income_tax":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["revenue","cost_of_sales","gross_profit","administrative_expenses","selling_expenses","other_income","other_expenses","finance_income","finance_costs","operating_profit","profit_before_tax","income_tax","net_income"]},{"type":"null"}]},"balance_sheet":{"anyOf":[{"type":"object","properties":{"current_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_current_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_current_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_equity":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_and_equivalents":{"anyOf":[{"type":"number"},{"type":"null"}]},"inventories":{"anyOf":[{"type":"number"},{"type":"null"}]},"trade_receivables":{"anyOf":[{"type":"number"},{"type":"null"}]},"trade_payables":{"anyOf":[{"type":"number"},{"type":"null"}]},"issued_capital":{"anyOf":[{"type":"number"},{"type":"null"}]},"retained_earnings":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current_assets","non_current_assets","total_assets","current_liabilities","non_current_liabilities","total_liabilities","total_equity","cash_and_equivalents","inventories","trade_receivables","trade_payables","issued_capital","retained_earnings"]},{"type":"null"}]},"cash_flow":{"anyOf":[{"type":"object","properties":{"net_cash_from_operating":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_cash_from_investing":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_cash_from_financing":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_at_start":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_at_end":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["net_cash_from_operating","net_cash_from_investing","net_cash_from_financing","cash_at_start","cash_at_end"]},{"type":"null"}]}},"required":["year","cutoff_date","filing_id","statement_type","niif_group","reporting_unit","income_statement","balance_sheet","cash_flow"]},"description":"Latest filing per fiscal year, newest first, up to 10 years."}},"required":["found","document_number","company","count","capped","statements"]},"SupersociedadesFinancialStatementsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesFinancialStatementsData"}}},"DofPublicationsByDateData":{"type":"object","properties":{"date":{"type":"string"},"published":{"type":"boolean","description":"False on days with no gazette (weekends/holidays)."},"total":{"type":"number"},"publications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null on agency section-header entries; regular notes carry one."},"edition":{"type":"string","enum":["morning","evening","extraordinary"]},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"page":{"anyOf":[{"type":"number"},{"type":"null"}]},"page_end":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Last page when the entry spans several; null for one-page entries."},"branch":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Gazette section heading, a stable 8-value vocabulary (e.g. \"PODER EJECUTIVO\")."},"agency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Publishing agency (e.g. \"SECRETARIA DE HACIENDA Y CREDITO PUBLICO\")."},"has_text":{"type":"boolean","description":"Whether the full text is machine-readable (fetch the publication endpoint)."},"has_pdf":{"type":"boolean"},"scan_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","title","edition","section","page","page_end","branch","agency","has_text","has_pdf","scan_url"]}}},"required":["date","published","total","publications"]},"DofPublicationsByDateResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DofPublicationsByDateData"}}},"DofPublicationData":{"type":"object","properties":{"found":{"type":"boolean"},"publication_id":{"type":"string"},"publication":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"date":{"anyOf":[{"type":"string"},{"type":"null"}]},"edition":{"anyOf":[{"type":"string","enum":["morning","evening","extraordinary"]},{"type":"null"}]},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"page":{"anyOf":[{"type":"number"},{"type":"null"}]},"page_end":{"anyOf":[{"type":"number"},{"type":"null"}]},"branch":{"anyOf":[{"type":"string"},{"type":"null"}]},"agency":{"anyOf":[{"type":"string"},{"type":"null"}]},"sub_agency":{"anyOf":[{"type":"string"},{"type":"null"}]},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string"},"offset":{"type":"number"},"total_length":{"type":"number"},"has_more":{"type":"boolean"},"next_offset":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["text","offset","total_length","has_more","next_offset"]},{"type":"null"}]},"is_image_only":{"type":"boolean"},"content_capped":{"type":"boolean"},"scan_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"official_url":{"type":"string"}},"required":["id","title","date","edition","section","page","page_end","branch","agency","sub_agency","content","is_image_only","content_capped","scan_url","official_url"]},{"type":"null"}]}},"required":["found","publication_id","publication"]},"DofPublicationResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DofPublicationData"}}},"FiscaliaCdmxBulletinsData":{"type":"object","properties":{"bulletins":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Comunicado reference, e.g. \"CS2026-240\"."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"excerpt":{"type":"string"},"url":{"type":"string"}},"required":["code","published_at","title","excerpt","url"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["bulletins","pagination"]},"FiscaliaCdmxBulletinsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FiscaliaCdmxBulletinsData"}}},"FiscaliaChiapasBulletinsData":{"type":"object","properties":{"bulletins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"bulletin_number":{"type":"number"},"classification":{"type":"string"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"excerpt":{"type":"string"},"url":{"type":"string"},"has_video":{"type":"boolean"}},"required":["id","bulletin_number","classification","published_at","title","excerpt","url","has_video"]}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"page_size":{"type":"number"},"has_more":{"type":"boolean"}},"required":["page","page_size","has_more"]}},"required":["bulletins","pagination"]},"FiscaliaChiapasBulletinsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FiscaliaChiapasBulletinsData"}}},"FiscaliaChihuahuaBulletinsData":{"type":"object","properties":{"query":{"type":"string"},"bulletins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"body":{"type":"string","description":"Full comunicado text, HTML stripped."},"excerpt":{"type":"string"},"categories":{"type":"array","items":{"type":"string"},"description":"Publishing unit / section tags (e.g. \"AEI\", \"Fiscalía Especializada\")."},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","published_at","updated_at","url","slug","title","body","excerpt","categories","image_url"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["query","bulletins","pagination"]},"FiscaliaChihuahuaBulletinsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FiscaliaChihuahuaBulletinsData"}}},"FiscaliaEdomexBulletinsData":{"type":"object","properties":{"bulletins":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Comunicado reference, e.g. \"696/2026\"."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"url":{"type":"string"}},"required":["code","published_at","title","url"]}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"page_size":{"type":"number"},"has_more":{"type":"boolean"}},"required":["page","page_size","has_more"]}},"required":["bulletins","pagination"]},"FiscaliaEdomexBulletinsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FiscaliaEdomexBulletinsData"}}},"FiscaliaFgrBulletinsData":{"type":"object","properties":{"bulletins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"code":{"type":"string","description":"Bulletin code, e.g. \"FGR 477/26\"."},"scope":{"type":"string","description":"Reach of the announcement, e.g. \"Nacional\" or \"Estatal\"."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"url":{"type":"string"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","code","scope","published_at","title","url","image_url"]}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"page_size":{"type":"number"},"has_more":{"type":"boolean"}},"required":["page","page_size","has_more"]}},"required":["bulletins","pagination"]},"FiscaliaFgrBulletinsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FiscaliaFgrBulletinsData"}}},"FiscaliaJaliscoBulletinsData":{"type":"object","properties":{"query":{"type":"string"},"bulletins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"excerpt":{"type":"string"},"body":{"type":"string","description":"Full comunicado text, HTML stripped."},"author":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","published_at","url","slug","title","excerpt","body","author","tags","image_url"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["query","bulletins","pagination"]},"FiscaliaJaliscoBulletinsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FiscaliaJaliscoBulletinsData"}}},"FiscaliaNuevoleonBulletinsData":{"type":"object","properties":{"query":{"type":"string"},"bulletins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"},"title":{"type":"string"},"excerpt":{"type":"string"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","published_at","url","title","excerpt","image_url"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["query","bulletins","pagination"]},"FiscaliaNuevoleonBulletinsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FiscaliaNuevoleonBulletinsData"}}},"FiscaliaPueblaBulletinsData":{"type":"object","properties":{"query":{"type":"string"},"bulletins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"bulletin_number":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"excerpt":{"type":"string"},"url":{"type":"string"}},"required":["id","bulletin_number","published_at","title","excerpt","url"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["query","bulletins","pagination"]},"FiscaliaPueblaBulletinsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FiscaliaPueblaBulletinsData"}}},"FiscaliaVeracruzBulletinsData":{"type":"object","properties":{"query":{"type":"string"},"bulletins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"body":{"type":"string","description":"Full comunicado text, HTML stripped."},"excerpt":{"type":"string"},"categories":{"type":"array","items":{"type":"string"},"description":"Section tags (e.g. \"FGE\")."},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","published_at","updated_at","url","slug","title","body","excerpt","categories","image_url"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["query","bulletins","pagination"]},"FiscaliaVeracruzBulletinsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FiscaliaVeracruzBulletinsData"}}},"FiscaliaZacatecasBulletinsData":{"type":"object","properties":{"bulletins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"},"title":{"type":"string"},"excerpt":{"type":"string"},"body":{"type":"string","description":"Full comunicado text, HTML stripped."},"categories":{"type":"array","items":{"type":"string"}},"author":{"type":"string"}},"required":["id","published_at","url","title","excerpt","body","categories","author"]}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"page_size":{"type":"number"},"has_more":{"type":"boolean"}},"required":["page","page_size","has_more"]}},"required":["bulletins","pagination"]},"FiscaliaZacatecasBulletinsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FiscaliaZacatecasBulletinsData"}}},"ScjnTesisSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"tesis_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"epoch":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"string"},{"type":"null"}]},"instance":{"anyOf":[{"type":"string"},{"type":"null"}]},"court":{"anyOf":[{"type":"string"},{"type":"null"}]},"formation":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_after":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"registration_number":{"type":"string","description":"Registro digital: the court's stable id for the tesis."},"title":{"type":"string","description":"Rubro: the heading of the tesis."},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string","enum":["jurisprudencia","aislada"]},{"type":"null"}],"description":"`jurisprudencia` (binding) or `aislada` (non-binding); null when the source reports neither."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Official citation key, e.g. \"1a./J. 132/2012 (10a.)\"."},"epoch":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Judicial epoch name, e.g. \"Décima Época\"."},"epoch_number":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Judicial epoch number (5 through 12)."},"instance":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Deciding level, e.g. \"Suprema Corte de Justicia de la Nación\", \"Tribunales Colegiados de Circuito\"."},"circuit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Judicial circuit, e.g. \"Trigésimo Circuito\". Null for SCJN chambers."},"court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Specific court or chamber, e.g. \"Primera Sala\"."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The publication, e.g. `Semanario Judicial de la Federación`."},"subjects":{"type":"array","items":{"type":"string"},"description":"Materias, e.g. `Civil`, `Constitucional`."},"location":{"anyOf":[{"type":"object","properties":{"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Semanario book, e.g. \"Libro 28\"."},"volume":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tome, e.g. \"Tomo 2\"."},"page":{"anyOf":[{"type":"number"},{"type":"null"}]},"month":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Month of the Semanario issue (1-12)."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Year of the Semanario issue."}},"required":["book","volume","page","month","year"]},{"type":"null"}]},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Full text of the tesis; null when the source carries no text."},"facts":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Hechos`: the facts section, on tesis published in the structured format (Undécima Época onward)."},"legal_criteria":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Criterio jurídico`: the holding, on structured tesis."},"justification":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Justificación`: the reasoning, on structured tesis."},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"precedent_notes":{"type":"array","items":{"type":"string"},"description":"Precedent history entries, as plain text."},"linked_case_registrations":{"type":"array","items":{"type":"string"},"description":"Registro digital ids of the rulings this tesis derives from."},"linked_vote_registrations":{"type":"array","items":{"type":"string"},"description":"Registro digital ids of published votes linked to this tesis."},"formation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the criterion was formed, e.g. \"Reiteración\", \"Contradicción de criterios (antes contradicción de tesis)\"."},"issue":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Semanario issue, e.g. \"Libro 28, Agosto de 2023\"."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` published in the Semanario; null on pre-Gaceta tesis."},"binding_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the criterion became obligatory; null on pre-Gaceta tesis."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the source last modified the record (ISO timestamp); null on tesis it has not touched since it began recording changes."},"fingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Integrity hash the source publishes for this document."},"official_url":{"type":"string"}},"required":["registration_number","title","subtitle","type","citation","epoch","epoch_number","instance","circuit","court","source","subjects","location","text","facts","legal_criteria","justification","notes","precedent_notes","linked_case_registrations","linked_vote_registrations","formation","issue","publication_date","binding_date","updated_at","fingerprint","official_url"]}}},"required":["as_of","query","tesis_type","subject","epoch","year","instance","court","formation","published_from","published_to","updated_after","total","page","per_page","total_pages","count","results"]},"ScjnTesisSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ScjnTesisSearchData"}}},"ScjnTesisData":{"type":"object","properties":{"found":{"type":"boolean"},"registration_number":{"type":"string"},"tesis":{"anyOf":[{"type":"object","properties":{"registration_number":{"type":"string","description":"Registro digital: the court's stable id for the tesis."},"title":{"type":"string","description":"Rubro: the heading of the tesis."},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string","enum":["jurisprudencia","aislada"]},{"type":"null"}],"description":"`jurisprudencia` (binding) or `aislada` (non-binding); null when the source reports neither."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Official citation key, e.g. \"1a./J. 132/2012 (10a.)\"."},"epoch":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Judicial epoch name, e.g. \"Décima Época\"."},"epoch_number":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Judicial epoch number (5 through 12)."},"instance":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Deciding level, e.g. \"Suprema Corte de Justicia de la Nación\", \"Tribunales Colegiados de Circuito\"."},"circuit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Judicial circuit, e.g. \"Trigésimo Circuito\". Null for SCJN chambers."},"court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Specific court or chamber, e.g. \"Primera Sala\"."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The publication, e.g. `Semanario Judicial de la Federación`."},"subjects":{"type":"array","items":{"type":"string"},"description":"Materias, e.g. `Civil`, `Constitucional`."},"location":{"anyOf":[{"type":"object","properties":{"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Semanario book, e.g. \"Libro 28\"."},"volume":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tome, e.g. \"Tomo 2\"."},"page":{"anyOf":[{"type":"number"},{"type":"null"}]},"month":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Month of the Semanario issue (1-12)."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Year of the Semanario issue."}},"required":["book","volume","page","month","year"]},{"type":"null"}]},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Full text of the tesis; null when the source carries no text."},"facts":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Hechos`: the facts section, on tesis published in the structured format (Undécima Época onward)."},"legal_criteria":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Criterio jurídico`: the holding, on structured tesis."},"justification":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Justificación`: the reasoning, on structured tesis."},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"precedent_notes":{"type":"array","items":{"type":"string"},"description":"Precedent history entries, as plain text."},"linked_case_registrations":{"type":"array","items":{"type":"string"},"description":"Registro digital ids of the rulings this tesis derives from."},"linked_vote_registrations":{"type":"array","items":{"type":"string"},"description":"Registro digital ids of published votes linked to this tesis."},"formation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the criterion was formed, e.g. \"Reiteración\", \"Contradicción de criterios (antes contradicción de tesis)\"."},"issue":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Semanario issue, e.g. \"Libro 28, Agosto de 2023\"."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` published in the Semanario; null on pre-Gaceta tesis."},"binding_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the criterion became obligatory; null on pre-Gaceta tesis."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the source last modified the record (ISO timestamp); null on tesis it has not touched since it began recording changes."},"fingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Integrity hash the source publishes for this document."},"official_url":{"type":"string"}},"required":["registration_number","title","subtitle","type","citation","epoch","epoch_number","instance","circuit","court","source","subjects","location","text","facts","legal_criteria","justification","notes","precedent_notes","linked_case_registrations","linked_vote_registrations","formation","issue","publication_date","binding_date","updated_at","fingerprint","official_url"]},{"type":"null"}]}},"required":["found","registration_number","tesis"]},"ScjnTesisResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ScjnTesisData"}}},"ScjnTesisBrowseData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"tesis_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"epoch":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"string"},{"type":"null"}]},"instance":{"anyOf":[{"type":"string"},{"type":"null"}]},"court":{"anyOf":[{"type":"string"},{"type":"null"}]},"formation":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_after":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"registration_number":{"type":"string","description":"Registro digital: the court's stable id for the tesis."},"title":{"type":"string","description":"Rubro: the heading of the tesis."},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string","enum":["jurisprudencia","aislada"]},{"type":"null"}],"description":"`jurisprudencia` (binding) or `aislada` (non-binding); null when the source reports neither."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Official citation key, e.g. \"1a./J. 132/2012 (10a.)\"."},"epoch":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Judicial epoch name, e.g. \"Décima Época\"."},"epoch_number":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Judicial epoch number (5 through 12)."},"instance":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Deciding level, e.g. \"Suprema Corte de Justicia de la Nación\", \"Tribunales Colegiados de Circuito\"."},"circuit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Judicial circuit, e.g. \"Trigésimo Circuito\". Null for SCJN chambers."},"court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Specific court or chamber, e.g. \"Primera Sala\"."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The publication, e.g. `Semanario Judicial de la Federación`."},"subjects":{"type":"array","items":{"type":"string"},"description":"Materias, e.g. `Civil`, `Constitucional`."},"location":{"anyOf":[{"type":"object","properties":{"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Semanario book, e.g. \"Libro 28\"."},"volume":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tome, e.g. \"Tomo 2\"."},"page":{"anyOf":[{"type":"number"},{"type":"null"}]},"month":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Month of the Semanario issue (1-12)."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Year of the Semanario issue."}},"required":["book","volume","page","month","year"]},{"type":"null"}]},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Full text of the tesis; null when the source carries no text."},"facts":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Hechos`: the facts section, on tesis published in the structured format (Undécima Época onward)."},"legal_criteria":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Criterio jurídico`: the holding, on structured tesis."},"justification":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Justificación`: the reasoning, on structured tesis."},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"precedent_notes":{"type":"array","items":{"type":"string"},"description":"Precedent history entries, as plain text."},"linked_case_registrations":{"type":"array","items":{"type":"string"},"description":"Registro digital ids of the rulings this tesis derives from."},"linked_vote_registrations":{"type":"array","items":{"type":"string"},"description":"Registro digital ids of published votes linked to this tesis."},"formation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the criterion was formed, e.g. \"Reiteración\", \"Contradicción de criterios (antes contradicción de tesis)\"."},"issue":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Semanario issue, e.g. \"Libro 28, Agosto de 2023\"."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` published in the Semanario; null on pre-Gaceta tesis."},"binding_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the criterion became obligatory; null on pre-Gaceta tesis."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the source last modified the record (ISO timestamp); null on tesis it has not touched since it began recording changes."},"fingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Integrity hash the source publishes for this document."},"official_url":{"type":"string"}},"required":["registration_number","title","subtitle","type","citation","epoch","epoch_number","instance","circuit","court","source","subjects","location","text","facts","legal_criteria","justification","notes","precedent_notes","linked_case_registrations","linked_vote_registrations","formation","issue","publication_date","binding_date","updated_at","fingerprint","official_url"]}}},"required":["as_of","query","tesis_type","subject","epoch","year","instance","court","formation","published_from","published_to","updated_after","total","page","per_page","total_pages","count","results"]},"ScjnTesisBrowseResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ScjnTesisBrowseData"},"deprecation":{"type":"object","description":"Present only while this endpoint is being retired. Mirrors the Deprecation, Sunset and Link response headers.","required":["since","sunset","successor","message"],"properties":{"since":{"type":"string","format":"date"},"sunset":{"type":"string","format":"date"},"successor":{"type":"string","description":"Path of the endpoint to use instead."},"message":{"type":"string"}}}}},"BanxicoCircularsData":{"type":"object","properties":{"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Echo of the year filter; null when listing every year."},"circulars":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string","description":"As printed in the index, e.g. \"11/2026\", \"E-126/2013\", \"S/N\"."},"year":{"type":"number"},"subject":{"type":"string"},"modifies":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Base circular number when the subject is \"Modifica la Circular X/YYYY\"."},"abrogated":{"type":"boolean","description":"Marked abrogated (no longer in effect) in the index."},"has_detail":{"type":"boolean","description":"Whether the row links to a detail page usable with the lookup endpoint."}},"required":["number","year","subject","modifies","abrogated","has_detail"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["year","circulars","pagination"]},"BanxicoCircularsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/BanxicoCircularsData"}}},"BanxicoCircularData":{"type":"object","properties":{"found":{"type":"boolean"},"number":{"type":"string"},"circular":{"anyOf":[{"type":"object","properties":{"number":{"type":"string","description":"The circular this page describes; amendment lookups resolve to their base."},"abrogated":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"obligated_subjects":{"type":"array","items":{"type":"string"}},"compiled_pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Current consolidated text (all modifications applied)."},"original_pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text as originally published."},"original_dof_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"comparison_pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consolidated comparison of every modification, when the page offers one."},"abrogated_by":{"anyOf":[{"type":"object","properties":{"text":{"type":"string"},"circular_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["text","circular_number","url"]},{"type":"null"}],"description":"The abrogating instrument, from the page banner; null while in force."},"modifications":{"type":"array","items":{"type":"object","properties":{"circular_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Modifying circular, e.g. \"11/2026\"; null when the entry names no one."},"dof_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"string"}},"required":["circular_number","dof_date","pdf_url","description"]}},"official_url":{"type":"string"}},"required":["number","abrogated","title","subject","obligated_subjects","compiled_pdf_url","original_pdf_url","original_dof_date","comparison_pdf_url","abrogated_by","modifications","official_url"]},{"type":"null"}]}},"required":["found","number","circular"]},"BanxicoCircularResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/BanxicoCircularData"}}},"CnbvRegulationsData":{"type":"object","properties":{"regulations":{"type":"array","items":{"type":"object","properties":{"regulation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stable numeric id (as string) used by the history endpoint; null when the norm has no modification history."},"name":{"type":"string"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. \"Ley\", \"Acuerdo\", \"Circular\", \"Disposiciones de carácter general\"."},"dof_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null when the catalog lists \"No aplica\"."},"sectors":{"type":"array","items":{"type":"string"},"description":"Financial sectors the norm applies to (e.g. \"Sector Bancario\")."},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["regulation_id","name","type","dof_date","sectors","pdf_url"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["regulations","pagination"]},"CnbvRegulationsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CnbvRegulationsData"}}},"CnbvRegulationHistoryData":{"type":"object","properties":{"found":{"type":"boolean"},"regulation_id":{"type":"string"},"modifications":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"dof_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DOF publication date extracted from the description, ISO YYYY-MM-DD."},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"order":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Upstream display hint, not chronology: sort by dof_date instead."}},"required":["description","dof_date","pdf_url","order"]}},"annexes":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"order":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["description","pdf_url","order"]}}},"required":["found","regulation_id","modifications","annexes"]},"CnbvRegulationHistoryResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CnbvRegulationHistoryData"}}},"CnsfProvisionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"instrument":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"chapter_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_circular":{"anyOf":[{"type":"string"},{"type":"null"}]},"amended_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"amended_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier: instrument, kind and the number the instrument gives the provision (e.g. `cusf:disp:3.1.2`, `lisf:art:41`, `cusf:anexo:14.2.1-a`)."},"instrument":{"type":"string","enum":["LISF","CUSF"],"description":"`LISF` (Ley de Instituciones de Seguros y de Fianzas) or `CUSF` (Circular Única de Seguros y de Fianzas)."},"kind":{"type":"string","enum":["articulo","disposicion","anexo","transitoria","anexo_transitorio","capitulo","documento"],"description":"`articulo` (LISF), `disposicion`, `anexo`, `anexo_transitorio` and `documento` (CUSF), `transitoria` (either), or `capitulo` for a chapter repealed in full, which has explanatory text but no numbered provisions."},"number":{"type":"string","description":"The number the instrument itself gives the provision: \"41\", \"3.1.2\", \"14.2.1-a\"."},"title_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the título the provision sits under, e.g. \"3\"."},"title_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the título, e.g. \"DEL GOBIERNO CORPORATIVO\"."},"chapter_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the capítulo, e.g. \"3.1\". Null on annexes, which hang off a chapter rather than sitting in one."},"chapter_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the capítulo, or of the annex group."},"heading":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provision's own official title, where the instrument publishes one: the description the annex index gives an anexo, or the entry the documentation index gives a documento."},"source_circular":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a `transitoria`, the Circular Modificatoria that introduced it (e.g. \"3/26\"), or `original` for the provisions issued with the instrument itself. Null on every other kind."},"external_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a `documento`, the address the instrument points to for it. Null on every other kind."},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Full text of the provision, including its fracciones and incisos. Null on the few annexes the source publishes only as an image and on a chapter it has repealed outright."},"amendment_note":{"anyOf":[{"type":"string","enum":["nuevo","modificado","derogado"]},{"type":"null"}],"description":"What the source flags about the containing chapter or annex: `nuevo`, `modificado` or `derogado`. Null when it flags nothing."},"last_amended_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the containing chapter or annex was last amended in the DOF. Null when the source flags no amendment, which means it has not changed since the instrument was issued."},"position":{"type":"number","description":"Reading order within the instrument, so provisions sort the way they are printed rather than alphabetically."},"official_url":{"type":"string"}},"required":["id","instrument","kind","number","title_number","title_name","chapter_number","chapter_name","heading","source_circular","external_url","text","amendment_note","last_amended_at","position","official_url"]}}},"required":["as_of","query","instrument","kind","number","chapter_number","source_circular","amended_from","amended_to","total","page","per_page","total_pages","count","results"]},"CnsfProvisionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CnsfProvisionsSearchData"}}},"CnsfProvisionData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"provision_id":{"type":"string"},"provision":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier: instrument, kind and the number the instrument gives the provision (e.g. `cusf:disp:3.1.2`, `lisf:art:41`, `cusf:anexo:14.2.1-a`)."},"instrument":{"type":"string","enum":["LISF","CUSF"],"description":"`LISF` (Ley de Instituciones de Seguros y de Fianzas) or `CUSF` (Circular Única de Seguros y de Fianzas)."},"kind":{"type":"string","enum":["articulo","disposicion","anexo","transitoria","anexo_transitorio","capitulo","documento"],"description":"`articulo` (LISF), `disposicion`, `anexo`, `anexo_transitorio` and `documento` (CUSF), `transitoria` (either), or `capitulo` for a chapter repealed in full, which has explanatory text but no numbered provisions."},"number":{"type":"string","description":"The number the instrument itself gives the provision: \"41\", \"3.1.2\", \"14.2.1-a\"."},"title_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the título the provision sits under, e.g. \"3\"."},"title_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the título, e.g. \"DEL GOBIERNO CORPORATIVO\"."},"chapter_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the capítulo, e.g. \"3.1\". Null on annexes, which hang off a chapter rather than sitting in one."},"chapter_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the capítulo, or of the annex group."},"heading":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provision's own official title, where the instrument publishes one: the description the annex index gives an anexo, or the entry the documentation index gives a documento."},"source_circular":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a `transitoria`, the Circular Modificatoria that introduced it (e.g. \"3/26\"), or `original` for the provisions issued with the instrument itself. Null on every other kind."},"external_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a `documento`, the address the instrument points to for it. Null on every other kind."},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Full text of the provision, including its fracciones and incisos. Null on the few annexes the source publishes only as an image and on a chapter it has repealed outright."},"amendment_note":{"anyOf":[{"type":"string","enum":["nuevo","modificado","derogado"]},{"type":"null"}],"description":"What the source flags about the containing chapter or annex: `nuevo`, `modificado` or `derogado`. Null when it flags nothing."},"last_amended_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the containing chapter or annex was last amended in the DOF. Null when the source flags no amendment, which means it has not changed since the instrument was issued."},"position":{"type":"number","description":"Reading order within the instrument, so provisions sort the way they are printed rather than alphabetically."},"official_url":{"type":"string"}},"required":["id","instrument","kind","number","title_number","title_name","chapter_number","chapter_name","heading","source_circular","external_url","text","amendment_note","last_amended_at","position","official_url"]},{"type":"null"}]}},"required":["as_of","found","provision_id","provision"]},"CnsfProvisionResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CnsfProvisionData"}}},"CnsfAmendmentsData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"chapter_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier for the amendment entry."},"title":{"type":"string","description":"The amendment as the source names it, e.g. \"CIRCULAR Modificatoria 3/26\"."},"circular_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The circular's own number and year label, e.g. \"9/23\". Not unique: the source reuses some numbers."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` published in the DOF. Null when the source does not state the exact date; it is never inferred, because the year in the circular's number is not reliably the year it was published."},"listed_month":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Month (1-12) the source lists the amendment under."},"listed_day":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Day of the month the source lists the amendment under."},"dof_document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the DOF publication, when the source links one. Resolves through the DOF endpoints."},"dof_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Link to the DOF publication, when the source offers one."},"summary":{"type":"string","description":"Everything the amendment did, as one line. The same content as `changes`, joined, so it can be searched and shown in a list."},"changes":{"type":"array","items":{"type":"string"},"description":"What the amendment did, as the source describes it, e.g. \"Modificación al Anexo 35.1.9\"."},"affected_chapters":{"type":"array","items":{"type":"string"},"description":"Chapter numbers the amendment touched, e.g. [\"39.6\"]."},"affected_annexes":{"type":"array","items":{"type":"string"},"description":"Annex numbers the amendment touched, e.g. [\"14.2.1-y\"]."},"affected_urls":{"type":"array","items":{"type":"string"},"description":"Links to what the amendment touched."}},"required":["id","title","circular_number","published_at","listed_month","listed_day","dof_document_id","dof_url","summary","changes","affected_chapters","affected_annexes","affected_urls"]}}},"required":["as_of","query","chapter_number","published_from","published_to","total","page","per_page","total_pages","count","results"]},"CnsfAmendmentsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CnsfAmendmentsData"}}},"DiputadosFederalLawsData":{"type":"object","properties":{"laws":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Slug of the law's reform-history page (e.g. \"lic\", \"cpeum\")."},"name":{"type":"string"},"abbreviation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Official short code (e.g. \"LIC\") when the library uses one; else null."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Original DOF publication date."},"last_reform_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null when unreformed, or when the latest entry is a court event."},"last_reform_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Verbatim SCJN qualifier when the latest listed event is judicial, not a reform."},"status_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Verbatim legal-status annotation: invalidity declarations, pending abrogation, entry into force."},"abrogated":{"type":"boolean","description":"True when the library lists the law as abrogated (no longer in force)."},"reformed":{"type":"boolean"},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Current consolidated text (official documents on diputados.gob.mx)."},"doc_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","abbreviation","publication_date","last_reform_date","last_reform_note","status_note","abrogated","reformed","pdf_url","doc_url"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["laws","pagination"]},"DiputadosFederalLawsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DiputadosFederalLawsData"}}},"DiputadosFederalLawData":{"type":"object","properties":{"found":{"type":"boolean"},"law_id":{"type":"string"},"law":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Slug of the law's reform-history page (e.g. \"lic\", \"cpeum\")."},"name":{"type":"string"},"abbreviation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Official short code (e.g. \"LIC\") when the library uses one; else null."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Original DOF publication date."},"last_reform_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null when unreformed, or when the latest entry is a court event."},"last_reform_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Verbatim SCJN qualifier when the latest listed event is judicial, not a reform."},"status_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Verbatim legal-status annotation: invalidity declarations, pending abrogation, entry into force."},"abrogated":{"type":"boolean","description":"True when the library lists the law as abrogated (no longer in force)."},"reformed":{"type":"boolean"},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Current consolidated text (official documents on diputados.gob.mx)."},"doc_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"original_publication":{"anyOf":[{"type":"object","properties":{"dof_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"scan_pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Scan of the original DOF publication."}},"required":["dof_date","scan_pdf_url"]},{"type":"null"}]},"reforms":{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Reform ordinal as numbered by the library (newest first, highest number)."},"dof_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"string","description":"Decree headline (\"DECRETO por el que se reforman ...\")."},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"doc_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"errata":{"type":"array","items":{"type":"object","properties":{"dof_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"doc_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["dof_date","pdf_url","doc_url"]},"description":"Fe de erratas published for this decree, if any."}},"required":["number","dof_date","description","pdf_url","doc_url","errata"]},"description":"Reform decrees, newest first."}},"required":["id","name","abbreviation","publication_date","last_reform_date","last_reform_note","status_note","abrogated","reformed","pdf_url","doc_url","original_publication","reforms"]},{"type":"null"}]}},"required":["found","law_id","law"]},"DiputadosFederalLawResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DiputadosFederalLawData"}}},"DiputadosFederalRegulationsData":{"type":"object","properties":{"regulations":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"abrogated":{"type":"boolean","description":"True for the appendix of reglamentos no longer in force."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"doc_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"history":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["original","reform","amounts","erratum","clarification","validity"],"description":"\"amounts\" covers the annual Cantidades/Cuota updates; \"erratum\", \"clarification\" and \"validity\" map the Fe de erratas, Aclaración and Disposición de vigencia notices."},"dof_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"doc_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","dof_date","doc_url"]}}},"required":["name","abrogated","publication_date","pdf_url","doc_url","history"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["regulations","pagination"]},"DiputadosFederalRegulationsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DiputadosFederalRegulationsData"}}},"DiputadosLawReformsData":{"type":"object","properties":{"year":{"type":"number"},"found":{"type":"boolean"},"decrees":{"type":"array","items":{"type":"object","properties":{"dof_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"summary":{"type":"string","description":"Full decree prose from the log (can be long: it enumerates articles)."},"actions":{"type":"array","items":{"type":"string"},"description":"Canonical actions: \"reforman\", \"adicionan\", \"derogan\", \"abrogan\", \"expiden\", \"modifican\", \"actualizan\", \"fe de erratas\", \"aclaración\", plus \"sentencia\" for court entries with no decree verb."},"affected_laws":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"description":"A single decree can touch many laws."}},"required":["dof_date","summary","actions","affected_laws"]}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["year","found","decrees","pagination"]},"DiputadosLawReformsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DiputadosLawReformsData"}}},"SiemEstablishmentsData":{"type":"object","properties":{"query":{"type":"string","description":"The name actually searched for, as the directory matched it."},"establishments":{"type":"array","items":{"type":"object","properties":{"establishment_id":{"type":"string","description":"Id to pass to the establishment lookup."},"commercial_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Declared commercial name."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Chamber the establishment is affiliated with."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State name for `state_code`."},"state_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"INEGI state code."}},"required":["establishment_id","commercial_name","chamber","state","state_code"]},"description":"The matching establishments on this page."},"pagination":{"type":"object","properties":{"total":{"type":"number"},"page_size":{"type":"number"},"total_pages":{"type":"number"},"page":{"type":"number"}},"required":["total","page_size","total_pages","page"]}},"required":["query","establishments","pagination"]},"SiemEstablishmentsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiemEstablishmentsData"}}},"SiemEstablishmentData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the id is known. When false, `establishment` is null."},"establishment_id":{"type":"string","description":"The queried id, echoed back."},"establishment":{"anyOf":[{"type":"object","properties":{"rfc":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social (personas morales); null for personas físicas."},"person_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Full name (personas físicas); null for personas morales."},"commercial_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"main_activity":{"anyOf":[{"type":"string"},{"type":"null"}]},"activity_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"SCIAN activity code."},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"state_code":{"anyOf":[{"type":"number"},{"type":"null"}]},"municipality_code":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registration status, e.g. \"Actualizado\"."},"public_listing":{"type":"boolean","description":"Whether the establishment opted into the public listing."},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"location":{"anyOf":[{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"exterior_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"interior_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"between_streets":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cross streets (\"entre calles\"), joined when both are declared."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","exterior_number","interior_number","neighborhood","postal_code","municipality","between_streets","phone","email","website"]},{"type":"null"}]},"profile":{"anyOf":[{"type":"object","properties":{"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Declared start of operations (yyyy-mm-dd)."},"employees":{"anyOf":[{"type":"number"},{"type":"null"}]},"women_employees":{"anyOf":[{"type":"number"},{"type":"null"}]},"exports":{"type":"boolean"},"imports":{"type":"boolean"},"government_supplier":{"type":"boolean"},"activities":{"type":"array","items":{"type":"string"},"description":"Declared secondary activities."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_group":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["start_date","employees","women_employees","exports","imports","government_supplier","activities","chamber","business_group"]},{"type":"null"}]},"products":{"type":"array","items":{"type":"string"},"description":"Declared goods."},"services":{"type":"array","items":{"type":"string"},"description":"Declared services."},"export_countries":{"type":"array","items":{"type":"string"}},"import_countries":{"type":"array","items":{"type":"string"}}},"required":["rfc","legal_name","person_name","commercial_name","main_activity","activity_code","state","state_code","municipality_code","status","public_listing","registration_date","updated_date","expiration_date","location","profile","products","services","export_countries","import_countries"]},{"type":"null"}]}},"required":["found","establishment_id","establishment"]},"SiemEstablishmentResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiemEstablishmentData"}}},"RreeData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether a card matched. When false, the remaining fields are null."},"card_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The card number as registered."},"birth_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of birth (yyyy-mm-dd)."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Surname as registered."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Given names as registered."},"nationality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nationality as registered."},"expiration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Card expiration date (yyyy-mm-dd)."},"immigration_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Immigration status (calidad migratoria) as registered."}},"required":["found","card_number","birth_date","last_name","first_name","nationality","expiration_date","immigration_status"]},"RreeResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RreeData"}}},"ApesegSoatData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the source returned a definitive answer for the plate."},"plate":{"type":"string","description":"Echoes the searched plate (trimmed, uppercased)."},"has_active_soat":{"type":"boolean","description":"True when at least one certificate is currently VIGENTE."},"active":{"anyOf":[{"type":"object","properties":{"company":{"type":"string","description":"Issuing insurance company (e.g. \"Interseguro\")."},"status":{"type":"string","description":"Coverage status: VIGENTE / VENCIDO / ANULADO."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coverage start date."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coverage end date."},"policy_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"vehicle_use":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Vehicle use (e.g. \"PARTICULAR\")."},"vehicle_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Vehicle class (e.g. \"AUTOMOVIL\")."},"certificate_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Certificate type: DIGITAL / FISICO."},"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issue/creation date."},"annulled_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Annulment date when annulled."}},"required":["company","status","start_date","end_date","policy_number","vehicle_use","vehicle_class","certificate_type","brand","model","created_date","annulled_date"]},{"type":"null"}],"description":"The current (VIGENTE) certificate when present, else null."},"count":{"type":"number","description":"Number of certificates on record."},"certificates":{"type":"array","items":{"type":"object","properties":{"company":{"type":"string","description":"Issuing insurance company (e.g. \"Interseguro\")."},"status":{"type":"string","description":"Coverage status: VIGENTE / VENCIDO / ANULADO."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coverage start date."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coverage end date."},"policy_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"vehicle_use":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Vehicle use (e.g. \"PARTICULAR\")."},"vehicle_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Vehicle class (e.g. \"AUTOMOVIL\")."},"certificate_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Certificate type: DIGITAL / FISICO."},"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issue/creation date."},"annulled_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Annulment date when annulled."}},"required":["company","status","start_date","end_date","policy_number","vehicle_use","vehicle_class","certificate_type","brand","model","created_date","annulled_date"]},"description":"Certificate history, newest first as the source returns it."}},"required":["found","plate","has_active_soat","active","count","certificates"]},"ApesegSoatResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ApesegSoatData"}}},"SbsSoatData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the source returned SOAT information for the plate."},"plate":{"type":"string","description":"Echoes the searched plate (trimmed, uppercased)."},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Query timestamp the source stamps (ISO, when parseable)."},"data_through":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"Información actualizada a\" label (e.g. \"ABRIL 2026\"), passthrough."},"accident_count":{"type":"number","description":"Siniestralidad: accidents covered by SOAT in the last 5 years."},"has_active_soat":{"type":"boolean","description":"True when a policy is currently in force (VIGENTE)."},"active":{"anyOf":[{"type":"object","properties":{"company":{"type":"string","description":"Issuing insurance company (e.g. \"Interseguro\", \"Rímac Seguros\")."},"vehicle_class":{"type":"string","description":"Vehicle class (e.g. \"Automóvil\", \"Camioneta Pick up\")."},"vehicle_use":{"type":"string","description":"Vehicle use (e.g. \"Particular\")."},"accident_count":{"type":"number","description":"Accidents covered by this policy."},"policy_number":{"type":"string"},"certificate_number":{"type":"string"},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coverage start date (yyyy-mm-dd when parseable)."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coverage end date (yyyy-mm-dd when parseable)."},"status":{"type":"string","enum":["VIGENTE","VENCIDA","ANULADA"],"description":"Derived from the coverage window and the source's own comment."},"annulled_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Annulment date when the comment reports one."},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's comment on the policy, e.g. an annulment note."}},"required":["company","vehicle_class","vehicle_use","accident_count","policy_number","certificate_number","start_date","end_date","status","annulled_date","comment"]},{"type":"null"}],"description":"The current (VIGENTE) policy when present, else null."},"count":{"type":"number","description":"Number of policies on record."},"policies":{"type":"array","items":{"type":"object","properties":{"company":{"type":"string","description":"Issuing insurance company (e.g. \"Interseguro\", \"Rímac Seguros\")."},"vehicle_class":{"type":"string","description":"Vehicle class (e.g. \"Automóvil\", \"Camioneta Pick up\")."},"vehicle_use":{"type":"string","description":"Vehicle use (e.g. \"Particular\")."},"accident_count":{"type":"number","description":"Accidents covered by this policy."},"policy_number":{"type":"string"},"certificate_number":{"type":"string"},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coverage start date (yyyy-mm-dd when parseable)."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coverage end date (yyyy-mm-dd when parseable)."},"status":{"type":"string","enum":["VIGENTE","VENCIDA","ANULADA"],"description":"Derived from the coverage window and the source's own comment."},"annulled_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Annulment date when the comment reports one."},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's comment on the policy, e.g. an annulment note."}},"required":["company","vehicle_class","vehicle_use","accident_count","policy_number","certificate_number","start_date","end_date","status","annulled_date","comment"]},"description":"Policy history, newest first as the source returns it."}},"required":["found","plate","report_date","data_through","accident_count","has_active_soat","active","count","policies"]},"SbsSoatResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SbsSoatData"}}},"SutranInfraccionesData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the source returned a definitive verdict for the plate."},"plate":{"type":"string","description":"Echoes the searched plate (trimmed, uppercased)."},"has_infractions":{"type":"boolean","description":"True when the plate has at least one infraction on record."},"count":{"type":"number","description":"Number of infraction rows."},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's verdict line (present when the plate is clear)."},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Report date (yyyy-mm-dd when parseable, else null)."},"currency":{"type":"string","description":"ISO 4217 currency of `total` (Peruvian sol)."},"total":{"type":"number","description":"Total amount payable across the infractions."},"infractions":{"type":"array","items":{"type":"object","properties":{"document_number":{"type":"string","description":"\"Número de documento\" (e.g. the papeleta number)."},"document_type":{"type":"string","description":"\"Tipo de Documento\" (e.g. \"Papeletas Transito\")."},"document_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"Fecha de Documento\" (yyyy-mm-dd when parseable, else null)."},"infraction_code":{"type":"string","description":"\"Código de Infracción\" (e.g. \"M20\")."},"classification":{"type":"string","description":"\"Clasificación\" (e.g. \"Muy Grave\")."}},"required":["document_number","document_type","document_date","infraction_code","classification"]},"description":"Infraction rows when present (empty when the plate is clear)."}},"required":["found","plate","has_infractions","count","message","report_date","currency","total","infractions"]},"SutranInfraccionesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SutranInfraccionesData"}}},"CallaoPapeletasData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the source returned a definitive verdict for the plate."},"plate":{"type":"string","description":"Echoes the searched plate (trimmed, uppercased)."},"has_papeletas":{"type":"boolean","description":"True when the plate has at least one outstanding ticket."},"count":{"type":"number","description":"Number of outstanding tickets."},"currency":{"type":"string","description":"Currency of the amounts (PEN)."},"total":{"type":"number","description":"Sum of the outstanding amounts."},"papeletas":{"type":"array","items":{"type":"object","properties":{"plate":{"type":"string","description":"Vehicle plate the ticket is registered against."},"code":{"type":"string","description":"Infraction code (e.g. \"M20\")."},"ticket_number":{"type":"string","description":"Ticket number (N° Papeleta)."},"infraction_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Infraction date (yyyy-mm-dd when parseable)."},"amount":{"type":"number","description":"Outstanding amount in PEN."},"installment":{"type":"number","description":"Installment number (N° Cuota)."},"ticket_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's internal ticket id, when present."}},"required":["plate","code","ticket_number","infraction_date","amount","installment","ticket_id"]},"description":"Outstanding tickets (empty when the plate is clear)."}},"required":["found","plate","has_papeletas","count","currency","total","papeletas"]},"CallaoPapeletasResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CallaoPapeletasData"}}},"SatLimaAccountStatusData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the source resolved an account (false only on a genuinely empty result)."},"query":{"type":"string","description":"Echoes the searched value (trimmed, uppercased)."},"document_type":{"type":"string","enum":["dni","ruc","placa","papeleta","cod_administrado","compromiso"],"description":"The search dimension used."},"clear":{"type":"boolean","description":"True when there is nothing outstanding."},"summary":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Sum of the outstanding amounts, in PEN."},"items_count":{"type":"number"}},"required":["total","items_count"]},"debts":{"type":"array","items":{"type":"object","properties":{"group":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Human label for the debt group (e.g. \"Papeletas\", \"Impuesto vehicular\")."},"group_code":{"anyOf":[{"type":"number"},{"type":"null"}]},"concept_code":{"anyOf":[{"type":"number"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"document":{"anyOf":[{"type":"string"},{"type":"null"}]},"plate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Plate, for vehicle-bound items (papeletas / vehicular)."},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Outstanding amount, in PEN."},"amount_with_discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tax year, for tax items."},"installment":{"anyOf":[{"type":"string"},{"type":"null"}]},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Due date (yyyy-mm-dd when parseable)."},"infraction_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Infraction date (yyyy-mm-dd when parseable)."},"violation_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"violation":{"anyOf":[{"type":"string"},{"type":"null"}]},"regulation":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["group","group_code","concept_code","reference","document","plate","amount","amount_with_discount","status","year","installment","due_date","infraction_date","violation_code","violation","regulation"]}}},"required":["found","query","document_type","clear","summary","debts"]},"SatLimaAccountStatusResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SatLimaAccountStatusData"}}},"SatLimaCapturasData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the source returned a definitive verdict for the plate."},"plate":{"type":"string","description":"Echoes the searched plate (trimmed, uppercased)."},"has_capture_order":{"type":"boolean","description":"True when the plate has at least one capture order."},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own message when the plate has none."},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Report date (yyyy-mm-dd when parseable)."},"orders":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"description":"Capture orders, keyed by the source's own column headers. Empty when the plate is clear."}},"required":["found","plate","has_capture_order","message","report_date","orders"]},"SatLimaCapturasResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SatLimaCapturasData"}}},"RuntVehicleData":{"type":"object","properties":{"found":{"type":"boolean"},"plate":{"type":"string"},"vehicle":{"anyOf":[{"type":"object","properties":{"plate":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"service_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"vehicle_class":{"anyOf":[{"type":"string"},{"type":"null"}]},"classification":{"anyOf":[{"type":"string"},{"type":"null"}]},"body_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"line":{"anyOf":[{"type":"string"},{"type":"null"}]},"model_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"fuel_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"engine_displacement":{"anyOf":[{"type":"number"},{"type":"null"}]},"doors":{"anyOf":[{"type":"number"},{"type":"null"}]},"seated_passengers":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_passengers":{"anyOf":[{"type":"number"},{"type":"null"}]},"axle_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross_weight":{"anyOf":[{"type":"number"},{"type":"null"}]},"load_capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"vin":{"anyOf":[{"type":"string"},{"type":"null"}]},"engine_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"chassis_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"serial_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"traffic_license_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"traffic_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"country_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"enrollment_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"days_registered":{"anyOf":[{"type":"number"},{"type":"null"}]},"has_liens":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"has_pledges":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_repowered":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_classic":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_teaching_vehicle":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_state_security":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"engine_restamped":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"chassis_restamped":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"serial_restamped":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"vin_restamped":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["plate","registration_status","service_type","vehicle_class","classification","body_type","brand","line","model_year","color","fuel_type","engine_displacement","doors","seated_passengers","total_passengers","axle_count","gross_weight","load_capacity","vin","engine_number","chassis_number","serial_number","traffic_license_number","traffic_authority","country_name","registration_date","enrollment_date","days_registered","has_liens","has_pledges","is_repowered","is_classic","is_teaching_vehicle","is_state_security","engine_restamped","chassis_restamped","serial_restamped","vin_restamped"]},{"type":"null"}]},"soat_policies":{"type":"array","items":{"type":"object","properties":{"policy_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"insurer":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_current":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"anyOf":[{"type":"string"},{"type":"null"}]},"tariff_type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["policy_number","insurer","is_current","issue_date","start_date","expiry_date","origin","tariff_type"]}},"inspections":{"type":"array","items":{"type":"object","properties":{"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"center_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"inspection_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_current":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"plate":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["certificate_number","center_name","inspection_type","status","is_current","issue_date","expiry_date","plate"]}},"specifications":{"anyOf":[{"type":"object","properties":{"load_capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross_weight":{"anyOf":[{"type":"number"},{"type":"null"}]},"axle_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"tire_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"length":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_passengers":{"anyOf":[{"type":"number"},{"type":"null"}]},"seated_passengers":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["load_capacity","gross_weight","axle_count","tire_count","height","width","length","total_passengers","seated_passengers"]},{"type":"null"}]},"pledges":{"type":"array","items":{"type":"object","properties":{"creditor":{"anyOf":[{"type":"string"},{"type":"null"}]},"creditor_document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"creditor_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"trust_estate":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["creditor","creditor_document_type","creditor_document_number","registered_date","trust_estate"]}},"ownership_limitations":{"type":"array","items":{"type":"object","properties":{"limitation_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["limitation_type","document_number","legal_entity","department","municipality","issue_date","filing_date"]}},"armoring":{"anyOf":[{"type":"object","properties":{"is_armored":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"level":{"anyOf":[{"type":"string"},{"type":"null"}]},"level_number":{"anyOf":[{"type":"number"},{"type":"null"}]},"armored_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"dearmored_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"armoring_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"certificate_issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"authorization":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["is_armored","level","level_number","armored_date","dearmored_date","resolution_number","armoring_type","certificate_issue_date","authorization"]},{"type":"null"}]},"civil_liability":{"type":"array","items":{"type":"object","properties":{"policy_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"insurer":{"anyOf":[{"type":"string"},{"type":"null"}]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_current":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["policy_number","insurer","start_date","expiry_date","is_current"]}},"dijin_certificate":{"anyOf":[{"type":"object","properties":{"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuing_entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["certificate_number","issue_date","issuing_entity","status"]},{"type":"null"}]},"scrapping_certificate":{"anyOf":[{"type":"object","properties":{"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"scrapping_entity":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["certificate_number","status","issue_date","scrapping_entity"]},{"type":"null"}]},"normalization":{"type":"array","items":{"type":"object","properties":{"initial_registration_deficiency":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"normalized_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"date":{"anyOf":[{"type":"string"},{"type":"null"}]},"administrative_act_number":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["initial_registration_deficiency","normalized_status","date","administrative_act_number"]}},"scrapping":{"anyOf":[{"type":"object","properties":{"plate":{"anyOf":[{"type":"string"},{"type":"null"}]},"should_scrap":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["plate","should_scrap"]},{"type":"null"}]}},"required":["found","plate","vehicle","soat_policies","inspections","specifications","pledges","ownership_limitations","armoring","civil_liability","dijin_certificate","scrapping_certificate","normalization","scrapping"]},"RuntVehicleResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RuntVehicleData"}}},"RuntVehicleHistoryData":{"type":"object","properties":{"found":{"type":"boolean"},"plate":{"type":"string"},"vehicle":{"anyOf":[{"type":"object","properties":{"plate":{"anyOf":[{"type":"string"},{"type":"null"}]},"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"line":{"anyOf":[{"type":"string"},{"type":"null"}]},"model_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"body_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"vehicle_class":{"anyOf":[{"type":"string"},{"type":"null"}]},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"fuel_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"service_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"engine_displacement":{"anyOf":[{"type":"number"},{"type":"null"}]},"vin":{"anyOf":[{"type":"string"},{"type":"null"}]},"engine_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"chassis_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"serial_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_imported":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"clear_of_infractions":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"has_liens":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"has_limitations":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_auctioned":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["plate","brand","line","model_year","body_type","vehicle_class","color","fuel_type","service_type","engine_displacement","vin","engine_number","chassis_number","serial_number","registration_status","is_imported","clear_of_infractions","has_liens","has_limitations","is_auctioned"]},{"type":"null"}]},"owners":{"type":"array","items":{"type":"object","properties":{"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownership_start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownership_end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"owner_type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["document_type","name","document_number","ownership_start_date","ownership_end_date","owner_type"]}},"traffic_license":{"anyOf":[{"type":"object","properties":{"license_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"traffic_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"enrollment_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"license_status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["license_number","traffic_authority","enrollment_date","license_status"]},{"type":"null"}]},"import_record":{"anyOf":[{"type":"object","properties":{"import_record_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"import_record_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["import_record_number","import_record_date"]},{"type":"null"}]},"soat_policies":{"type":"array","items":{"type":"object","properties":{"policy_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"insurer":{"anyOf":[{"type":"string"},{"type":"null"}]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_current":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["policy_number","insurer","start_date","expiry_date","is_current"]}},"inspections":{"type":"array","items":{"type":"object","properties":{"inspection_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"center_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_current":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["inspection_type","issue_date","expiry_date","center_name","is_current"]}},"accident":{"anyOf":[{"type":"object","properties":{"accident_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"accident_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"accident_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"injured":{"anyOf":[{"type":"number"},{"type":"null"}]},"deaths":{"anyOf":[{"type":"number"},{"type":"null"}]},"victim_condition":{"anyOf":[{"type":"string"},{"type":"null"}]},"driver":{"anyOf":[{"type":"string"},{"type":"null"}]},"area":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["accident_number","accident_type","accident_date","injured","deaths","victim_condition","driver","area"]},{"type":"null"}]},"pending_procedures":{"type":"array","items":{"type":"object","properties":{"request_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["request_number","date","status","procedure","entity"]}},"guarantee":{"anyOf":[{"type":"object","properties":{"creditor":{"anyOf":[{"type":"string"},{"type":"null"}]},"creditor_document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"creditor_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"guarantee_type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["creditor","creditor_document_type","creditor_document_number","registered_date","guarantee_type"]},{"type":"null"}]},"limitation":{"anyOf":[{"type":"object","properties":{"limitation_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["limitation_type","entity","registered_date"]},{"type":"null"}]}},"required":["found","plate","vehicle","owners","traffic_license","import_record","soat_policies","inspections","accident","pending_procedures","guarantee","limitation"]},"RuntVehicleHistoryResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RuntVehicleHistoryData"}}},"ConsejoEstadoSearchData":{"type":"object","properties":{"seccion":{"type":"string","description":"Echo of the applied filter (empty string when omitted)."},"tipo":{"anyOf":[{"type":"string","const":""},{"type":"string","enum":["AUTO","CONCEPTO","SENTENCIA"]}]},"fecha_desde":{"type":"string"},"fecha_hasta":{"type":"string"},"numero_proceso":{"type":"string"},"ponente":{"type":"string"},"demandante":{"type":"string"},"demandado":{"type":"string"},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total records the source reports; null when not stated."},"page":{"type":"number"},"per_page":{"type":"number","description":"Requested page size. The source shows one record per view, so a page is assembled by stepping its record navigator; a deep page may return fewer rows than requested."},"count":{"type":"number","description":"Rows actually returned on this page."},"results":{"type":"array","items":{"type":"object","properties":{"radicado":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de proceso / radicado."},"tipo":{"anyOf":[{"type":"string","enum":["AUTO","CONCEPTO","SENTENCIA"]},{"type":"null"}]},"seccion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sección or sala that issued the providencia."},"fecha":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Providencia date, ISO yyyy-mm-dd when parseable."},"ponente":{"anyOf":[{"type":"string"},{"type":"null"}]},"demandante":{"anyOf":[{"type":"string"},{"type":"null"}]},"demandado":{"anyOf":[{"type":"string"},{"type":"null"}]},"norma_demandada":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Norma o acto demandado, when the row lists it."},"descriptores":{"type":"array","items":{"type":"string"},"description":"Descriptores / tema tags attached to the providencia."},"es_unificacion":{"type":"boolean","description":"True when the row is flagged as a sentencia de unificación."},"es_extension":{"type":"boolean","description":"True when the row is flagged as extensión de jurisprudencia."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public permalink to the full text. Feed this to the providencia lookup to retrieve `texto`. Null only when the row carries no registration number."}},"required":["radicado","tipo","seccion","fecha","ponente","demandante","demandado","norma_demandada","descriptores","es_unificacion","es_extension","url"]}}},"required":["seccion","tipo","fecha_desde","fecha_hasta","numero_proceso","ponente","demandante","demandado","total","page","per_page","count","results"]},"ConsejoEstadoSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ConsejoEstadoSearchData"}}},"ConsejoEstadoProvidenciaData":{"type":"object","properties":{"found":{"type":"boolean"},"url":{"type":"string","description":"The content permalink that was resolved."},"providencia":{"anyOf":[{"type":"object","properties":{"radicado":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de proceso / radicado."},"tipo":{"anyOf":[{"type":"string","enum":["AUTO","CONCEPTO","SENTENCIA"]},{"type":"null"}]},"seccion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sección or sala that issued the providencia."},"fecha":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Providencia date, ISO yyyy-mm-dd when parseable."},"ponente":{"anyOf":[{"type":"string"},{"type":"null"}]},"demandante":{"anyOf":[{"type":"string"},{"type":"null"}]},"demandado":{"anyOf":[{"type":"string"},{"type":"null"}]},"norma_demandada":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Norma o acto demandado, when the row lists it."},"descriptores":{"type":"array","items":{"type":"string"},"description":"Descriptores / tema tags attached to the providencia."},"es_unificacion":{"type":"boolean","description":"True when the row is flagged as a sentencia de unificación."},"es_extension":{"type":"boolean","description":"True when the row is flagged as extensión de jurisprudencia."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public permalink to the full text. Feed this to the providencia lookup to retrieve `texto`. Null only when the row carries no registration number."},"texto":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cleaned plain-text body; null when unavailable."}},"required":["radicado","tipo","seccion","fecha","ponente","demandante","demandado","norma_demandada","descriptores","es_unificacion","es_extension","url","texto"]},{"type":"null"}]}},"required":["found","url","providencia"]},"ConsejoEstadoProvidenciaResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ConsejoEstadoProvidenciaData"}}},"SicaacData":{"type":"object","properties":{"document_type":{"type":"string","enum":["CC","CE","TI","RC","PA","NIT","NA","NIE","DEC"],"description":"The queried document type, echoed back."},"document_type_label":{"type":"string","description":"Human label for the document type."},"document_number":{"type":"string","description":"The queried document number, echoed back."},"cases":{"type":"array","items":{"type":"object","properties":{"entity_name":{"type":"string","description":"The conciliation centre or entity handling the case."},"party_type":{"type":"string","description":"How the person takes part (e.g. \"Solicitante\")."},"request_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filing date (yyyy-mm-dd), or null when the source omits it."}},"required":["entity_name","party_type","request_date"]},"description":"Insolvency cases on record; empty when there are none."}},"required":["document_type","document_type_label","document_number","cases"]},"SicaacResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicaacData"}}},"StateDelinquentDebtorData":{"type":"object","properties":{"document_type":{"type":"string","enum":["CC","NIT","TI","CE","PA","RC","PPT"],"description":"The queried document type, echoed back."},"document_type_label":{"type":"string","description":"Human label for the document type."},"document_number":{"type":"string","description":"The queried document number, echoed back."},"reported":{"type":"boolean","description":"true if reported in EITHER section: the headline verdict."},"deudor_moroso":{"type":"object","properties":{"reported":{"type":"boolean","description":"true when the document IS reported in this section; false when clean."},"message":{"type":"string","description":"Verbatim message the source prints for this section."}},"required":["reported","message"],"description":"Deuda morosa con el Estado (Ley 901 de 2004): the core debtors register."},"incumplimiento_acuerdos":{"type":"object","properties":{"reported":{"type":"boolean","description":"true when the document IS reported in this section; false when clean."},"message":{"type":"string","description":"Verbatim message the source prints for this section."}},"required":["reported","message"],"description":"Incumplimiento de acuerdos de pago (Ley 1066 de 2006)."},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consultation timestamp from the source (ISO 8601 UTC), or null if absent."}},"required":["document_type","document_type_label","document_number","reported","deudor_moroso","incumplimiento_acuerdos","checked_at"]},"StateDelinquentDebtorResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/StateDelinquentDebtorData"}}},"RucData":{"type":"object","properties":{"found":{"type":"boolean"},"ruc":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"trade_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"activities_start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"condition":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"emission_system":{"anyOf":[{"type":"string"},{"type":"null"}]},"foreign_trade_activity":{"anyOf":[{"type":"string"},{"type":"null"}]},"accounting_system":{"anyOf":[{"type":"string"},{"type":"null"}]},"economic_activities":{"type":"array","items":{"type":"string"}},"payment_vouchers":{"type":"array","items":{"type":"string"}},"electronic_emission_systems":{"type":"array","items":{"type":"string"}},"electronic_emitter_since":{"anyOf":[{"type":"string"},{"type":"null"}]},"electronic_vouchers":{"anyOf":[{"type":"string"},{"type":"null"}]},"ple_affiliated_since":{"anyOf":[{"type":"string"},{"type":"null"}]},"registries":{"type":"array","items":{"type":"string"}}},"required":["found","ruc","name","type","document_type","document_number","trade_name","registration_date","activities_start_date","status","condition","fiscal_address","emission_system","foreign_trade_activity","accounting_system","economic_activities","payment_vouchers","electronic_emission_systems","electronic_emitter_since","electronic_vouchers","ple_affiliated_since","registries"]},"RucResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RucData"}}},"SunatNameData":{"type":"object","properties":{"query":{"type":"string"},"count":{"type":"number"},"capped":{"type":"boolean"},"contributors":{"type":"array","items":{"type":"object","properties":{"ruc":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"location":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["ruc","name","location","status"]}}},"required":["query","count","capped","contributors"]},"SunatNameResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunatNameData"}}},"OeceProcessesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"buyer_ruc":{"anyOf":[{"type":"string"},{"type":"null"}]},"supplier_ruc":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"method":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_after":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Processes matching the filters, across every page."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"processes":{"type":"array","items":{"type":"object","properties":{"ocid":{"type":"string"},"source":{"anyOf":[{"type":"string"},{"type":"null"}]},"tender_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"buyer":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's party id (`PE-CONSUCODE-<code>` for entities, `PE-RUC-<ruc>` for companies)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"ruc":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"11-digit RUC when the party carries one."}},"required":["id","name","ruc"]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"procurement_method_details":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 4217, usually `PEN`."},"amount_pen":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The amount in soles, as the source converts it."}},"required":["amount","currency","amount_pen"]},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status_details":{"type":"array","items":{"type":"string"}},"award_count":{"type":"number"},"contract_count":{"type":"number"},"awarded_amount_pen":{"anyOf":[{"type":"number"},{"type":"null"}]},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's party id (`PE-CONSUCODE-<code>` for entities, `PE-RUC-<ruc>` for companies)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"ruc":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"11-digit RUC when the party carries one."}},"required":["id","name","ruc"]}},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["ocid","source","tender_id","title","description","buyer","department","procurement_method_details","category","value","published_date","status_details","award_count","contract_count","awarded_amount_pen","suppliers","updated_at"]}}},"required":["as_of","query","buyer_ruc","supplier_ruc","department","category","method","from_date","to_date","updated_after","total","page","per_page","total_pages","count","processes"]},"OeceProcessesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/OeceProcessesSearchData"}}},"OeceProcessData":{"type":"object","properties":{"found":{"type":"boolean"},"ocid":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"process":{"anyOf":[{"type":"object","properties":{"ocid":{"type":"string","description":"OCDS process id, the stable key."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which SEACE generation published it (`seace_v2`, `seace_v3`)."},"tender_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure's nomenclature, e.g. `AS-SM-18-2022-EGESUR-2`."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The object of the procurement."},"buyer":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's entity id (`PE-CONSUCODE-<code>`)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"ruc":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's 11-digit RUC."}},"required":["id","name","ruc"]},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The buyer's department (región), e.g. `LIMA`."},"procurement_method":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"OCDS method (`open`, `direct`, `selective`)."},"procurement_method_details":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure type as the source names it (`Licitación Pública`, `Adjudicación Simplificada`, ...)."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`goods`, `services` or `works`."},"additional_categories":{"type":"array","items":{"type":"string"}},"value":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 4217, usually `PEN`."},"amount_pen":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The estimated value in soles, as the source converts it."}},"required":["amount","currency","amount_pen"]},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the procedure was published (convocatoria)."},"tender_start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"tender_end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"number_of_tenderers":{"anyOf":[{"type":"number"},{"type":"null"}]},"status_details":{"type":"array","items":{"type":"string"},"description":"Distinct stages across the items, as the source names them."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"classification_scheme":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`CUBSO` (Peru's catalogue) or `UNSPSC`."},"classification_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"classification":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"OCDS item status (`active`, `complete`, `unsuccessful`, `cancelled`)."},"status_details":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own stage for the item (`CONVOCADO`, `ADJUDICADO`, `CONTRATADO`, `DESIERTO`, `NULO`, ...)."}},"required":["id","description","quantity","unit","classification_scheme","classification_id","classification","status","status_details"]}},"items_capped":{"type":"boolean"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"OCDS document type (`biddingDocuments`, `awardNotice`, `clarifications`, `evaluationReports`)."},"format":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"modified_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","title","type","format","url","published_date","modified_date"]}},"documents_capped":{"type":"boolean"},"awards":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"date":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 4217, usually `PEN`."},"amount_pen":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The amount in soles, as the source converts it."}},"required":["amount","currency","amount_pen"]},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's party id (`PE-CONSUCODE-<code>` for entities, `PE-RUC-<ruc>` for companies)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"ruc":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"11-digit RUC when the party carries one."}},"required":["id","name","ruc"]}},"item_count":{"type":"number"}},"required":["id","date","value","suppliers","item_count"]}},"contracts":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"award_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"date_signed":{"anyOf":[{"type":"string"},{"type":"null"}]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"status_details":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 4217, usually `PEN`."},"amount_pen":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The amount in soles, as the source converts it."}},"required":["amount","currency","amount_pen"]}},"required":["id","award_id","title","description","date_signed","start_date","end_date","status","status_details","value"]}},"award_count":{"type":"number"},"contract_count":{"type":"number"},"awarded_amount_pen":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Sum of the awards in soles; null when nothing was awarded."},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's party id (`PE-CONSUCODE-<code>` for entities, `PE-RUC-<ruc>` for companies)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"ruc":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"11-digit RUC when the party carries one."}},"required":["id","name","ruc"]},"description":"Distinct awarded suppliers."},"supplier_rucs":{"type":"array","items":{"type":"string"},"description":"RUCs of the awarded suppliers."},"segment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's publication month (`yyyy-mm`)."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the source last modified the record (ISO timestamp)."}},"required":["ocid","source","tender_id","title","description","buyer","department","procurement_method","procurement_method_details","category","additional_categories","value","published_date","tender_start_date","tender_end_date","number_of_tenderers","status_details","items","items_capped","documents","documents_capped","awards","contracts","award_count","contract_count","awarded_amount_pen","suppliers","supplier_rucs","segment","updated_at"]},{"type":"null"}]}},"required":["found","ocid","as_of","process"]},"OeceProcessResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/OeceProcessData"}}},"SunbizEntitiesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"name_prefix":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_after":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Entities matching the filters, across every page."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"entities":{"type":"array","items":{"type":"object","properties":{"document_number":{"type":"string","description":"The registry's own key for the entity, e.g. `P26000044030`. Its letter says what was filed (`P` profit corporation, `L` Florida LLC, `M` foreign LLC, `N` nonprofit, `F` foreign corporation, ...)."},"name":{"type":"string","description":"The entity's name as registered."},"status":{"type":"string","enum":["active","inactive"],"description":"`active` or `inactive`."},"filing_type":{"type":"string","description":"What was filed: `florida_llc`, `foreign_llc`, `domestic_profit`, `foreign_profit`, `domestic_nonprofit`, `foreign_nonprofit`, `domestic_limited_partnership`, `foreign_limited_partnership`, `nonprofit_registration`, `trust` or `registered_agent_designation`."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the entity was formed: `FL` for a Florida entity, another state's code, or a country code for one formed abroad."},"principal_address":{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City of the principal address, as the registry prints it."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State of the principal address."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`12345` or `12345-6789`; a foreign postal code as printed."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter country code when the registry prints one."}},"required":["line_1","line_2","city","state","zip","country"]},"mailing_address":{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state code, as the registry prints it."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`12345` or `12345-6789`; a foreign postal code as printed."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter country code when the registry prints one."}},"required":["line_1","line_2","city","state","zip","country"]},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the formation or registration filing; an entity filed with a delayed effective date carries that later date, which can be months ahead."},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Federal Employer Identification Number, nine digits, when the entity reported one."},"last_transaction_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the last filing the registry recorded on the entity."},"annual_reports":{"type":"array","items":{"type":"object","properties":{"year":{"type":"integer"},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["year","filed_on"]},"description":"The last three annual reports: the report year and the date it was filed."},"registered_agent":{"anyOf":[{"type":"object","properties":{"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}],"description":"Whether the registry lists a person or a company."},"name":{"type":"string","description":"The registered agent's name as one string; the search reaches it."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only; often an initial."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"address":{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","city","state","zip"]}},"required":["kind","name","first_name","middle_name","last_name","address"]},{"type":"null"}]},"officers":{"type":"array","items":{"type":"object","properties":{"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}],"description":"Whether the registry lists a person or a company."},"name":{"type":"string","description":"The name as one string: `FIRST MIDDLE LAST` for a person, the company name otherwise."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only; often an initial."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"address":{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","city","state","zip"]},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office as the registry abbreviates it: `P` (president), `VP`, `MGR` (manager), `AMBR` (authorized member), `MBR`, `D` (director), `T`, `S`, `CEO`, `AR`, ..."}},"required":["kind","name","first_name","middle_name","last_name","address","title"]},"description":"Up to six officers, directors, managers or members, as the registry lists them."},"officer_names":{"type":"array","items":{"type":"string"},"description":"Every officer's name; the search reaches them."},"more_than_six_officers":{"type":"boolean","description":"The registry lists more officers than the six it publishes here."},"updated_at":{"type":"string","description":"When the registry published the state this record reflects (ISO timestamp)."}},"required":["document_number","name","status","filing_type","jurisdiction","principal_address","mailing_address","filed_on","fei_number","last_transaction_on","annual_reports","registered_agent","officers","officer_names","more_than_six_officers","updated_at"]}}},"required":["as_of","query","name_prefix","status","filing_type","city","state","fei_number","filed_from","filed_to","updated_after","total","page","per_page","total_pages","count","entities"]},"SunbizEntitiesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunbizEntitiesSearchData"}}},"SunbizEntityData":{"type":"object","properties":{"found":{"type":"boolean"},"document_number":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"entity":{"anyOf":[{"type":"object","properties":{"document_number":{"type":"string","description":"The registry's own key for the entity, e.g. `P26000044030`. Its letter says what was filed (`P` profit corporation, `L` Florida LLC, `M` foreign LLC, `N` nonprofit, `F` foreign corporation, ...)."},"name":{"type":"string","description":"The entity's name as registered."},"status":{"type":"string","enum":["active","inactive"],"description":"`active` or `inactive`."},"filing_type":{"type":"string","description":"What was filed: `florida_llc`, `foreign_llc`, `domestic_profit`, `foreign_profit`, `domestic_nonprofit`, `foreign_nonprofit`, `domestic_limited_partnership`, `foreign_limited_partnership`, `nonprofit_registration`, `trust` or `registered_agent_designation`."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the entity was formed: `FL` for a Florida entity, another state's code, or a country code for one formed abroad."},"principal_address":{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City of the principal address, as the registry prints it."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State of the principal address."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`12345` or `12345-6789`; a foreign postal code as printed."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter country code when the registry prints one."}},"required":["line_1","line_2","city","state","zip","country"]},"mailing_address":{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state code, as the registry prints it."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`12345` or `12345-6789`; a foreign postal code as printed."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter country code when the registry prints one."}},"required":["line_1","line_2","city","state","zip","country"]},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the formation or registration filing; an entity filed with a delayed effective date carries that later date, which can be months ahead."},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Federal Employer Identification Number, nine digits, when the entity reported one."},"last_transaction_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the last filing the registry recorded on the entity."},"annual_reports":{"type":"array","items":{"type":"object","properties":{"year":{"type":"integer"},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["year","filed_on"]},"description":"The last three annual reports: the report year and the date it was filed."},"registered_agent":{"anyOf":[{"type":"object","properties":{"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}],"description":"Whether the registry lists a person or a company."},"name":{"type":"string","description":"The registered agent's name as one string; the search reaches it."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only; often an initial."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"address":{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","city","state","zip"]}},"required":["kind","name","first_name","middle_name","last_name","address"]},{"type":"null"}]},"officers":{"type":"array","items":{"type":"object","properties":{"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}],"description":"Whether the registry lists a person or a company."},"name":{"type":"string","description":"The name as one string: `FIRST MIDDLE LAST` for a person, the company name otherwise."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only; often an initial."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"address":{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","city","state","zip"]},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office as the registry abbreviates it: `P` (president), `VP`, `MGR` (manager), `AMBR` (authorized member), `MBR`, `D` (director), `T`, `S`, `CEO`, `AR`, ..."}},"required":["kind","name","first_name","middle_name","last_name","address","title"]},"description":"Up to six officers, directors, managers or members, as the registry lists them."},"officer_names":{"type":"array","items":{"type":"string"},"description":"Every officer's name; the search reaches them."},"more_than_six_officers":{"type":"boolean","description":"The registry lists more officers than the six it publishes here."},"updated_at":{"type":"string","description":"When the registry published the state this record reflects (ISO timestamp)."}},"required":["document_number","name","status","filing_type","jurisdiction","principal_address","mailing_address","filed_on","fei_number","last_transaction_on","annual_reports","registered_agent","officers","officer_names","more_than_six_officers","updated_at"]},{"type":"null"}]}},"required":["found","document_number","as_of","entity"]},"SunbizEntityResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunbizEntityData"}}},"SecFormDSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"issuer_cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"industry":{"anyOf":[{"type":"string"},{"type":"null"}]},"fund_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"funds":{"type":"string"},"form_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_amount_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"type":"number","description":"Filings matching the filters, across every page."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"filings":{"type":"array","items":{"type":"object","properties":{"accession_number":{"type":"string","description":"EDGAR's accession number, e.g. `0001587468-26-000001`: the key of the filing."},"form_type":{"type":"string","enum":["D","D/A"],"description":"`D` for a new notice, `D/A` for an amendment to one."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC file number of the offering, shared by a notice and its amendments."},"sic_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer's SIC code, when EDGAR carries one."},"issuer":{"type":"object","properties":{"cik":{"type":"string","description":"The issuer's EDGAR Central Index Key, without leading zeros. One CIK, every filing of that issuer."},"name":{"type":"string","description":"The issuer's name as filed."},"previous_names":{"type":"array","items":{"type":"string"},"description":"Names the issuer filed under before."},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Corporation`, `Limited Liability Company`, `Limited Partnership`, `Business Trust`, `General Partnership` or `Other`."},"entity_type_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"incorporated":{"type":"object","properties":{"span":{"anyOf":[{"type":"string","enum":["within_five_years","over_five_years","yet_to_be_formed"]},{"type":"null"}],"description":"How long ago the issuer was formed, as the form asks it."},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The year of formation, given only when within the last five years."}},"required":["span","year"]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or country of incorporation as the form spells it: `DELAWARE`, `CAYMAN ISLANDS`, ..."},"address":{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state of the issuer's address, or the form's code for a country."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["cik","name","previous_names","entity_type","entity_type_other","incorporated","jurisdiction","address","phone"]},"co_issuers":{"type":"array","items":{"type":"object","properties":{"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["cik","name","entity_type","jurisdiction"]},"description":"Other issuers on the same notice, when the offering has several."},"industry_group":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The industry group the filer picked, as the form names it: `Other Technology`, `Biotechnology`, `Pooled Investment Fund`, `Commercial`, ..."},"is_pooled_investment_fund":{"type":"boolean","description":"The issuer is a fund raising from investors, not an operating company."},"investment_fund_type":{"anyOf":[{"type":"string","enum":["venture_capital_fund","private_equity_fund","hedge_fund","other_investment_fund"]},{"type":"null"}],"description":"For a fund, which kind."},"is_40_act_fund":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the fund is registered under the Investment Company Act of 1940."},"revenue_range":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer's revenue bracket as the form offers it, or `Decline to Disclose`."},"aggregate_net_asset_value_range":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a fund, its net asset value bracket, or `Decline to Disclose`."},"federal_exemptions":{"type":"array","items":{"type":"string"},"description":"The exemptions claimed: `06b` (Rule 506(b)), `06c` (Rule 506(c)), `04` (Rule 504), `3C`, `3C.1`, `3C.7`, ..."},"is_amendment":{"type":"boolean"},"previous_accession_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an amendment, the filing it amends."},"first_sale_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the first sale in the offering; null when it has yet to occur."},"first_sale_yet_to_occur":{"type":"boolean"},"more_than_one_year":{"type":"boolean","description":"The offering is intended to last more than a year."},"securities":{"type":"object","properties":{"equity":{"type":"boolean"},"debt":{"type":"boolean"},"option_or_warrant":{"type":"boolean"},"security_to_be_acquired":{"type":"boolean"},"pooled_investment_fund_interests":{"type":"boolean"},"tenant_in_common":{"type":"boolean"},"mineral_property":{"type":"boolean"},"other":{"type":"boolean"},"other_description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["equity","debt","option_or_warrant","security_to_be_acquired","pooled_investment_fund_interests","tenant_in_common","mineral_property","other","other_description"]},"is_business_combination":{"type":"boolean"},"business_combination_note":{"anyOf":[{"type":"string"},{"type":"null"}]},"minimum_investment":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The minimum accepted from an outside investor, US dollars."},"offering":{"type":"object","properties":{"total_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The total offering amount, US dollars; null when the filer marked it indefinite."},"total_amount_indefinite":{"type":"boolean"},"amount_sold":{"type":"number","column":"number","description":"US dollars sold so far in the offering. On an amendment, the running total."},"remaining":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars left to sell; null when indefinite."},"remaining_indefinite":{"type":"boolean"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filer's clarification of the amounts, when given."}},"required":["total_amount","total_amount_indefinite","amount_sold","remaining","remaining_indefinite","note"]},"investors":{"type":"object","properties":{"has_non_accredited":{"type":"boolean"},"non_accredited_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_count":{"type":"number","description":"Investors who have already invested in the offering."}},"required":["has_non_accredited","non_accredited_count","total_count"]},"sales_commissions":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars."},"is_estimate":{"type":"boolean"}},"required":["amount","is_estimate"]},"finders_fees":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars."},"is_estimate":{"type":"boolean"}},"required":["amount","is_estimate"]},"proceeds_to_related_persons":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars."},"is_estimate":{"type":"boolean"},"note":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["amount","is_estimate","note"],"description":"Gross proceeds used to pay the executives, directors or promoters listed."},"related_persons":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"`FIRST MIDDLE LAST` as one string."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"relationships":{"type":"array","items":{"type":"string"},"description":"`Executive Officer`, `Director` and/or `Promoter`, as the form lists them."},"clarification":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filer's own note on the relationship, when given."},"address":{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state, or the form's code for a country."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]}},"required":["name","first_name","middle_name","last_name","relationships","clarification","address"]},"description":"The executives, directors and promoters the notice lists."},"related_person_names":{"type":"array","items":{"type":"string"},"description":"Every related person's name, for search."},"recipients":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who was paid to sell the offering (a broker, a placement agent)."},"crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"broker_dealer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"broker_dealer_crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"states":{"type":"array","items":{"type":"string"},"description":"States solicited, or `All States`."},"foreign_solicitation":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"address":{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state, or the form's code for a country."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]}},"required":["name","crd_number","broker_dealer_name","broker_dealer_crd_number","states","foreign_solicitation","address"]},"description":"Who was paid sales compensation for the offering."},"signature":{"anyOf":[{"type":"object","properties":{"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"signer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"signed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`."}},"required":["issuer_name","signer_name","title","signed_on"]},{"type":"null"}]},"filing_url":{"type":"string","description":"Where the filing sits on EDGAR."}},"required":["accession_number","form_type","filed_on","file_number","sic_code","issuer","co_issuers","industry_group","is_pooled_investment_fund","investment_fund_type","is_40_act_fund","revenue_range","aggregate_net_asset_value_range","federal_exemptions","is_amendment","previous_accession_number","first_sale_on","first_sale_yet_to_occur","more_than_one_year","securities","is_business_combination","business_combination_note","minimum_investment","offering","investors","sales_commissions","finders_fees","proceeds_to_related_persons","related_persons","related_person_names","recipients","signature","filing_url"]}}},"required":["as_of","query","issuer_cik","state","jurisdiction","industry","fund_type","funds","form_type","filed_from","filed_to","min_amount_sold","total","page","per_page","total_pages","count","filings"]},"SecFormDSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecFormDSearchData"}}},"SecFormDFilingData":{"type":"object","properties":{"found":{"type":"boolean"},"accession_number":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"filing":{"anyOf":[{"type":"object","properties":{"accession_number":{"type":"string","description":"EDGAR's accession number, e.g. `0001587468-26-000001`: the key of the filing."},"form_type":{"type":"string","enum":["D","D/A"],"description":"`D` for a new notice, `D/A` for an amendment to one."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC file number of the offering, shared by a notice and its amendments."},"sic_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer's SIC code, when EDGAR carries one."},"issuer":{"type":"object","properties":{"cik":{"type":"string","description":"The issuer's EDGAR Central Index Key, without leading zeros. One CIK, every filing of that issuer."},"name":{"type":"string","description":"The issuer's name as filed."},"previous_names":{"type":"array","items":{"type":"string"},"description":"Names the issuer filed under before."},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Corporation`, `Limited Liability Company`, `Limited Partnership`, `Business Trust`, `General Partnership` or `Other`."},"entity_type_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"incorporated":{"type":"object","properties":{"span":{"anyOf":[{"type":"string","enum":["within_five_years","over_five_years","yet_to_be_formed"]},{"type":"null"}],"description":"How long ago the issuer was formed, as the form asks it."},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The year of formation, given only when within the last five years."}},"required":["span","year"]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or country of incorporation as the form spells it: `DELAWARE`, `CAYMAN ISLANDS`, ..."},"address":{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state of the issuer's address, or the form's code for a country."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["cik","name","previous_names","entity_type","entity_type_other","incorporated","jurisdiction","address","phone"]},"co_issuers":{"type":"array","items":{"type":"object","properties":{"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["cik","name","entity_type","jurisdiction"]},"description":"Other issuers on the same notice, when the offering has several."},"industry_group":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The industry group the filer picked, as the form names it: `Other Technology`, `Biotechnology`, `Pooled Investment Fund`, `Commercial`, ..."},"is_pooled_investment_fund":{"type":"boolean","description":"The issuer is a fund raising from investors, not an operating company."},"investment_fund_type":{"anyOf":[{"type":"string","enum":["venture_capital_fund","private_equity_fund","hedge_fund","other_investment_fund"]},{"type":"null"}],"description":"For a fund, which kind."},"is_40_act_fund":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the fund is registered under the Investment Company Act of 1940."},"revenue_range":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer's revenue bracket as the form offers it, or `Decline to Disclose`."},"aggregate_net_asset_value_range":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a fund, its net asset value bracket, or `Decline to Disclose`."},"federal_exemptions":{"type":"array","items":{"type":"string"},"description":"The exemptions claimed: `06b` (Rule 506(b)), `06c` (Rule 506(c)), `04` (Rule 504), `3C`, `3C.1`, `3C.7`, ..."},"is_amendment":{"type":"boolean"},"previous_accession_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an amendment, the filing it amends."},"first_sale_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the first sale in the offering; null when it has yet to occur."},"first_sale_yet_to_occur":{"type":"boolean"},"more_than_one_year":{"type":"boolean","description":"The offering is intended to last more than a year."},"securities":{"type":"object","properties":{"equity":{"type":"boolean"},"debt":{"type":"boolean"},"option_or_warrant":{"type":"boolean"},"security_to_be_acquired":{"type":"boolean"},"pooled_investment_fund_interests":{"type":"boolean"},"tenant_in_common":{"type":"boolean"},"mineral_property":{"type":"boolean"},"other":{"type":"boolean"},"other_description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["equity","debt","option_or_warrant","security_to_be_acquired","pooled_investment_fund_interests","tenant_in_common","mineral_property","other","other_description"]},"is_business_combination":{"type":"boolean"},"business_combination_note":{"anyOf":[{"type":"string"},{"type":"null"}]},"minimum_investment":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The minimum accepted from an outside investor, US dollars."},"offering":{"type":"object","properties":{"total_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The total offering amount, US dollars; null when the filer marked it indefinite."},"total_amount_indefinite":{"type":"boolean"},"amount_sold":{"type":"number","column":"number","description":"US dollars sold so far in the offering. On an amendment, the running total."},"remaining":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars left to sell; null when indefinite."},"remaining_indefinite":{"type":"boolean"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filer's clarification of the amounts, when given."}},"required":["total_amount","total_amount_indefinite","amount_sold","remaining","remaining_indefinite","note"]},"investors":{"type":"object","properties":{"has_non_accredited":{"type":"boolean"},"non_accredited_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_count":{"type":"number","description":"Investors who have already invested in the offering."}},"required":["has_non_accredited","non_accredited_count","total_count"]},"sales_commissions":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars."},"is_estimate":{"type":"boolean"}},"required":["amount","is_estimate"]},"finders_fees":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars."},"is_estimate":{"type":"boolean"}},"required":["amount","is_estimate"]},"proceeds_to_related_persons":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars."},"is_estimate":{"type":"boolean"},"note":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["amount","is_estimate","note"],"description":"Gross proceeds used to pay the executives, directors or promoters listed."},"related_persons":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"`FIRST MIDDLE LAST` as one string."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"relationships":{"type":"array","items":{"type":"string"},"description":"`Executive Officer`, `Director` and/or `Promoter`, as the form lists them."},"clarification":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filer's own note on the relationship, when given."},"address":{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state, or the form's code for a country."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]}},"required":["name","first_name","middle_name","last_name","relationships","clarification","address"]},"description":"The executives, directors and promoters the notice lists."},"related_person_names":{"type":"array","items":{"type":"string"},"description":"Every related person's name, for search."},"recipients":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who was paid to sell the offering (a broker, a placement agent)."},"crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"broker_dealer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"broker_dealer_crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"states":{"type":"array","items":{"type":"string"},"description":"States solicited, or `All States`."},"foreign_solicitation":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"address":{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state, or the form's code for a country."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]}},"required":["name","crd_number","broker_dealer_name","broker_dealer_crd_number","states","foreign_solicitation","address"]},"description":"Who was paid sales compensation for the offering."},"signature":{"anyOf":[{"type":"object","properties":{"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"signer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"signed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`."}},"required":["issuer_name","signer_name","title","signed_on"]},{"type":"null"}]},"filing_url":{"type":"string","description":"Where the filing sits on EDGAR."}},"required":["accession_number","form_type","filed_on","file_number","sic_code","issuer","co_issuers","industry_group","is_pooled_investment_fund","investment_fund_type","is_40_act_fund","revenue_range","aggregate_net_asset_value_range","federal_exemptions","is_amendment","previous_accession_number","first_sale_on","first_sale_yet_to_occur","more_than_one_year","securities","is_business_combination","business_combination_note","minimum_investment","offering","investors","sales_commissions","finders_fees","proceeds_to_related_persons","related_persons","related_person_names","recipients","signature","filing_url"]},{"type":"null"}]}},"required":["found","accession_number","as_of","filing"]},"SecFormDFilingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecFormDFilingData"}}},"DelawareEntitiesSearchData":{"type":"object","properties":{"query":{"type":"string","description":"The queried name, echoed back."},"exact":{"type":"boolean","description":"Whether the match was exact, echoed back."},"count":{"type":"integer","description":"Entities in this response."},"truncated":{"type":"boolean","description":"true when the Division stopped at its 50-result limit: more entities match, refine the query."},"entities":{"type":"array","items":{"type":"object","properties":{"file_number":{"type":"string","description":"The Division's file number for the entity, e.g. `3582691`. Pass it to the lookup."},"name":{"type":"string","description":"The entity's name as registered."}},"required":["file_number","name"]},"description":"Matching entities, alphabetical by name; empty when none match."},"checked_at":{"type":"string","description":"When this answer was read from the Division, as an ISO timestamp."}},"required":["query","exact","count","truncated","entities","checked_at"]},"DelawareEntitiesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DelawareEntitiesSearchData"}}},"DelawareEntityData":{"type":"object","properties":{"found":{"type":"boolean","description":"false when the Division has no entity under this file number."},"file_number":{"type":"string","description":"The queried file number, echoed back."},"entity":{"anyOf":[{"type":"object","properties":{"file_number":{"type":"string","description":"The Division's file number, the entity's key."},"name":{"type":"string","description":"The entity's name as registered."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Division prints as the incorporation or formation date."},"entity_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As the Division classifies it: `Corporation`, `Limited Liability Company`, `Limited Partnership`, `Statutory Trust`, `Partnership`, `Registered Series`, ..."},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Division's sub-type: `General`, `Bank`, `Benefit Corporation`, `Closed Corp`, `Exempt`, `Series`, ..."},"residency":{"anyOf":[{"type":"string","enum":["domestic","foreign"]},{"type":"null"}],"description":"`domestic` when formed in Delaware, `foreign` when formed elsewhere and registered in Delaware."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State of formation as the Division prints it, e.g. `DELAWARE`, `CALIFORNIA`."},"registered_agent":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registered agent's name as the Division prints it."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Street address of the registered office."},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Delaware county of the registered office, e.g. `New Castle`."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state code, normally `DE`."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As printed, e.g. `302-636-5401`."}},"required":["name","address","city","county","state","postal_code","phone"]},{"type":"null"}],"description":"The registered agent on file, or null when the Division lists none."}},"required":["file_number","name","filed_on","entity_kind","entity_type","residency","state","registered_agent"]},{"type":"null"}]},"checked_at":{"type":"string","description":"When this answer was read from the Division, as an ISO timestamp."}},"required":["found","file_number","entity","checked_at"]},"DelawareEntityResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DelawareEntityData"}}},"IapdAdvisersSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"firm_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"private_funds":{"type":"string"},"min_aum":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"type":"number","description":"Advisers matching the filters, across every page."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"advisers":{"type":"array","items":{"type":"object","properties":{"crd":{"type":"string","description":"The firm's CRD number, the id the SEC and FINRA share for it: the key."},"sec_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`801-…` for a registered adviser, `802-…` for an exempt reporting adviser."},"legal_name":{"type":"string","description":"The firm's legal name as filed."},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name the firm does business under, when it differs from the legal name."},"firm_type":{"type":"string","enum":["registered","exempt_reporting"],"description":"`registered` (Form ADV registration with the SEC) or `exempt_reporting` (files Form ADV as an exempt reporting adviser, the venture capital and private fund adviser exemptions)."},"status":{"type":"string","description":"The SEC status as the source spells it: `APPROVED`, `ACTIVE`, `120-DAY APPROVAL`, ..."},"status_since":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the status took effect."},"latest_filing_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the firm's latest Form ADV filing."},"form_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Form ADV version the latest filing used, e.g. `10/2021`."},"main_office":{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state of the principal office, when in the US."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country of the principal office as the form spells it, e.g. `United States`, `United Kingdom`."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","country","postal_code"]},"mailing_office":{"anyOf":[{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state, when in the US."},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","country","postal_code"]},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"fax":{"anyOf":[{"type":"string"},{"type":"null"}]},"websites":{"type":"array","items":{"type":"string"},"description":"Every website the firm lists."},"organization_form":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Limited Liability Company`, `Corporation`, `Limited Partnership`, ..."},"organized_in_state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state of organization, when in the US."},"organized_in_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_year_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The month the fiscal year ends, as the form spells it: `DECEMBER`."},"employees":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Item 5.A: how many employees, including clerical. Null for exempt reporting advisers, which do not answer Item 5."},"aum":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Regulatory assets under management, US dollars (Item 5.F). Null for exempt reporting advisers."},"discretionary":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_discretionary":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Accounts managed, in total."},"accounts_discretionary":{"anyOf":[{"type":"integer"},{"type":"null"}]},"accounts_non_discretionary":{"anyOf":[{"type":"integer"},{"type":"null"}]}},"required":["total","discretionary","non_discretionary","accounts","accounts_discretionary","accounts_non_discretionary"]},"has_private_funds":{"type":"boolean","description":"Item 7.B: the firm advises one or more private funds. Their rows are in the private funds dataset."},"umbrella_registration":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The filing covers relying advisers under one registration."},"notice_filed_states":{"type":"array","items":{"type":"string"},"description":"Two-letter states where the firm has a notice filing."},"has_disclosures":{"type":"boolean","description":"Item 11: the firm or its affiliates report a criminal, regulatory or civil judicial event."},"sec_region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC regional office code that oversees the firm, e.g. `SFRO`, `NYRO`, `HQ`."}},"required":["crd","sec_number","legal_name","business_name","firm_type","status","status_since","latest_filing_on","form_version","main_office","mailing_office","phone","fax","websites","organization_form","organized_in_state","organized_in_country","fiscal_year_end","employees","aum","has_private_funds","umbrella_registration","notice_filed_states","has_disclosures","sec_region"]}}},"required":["as_of","query","firm_type","state","country","private_funds","min_aum","total","page","per_page","total_pages","count","advisers"]},"IapdAdvisersSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IapdAdvisersSearchData"}}},"IapdAdviserData":{"type":"object","properties":{"found":{"type":"boolean"},"crd":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"adviser":{"anyOf":[{"type":"object","properties":{"crd":{"type":"string","description":"The firm's CRD number, the id the SEC and FINRA share for it: the key."},"sec_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`801-…` for a registered adviser, `802-…` for an exempt reporting adviser."},"legal_name":{"type":"string","description":"The firm's legal name as filed."},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name the firm does business under, when it differs from the legal name."},"firm_type":{"type":"string","enum":["registered","exempt_reporting"],"description":"`registered` (Form ADV registration with the SEC) or `exempt_reporting` (files Form ADV as an exempt reporting adviser, the venture capital and private fund adviser exemptions)."},"status":{"type":"string","description":"The SEC status as the source spells it: `APPROVED`, `ACTIVE`, `120-DAY APPROVAL`, ..."},"status_since":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the status took effect."},"latest_filing_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the firm's latest Form ADV filing."},"form_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Form ADV version the latest filing used, e.g. `10/2021`."},"main_office":{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state of the principal office, when in the US."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country of the principal office as the form spells it, e.g. `United States`, `United Kingdom`."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","country","postal_code"]},"mailing_office":{"anyOf":[{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state, when in the US."},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","country","postal_code"]},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"fax":{"anyOf":[{"type":"string"},{"type":"null"}]},"websites":{"type":"array","items":{"type":"string"},"description":"Every website the firm lists."},"organization_form":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Limited Liability Company`, `Corporation`, `Limited Partnership`, ..."},"organized_in_state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state of organization, when in the US."},"organized_in_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_year_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The month the fiscal year ends, as the form spells it: `DECEMBER`."},"employees":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Item 5.A: how many employees, including clerical. Null for exempt reporting advisers, which do not answer Item 5."},"aum":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Regulatory assets under management, US dollars (Item 5.F). Null for exempt reporting advisers."},"discretionary":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_discretionary":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Accounts managed, in total."},"accounts_discretionary":{"anyOf":[{"type":"integer"},{"type":"null"}]},"accounts_non_discretionary":{"anyOf":[{"type":"integer"},{"type":"null"}]}},"required":["total","discretionary","non_discretionary","accounts","accounts_discretionary","accounts_non_discretionary"]},"has_private_funds":{"type":"boolean","description":"Item 7.B: the firm advises one or more private funds. Their rows are in the private funds dataset."},"umbrella_registration":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The filing covers relying advisers under one registration."},"notice_filed_states":{"type":"array","items":{"type":"string"},"description":"Two-letter states where the firm has a notice filing."},"has_disclosures":{"type":"boolean","description":"Item 11: the firm or its affiliates report a criminal, regulatory or civil judicial event."},"sec_region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC regional office code that oversees the firm, e.g. `SFRO`, `NYRO`, `HQ`."}},"required":["crd","sec_number","legal_name","business_name","firm_type","status","status_since","latest_filing_on","form_version","main_office","mailing_office","phone","fax","websites","organization_form","organized_in_state","organized_in_country","fiscal_year_end","employees","aum","has_private_funds","umbrella_registration","notice_filed_states","has_disclosures","sec_region"]},{"type":"null"}]},"private_funds":{"anyOf":[{"type":"object","properties":{"total":{"type":"number","description":"Private funds the adviser currently reports."},"gross_asset_value":{"type":"number","description":"Their gross asset values added up, US dollars."},"by_type":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"count":{"type":"number"},"gross_asset_value":{"type":"number"}},"required":["count","gross_asset_value"]},"description":"The same, per fund type."},"funds":{"type":"array","items":{"type":"object","properties":{"fund_id":{"type":"string","description":"The fund's id as Form ADV assigns it, `805-` and ten digits: the key. It follows the fund across filings and advisers."},"fund_name":{"type":"string","description":"The fund's name as the adviser reports it."},"adviser_crd":{"type":"string","description":"CRD of the adviser whose filing reports the fund."},"adviser_name":{"type":"string","description":"The adviser's legal name at the time of the filing."},"adviser_type":{"type":"string","enum":["registered","exempt_reporting"],"description":"Whether the reporting adviser is `registered` or `exempt_reporting`."},"fund_type":{"type":"string","enum":["venture_capital","private_equity","hedge","real_estate","securitized_asset","liquidity","other"],"description":"`venture_capital`, `private_equity`, `hedge`, `real_estate`, `securitized_asset`, `liquidity` or `other`, as the adviser classified it."},"fund_type_other":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The adviser's own words when the type is `other`, e.g. `FEEDER VEHICLE`, `FUND OF FUNDS`."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state the fund is organized in, when in the US."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country the fund is organized in, as the form spells it: `United States`, `Cayman Islands`, ..."},"gross_asset_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The fund's gross asset value, US dollars, as of the filing."},"minimum_investment":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The minimum investment the fund accepts, US dollars; `0` or `1` when the adviser reports none."},"owners_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Approximate number of beneficial owners."},"ownership":{"type":"object","properties":{"adviser_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percentage owned by the adviser and its related persons."},"funds_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percentage owned by funds of funds."},"non_us_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percentage owned by non-US persons."}},"required":["adviser_pct","funds_pct","non_us_pct"]},"is_master":{"type":"boolean"},"is_feeder":{"type":"boolean"},"master_fund_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"master_fund_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a feeder, the master fund's `805-` id."},"is_fund_of_funds":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"invests_in_adviser_funds":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The fund invests in other funds the adviser or a related person advises."},"exclusion_3c1":{"type":"boolean","description":"Relies on section 3(c)(1) of the Investment Company Act (100 beneficial owners or fewer)."},"exclusion_3c7":{"type":"boolean","description":"Relies on section 3(c)(7) (qualified purchasers only)."},"has_other_advisers":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Other investment advisers also advise the fund."},"has_annual_audit":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"unqualified_opinion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the latest audit opinion was unqualified, as the form answers it: `Yes`, `No` or `Report Not Yet Received`."},"auditor":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"pcaob_registered":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["name","city","state","country","pcaob_registered"]},{"type":"null"}],"description":"The auditing firm, when the fund is audited."},"uses_prime_broker":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"uses_custodian":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"uses_administrator":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"general_partners":{"type":"array","items":{"type":"string"},"description":"The general partners, managing members or trustees the adviser lists for the fund."},"form_d_file_numbers":{"type":"array","items":{"type":"string"},"description":"The SEC file numbers (`021-…`) of the fund's Form D notices, the join to the Form D dataset."},"filing_id":{"type":"string","description":"The Form ADV filing that last reported the fund."},"filing_type":{"type":"string","enum":["initial","annual_amendment","other_amendment","final","other"],"description":"`initial`, `annual_amendment`, `other_amendment`, `final` or `other`."},"reported_at":{"type":"string","description":"When that filing was submitted."},"reported_on":{"type":"string","description":"`yyyy-mm-dd` of that filing."},"is_current":{"type":"boolean","description":"True while the adviser's latest filing still lists the fund; false once a newer filing of the same adviser omits it."},"reported_until":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the first filing that omitted the fund; null while current."}},"required":["fund_id","fund_name","adviser_crd","adviser_name","adviser_type","fund_type","fund_type_other","state","country","gross_asset_value","minimum_investment","owners_count","ownership","is_master","is_feeder","master_fund_name","master_fund_id","is_fund_of_funds","invests_in_adviser_funds","exclusion_3c1","exclusion_3c7","has_other_advisers","has_annual_audit","unqualified_opinion","auditor","uses_prime_broker","uses_custodian","uses_administrator","general_partners","form_d_file_numbers","filing_id","filing_type","reported_at","reported_on","is_current","reported_until"]},"description":"The current funds, largest first, up to 200."}},"required":["total","gross_asset_value","by_type","funds"]},{"type":"null"}]}},"required":["found","crd","as_of","adviser","private_funds"]},"IapdAdviserResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IapdAdviserData"}}},"IapdPrivateFundsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"adviser_crd":{"anyOf":[{"type":"string"},{"type":"null"}]},"fund_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_gross_asset_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"include_former":{"type":"boolean"},"reported_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"reported_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Funds matching the filters, across every page."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"funds":{"type":"array","items":{"type":"object","properties":{"fund_id":{"type":"string","description":"The fund's id as Form ADV assigns it, `805-` and ten digits: the key. It follows the fund across filings and advisers."},"fund_name":{"type":"string","description":"The fund's name as the adviser reports it."},"adviser_crd":{"type":"string","description":"CRD of the adviser whose filing reports the fund."},"adviser_name":{"type":"string","description":"The adviser's legal name at the time of the filing."},"adviser_type":{"type":"string","enum":["registered","exempt_reporting"],"description":"Whether the reporting adviser is `registered` or `exempt_reporting`."},"fund_type":{"type":"string","enum":["venture_capital","private_equity","hedge","real_estate","securitized_asset","liquidity","other"],"description":"`venture_capital`, `private_equity`, `hedge`, `real_estate`, `securitized_asset`, `liquidity` or `other`, as the adviser classified it."},"fund_type_other":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The adviser's own words when the type is `other`, e.g. `FEEDER VEHICLE`, `FUND OF FUNDS`."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state the fund is organized in, when in the US."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country the fund is organized in, as the form spells it: `United States`, `Cayman Islands`, ..."},"gross_asset_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The fund's gross asset value, US dollars, as of the filing."},"minimum_investment":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The minimum investment the fund accepts, US dollars; `0` or `1` when the adviser reports none."},"owners_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Approximate number of beneficial owners."},"ownership":{"type":"object","properties":{"adviser_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percentage owned by the adviser and its related persons."},"funds_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percentage owned by funds of funds."},"non_us_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percentage owned by non-US persons."}},"required":["adviser_pct","funds_pct","non_us_pct"]},"is_master":{"type":"boolean"},"is_feeder":{"type":"boolean"},"master_fund_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"master_fund_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a feeder, the master fund's `805-` id."},"is_fund_of_funds":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"invests_in_adviser_funds":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The fund invests in other funds the adviser or a related person advises."},"exclusion_3c1":{"type":"boolean","description":"Relies on section 3(c)(1) of the Investment Company Act (100 beneficial owners or fewer)."},"exclusion_3c7":{"type":"boolean","description":"Relies on section 3(c)(7) (qualified purchasers only)."},"has_other_advisers":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Other investment advisers also advise the fund."},"has_annual_audit":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"unqualified_opinion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the latest audit opinion was unqualified, as the form answers it: `Yes`, `No` or `Report Not Yet Received`."},"auditor":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"pcaob_registered":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["name","city","state","country","pcaob_registered"]},{"type":"null"}],"description":"The auditing firm, when the fund is audited."},"uses_prime_broker":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"uses_custodian":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"uses_administrator":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"general_partners":{"type":"array","items":{"type":"string"},"description":"The general partners, managing members or trustees the adviser lists for the fund."},"form_d_file_numbers":{"type":"array","items":{"type":"string"},"description":"The SEC file numbers (`021-…`) of the fund's Form D notices, the join to the Form D dataset."},"filing_id":{"type":"string","description":"The Form ADV filing that last reported the fund."},"filing_type":{"type":"string","enum":["initial","annual_amendment","other_amendment","final","other"],"description":"`initial`, `annual_amendment`, `other_amendment`, `final` or `other`."},"reported_at":{"type":"string","description":"When that filing was submitted."},"reported_on":{"type":"string","description":"`yyyy-mm-dd` of that filing."},"is_current":{"type":"boolean","description":"True while the adviser's latest filing still lists the fund; false once a newer filing of the same adviser omits it."},"reported_until":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the first filing that omitted the fund; null while current."}},"required":["fund_id","fund_name","adviser_crd","adviser_name","adviser_type","fund_type","fund_type_other","state","country","gross_asset_value","minimum_investment","owners_count","ownership","is_master","is_feeder","master_fund_name","master_fund_id","is_fund_of_funds","invests_in_adviser_funds","exclusion_3c1","exclusion_3c7","has_other_advisers","has_annual_audit","unqualified_opinion","auditor","uses_prime_broker","uses_custodian","uses_administrator","general_partners","form_d_file_numbers","filing_id","filing_type","reported_at","reported_on","is_current","reported_until"]}}},"required":["as_of","query","adviser_crd","fund_type","state","country","min_gross_asset_value","include_former","reported_from","reported_to","total","page","per_page","total_pages","count","funds"]},"IapdPrivateFundsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IapdPrivateFundsSearchData"}}},"IapdPrivateFundData":{"type":"object","properties":{"found":{"type":"boolean"},"fund_id":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"fund":{"anyOf":[{"type":"object","properties":{"fund_id":{"type":"string","description":"The fund's id as Form ADV assigns it, `805-` and ten digits: the key. It follows the fund across filings and advisers."},"fund_name":{"type":"string","description":"The fund's name as the adviser reports it."},"adviser_crd":{"type":"string","description":"CRD of the adviser whose filing reports the fund."},"adviser_name":{"type":"string","description":"The adviser's legal name at the time of the filing."},"adviser_type":{"type":"string","enum":["registered","exempt_reporting"],"description":"Whether the reporting adviser is `registered` or `exempt_reporting`."},"fund_type":{"type":"string","enum":["venture_capital","private_equity","hedge","real_estate","securitized_asset","liquidity","other"],"description":"`venture_capital`, `private_equity`, `hedge`, `real_estate`, `securitized_asset`, `liquidity` or `other`, as the adviser classified it."},"fund_type_other":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The adviser's own words when the type is `other`, e.g. `FEEDER VEHICLE`, `FUND OF FUNDS`."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state the fund is organized in, when in the US."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country the fund is organized in, as the form spells it: `United States`, `Cayman Islands`, ..."},"gross_asset_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The fund's gross asset value, US dollars, as of the filing."},"minimum_investment":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The minimum investment the fund accepts, US dollars; `0` or `1` when the adviser reports none."},"owners_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Approximate number of beneficial owners."},"ownership":{"type":"object","properties":{"adviser_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percentage owned by the adviser and its related persons."},"funds_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percentage owned by funds of funds."},"non_us_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percentage owned by non-US persons."}},"required":["adviser_pct","funds_pct","non_us_pct"]},"is_master":{"type":"boolean"},"is_feeder":{"type":"boolean"},"master_fund_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"master_fund_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a feeder, the master fund's `805-` id."},"is_fund_of_funds":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"invests_in_adviser_funds":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The fund invests in other funds the adviser or a related person advises."},"exclusion_3c1":{"type":"boolean","description":"Relies on section 3(c)(1) of the Investment Company Act (100 beneficial owners or fewer)."},"exclusion_3c7":{"type":"boolean","description":"Relies on section 3(c)(7) (qualified purchasers only)."},"has_other_advisers":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Other investment advisers also advise the fund."},"has_annual_audit":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"unqualified_opinion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the latest audit opinion was unqualified, as the form answers it: `Yes`, `No` or `Report Not Yet Received`."},"auditor":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"pcaob_registered":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["name","city","state","country","pcaob_registered"]},{"type":"null"}],"description":"The auditing firm, when the fund is audited."},"uses_prime_broker":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"uses_custodian":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"uses_administrator":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"general_partners":{"type":"array","items":{"type":"string"},"description":"The general partners, managing members or trustees the adviser lists for the fund."},"form_d_file_numbers":{"type":"array","items":{"type":"string"},"description":"The SEC file numbers (`021-…`) of the fund's Form D notices, the join to the Form D dataset."},"filing_id":{"type":"string","description":"The Form ADV filing that last reported the fund."},"filing_type":{"type":"string","enum":["initial","annual_amendment","other_amendment","final","other"],"description":"`initial`, `annual_amendment`, `other_amendment`, `final` or `other`."},"reported_at":{"type":"string","description":"When that filing was submitted."},"reported_on":{"type":"string","description":"`yyyy-mm-dd` of that filing."},"is_current":{"type":"boolean","description":"True while the adviser's latest filing still lists the fund; false once a newer filing of the same adviser omits it."},"reported_until":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the first filing that omitted the fund; null while current."}},"required":["fund_id","fund_name","adviser_crd","adviser_name","adviser_type","fund_type","fund_type_other","state","country","gross_asset_value","minimum_investment","owners_count","ownership","is_master","is_feeder","master_fund_name","master_fund_id","is_fund_of_funds","invests_in_adviser_funds","exclusion_3c1","exclusion_3c7","has_other_advisers","has_annual_audit","unqualified_opinion","auditor","uses_prime_broker","uses_custodian","uses_administrator","general_partners","form_d_file_numbers","filing_id","filing_type","reported_at","reported_on","is_current","reported_until"]},{"type":"null"}]}},"required":["found","fund_id","as_of","fund"]},"IapdPrivateFundResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IapdPrivateFundData"}}},"Sec13fFilingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"manager_cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"manager_crd":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"period_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"period_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"type":"number","description":"Filings matching the filters, across every page."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"filings":{"type":"array","items":{"type":"object","properties":{"accession_number":{"type":"string","description":"EDGAR's accession number for the filing: the key."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"period":{"type":"string","description":"`yyyy-mm-dd` of the quarter end the filing reports, e.g. `2026-03-31`."},"submission_type":{"type":"string","enum":["13F-HR","13F-NT","13F-HR/A","13F-NT/A"],"description":"`13F-HR` a holdings report, `13F-NT` a notice that another manager reports the holdings, and their `/A` amendments."},"is_amendment":{"type":"boolean","description":"The filing amends an earlier one for the same quarter."},"amendment_number":{"anyOf":[{"type":"integer"},{"type":"null"}]},"amendment_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`RESTATEMENT` or `NEW HOLDINGS`, when the filing is an amendment."},"report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`13F HOLDINGS REPORT`, `13F NOTICE` or `13F COMBINATION REPORT`, as the cover page states it."},"manager":{"type":"object","properties":{"cik":{"type":"string","description":"The filing manager's EDGAR Central Index Key, without leading zeros."},"name":{"type":"string","description":"The filing manager's name as the cover page states it."},"crd":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manager's CRD number, when the cover page carries one: the join to the investment adviser registry."},"sec_file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"form_13f_file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manager's own `028-` file number for Form 13F."},"address":{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state, or the form's code for a country."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]}},"required":["cik","name","crd","sec_file_number","form_13f_file_number","address"]},"holdings_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"How many positions the filing's information table carries."},"holdings_value":{"anyOf":[{"type":"number"},{"type":"null"}],"column":"number","description":"The information table's total value, US dollars. Filings before 2023 reported thousands; this is normalized to dollars."},"other_managers_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Other managers included in the filing."},"confidential_omitted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The manager omitted holdings under a confidential treatment request."},"additional_information":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_url":{"type":"string","description":"Where the filing sits on EDGAR."}},"required":["accession_number","filed_on","period","submission_type","is_amendment","amendment_number","amendment_type","report_type","manager","holdings_count","holdings_value","other_managers_count","confidential_omitted","additional_information","filing_url"]}}},"required":["as_of","query","manager_cik","manager_crd","state","period_from","period_to","min_value","total","page","per_page","total_pages","count","filings"]},"Sec13fFilingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Sec13fFilingsSearchData"}}},"Sec13fFilingData":{"type":"object","properties":{"found":{"type":"boolean"},"accession_number":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"filing":{"anyOf":[{"type":"object","properties":{"accession_number":{"type":"string","description":"EDGAR's accession number for the filing: the key."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"period":{"type":"string","description":"`yyyy-mm-dd` of the quarter end the filing reports, e.g. `2026-03-31`."},"submission_type":{"type":"string","enum":["13F-HR","13F-NT","13F-HR/A","13F-NT/A"],"description":"`13F-HR` a holdings report, `13F-NT` a notice that another manager reports the holdings, and their `/A` amendments."},"is_amendment":{"type":"boolean","description":"The filing amends an earlier one for the same quarter."},"amendment_number":{"anyOf":[{"type":"integer"},{"type":"null"}]},"amendment_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`RESTATEMENT` or `NEW HOLDINGS`, when the filing is an amendment."},"report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`13F HOLDINGS REPORT`, `13F NOTICE` or `13F COMBINATION REPORT`, as the cover page states it."},"manager":{"type":"object","properties":{"cik":{"type":"string","description":"The filing manager's EDGAR Central Index Key, without leading zeros."},"name":{"type":"string","description":"The filing manager's name as the cover page states it."},"crd":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manager's CRD number, when the cover page carries one: the join to the investment adviser registry."},"sec_file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"form_13f_file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manager's own `028-` file number for Form 13F."},"address":{"type":"object","properties":{"street_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter US state, or the form's code for a country."},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]}},"required":["cik","name","crd","sec_file_number","form_13f_file_number","address"]},"holdings_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"How many positions the filing's information table carries."},"holdings_value":{"anyOf":[{"type":"number"},{"type":"null"}],"column":"number","description":"The information table's total value, US dollars. Filings before 2023 reported thousands; this is normalized to dollars."},"other_managers_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Other managers included in the filing."},"confidential_omitted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The manager omitted holdings under a confidential treatment request."},"additional_information":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_url":{"type":"string","description":"Where the filing sits on EDGAR."}},"required":["accession_number","filed_on","period","submission_type","is_amendment","amendment_number","amendment_type","report_type","manager","holdings_count","holdings_value","other_managers_count","confidential_omitted","additional_information","filing_url"]},{"type":"null"}]},"holdings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The filing's accession number and the position's sequence within it, joined by a colon: the key."},"accession_number":{"type":"string","description":"The filing that reported the position."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"period":{"type":"string","description":"`yyyy-mm-dd` of the quarter end the position is reported as of."},"manager_cik":{"type":"string","description":"The reporting manager's EDGAR Central Index Key, without leading zeros."},"manager_name":{"type":"string","description":"The reporting manager's name."},"manager_crd":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manager's CRD number, when the filing carries one."},"issuer_name":{"type":"string","description":"The issuer as the manager spells it, e.g. `APPLE INC`."},"cusip":{"type":"string","description":"The security's CUSIP, the key every manager reports the same position under."},"figi":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The security's FIGI, when the manager reported one."},"class_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The class of security, e.g. `COM`, `CL A`."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"column":"number","description":"The position's value, US dollars. Filings before 2023 reported thousands; this is normalized to dollars."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares or principal amount held."},"share_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`SH` for shares, `PRN` for principal amount."},"put_call":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`PUT` or `CALL` when the position is an option, null when it is the security itself."},"discretion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`SOLE`, `DFND` or `OTR`: who decides on the position."},"other_managers":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The other managers sharing the position, as the table numbers them."},"voting_sole":{"anyOf":[{"type":"number"},{"type":"null"}]},"voting_shared":{"anyOf":[{"type":"number"},{"type":"null"}]},"voting_none":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","accession_number","filed_on","period","manager_cik","manager_name","manager_crd","issuer_name","cusip","figi","class_title","value","shares","share_type","put_call","discretion","other_managers","voting_sole","voting_shared","voting_none"]},"description":"The filing's positions, largest first, up to 200. Empty for a notice, and for a quarter the copy does not carry positions for."}},"required":["found","accession_number","as_of","filing","holdings"]},"Sec13fFilingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Sec13fFilingData"}}},"Sec13fHoldingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"cusip":{"anyOf":[{"type":"string"},{"type":"null"}]},"manager_cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"manager_crd":{"anyOf":[{"type":"string"},{"type":"null"}]},"put_call":{"anyOf":[{"type":"string"},{"type":"null"}]},"period_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"period_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"type":"number","description":"Positions matching the filters, across every page."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"holdings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The filing's accession number and the position's sequence within it, joined by a colon: the key."},"accession_number":{"type":"string","description":"The filing that reported the position."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"period":{"type":"string","description":"`yyyy-mm-dd` of the quarter end the position is reported as of."},"manager_cik":{"type":"string","description":"The reporting manager's EDGAR Central Index Key, without leading zeros."},"manager_name":{"type":"string","description":"The reporting manager's name."},"manager_crd":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manager's CRD number, when the filing carries one."},"issuer_name":{"type":"string","description":"The issuer as the manager spells it, e.g. `APPLE INC`."},"cusip":{"type":"string","description":"The security's CUSIP, the key every manager reports the same position under."},"figi":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The security's FIGI, when the manager reported one."},"class_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The class of security, e.g. `COM`, `CL A`."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"column":"number","description":"The position's value, US dollars. Filings before 2023 reported thousands; this is normalized to dollars."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares or principal amount held."},"share_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`SH` for shares, `PRN` for principal amount."},"put_call":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`PUT` or `CALL` when the position is an option, null when it is the security itself."},"discretion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`SOLE`, `DFND` or `OTR`: who decides on the position."},"other_managers":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The other managers sharing the position, as the table numbers them."},"voting_sole":{"anyOf":[{"type":"number"},{"type":"null"}]},"voting_shared":{"anyOf":[{"type":"number"},{"type":"null"}]},"voting_none":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","accession_number","filed_on","period","manager_cik","manager_name","manager_crd","issuer_name","cusip","figi","class_title","value","shares","share_type","put_call","discretion","other_managers","voting_sole","voting_shared","voting_none"]}}},"required":["as_of","query","cusip","manager_cik","manager_crd","put_call","period_from","period_to","min_value","total","page","per_page","total_pages","count","holdings"]},"Sec13fHoldingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Sec13fHoldingsSearchData"}}},"OfacSanctionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"list":{"anyOf":[{"type":"string"},{"type":"null"}]},"party_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"program":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Parties matching the filters, across every page."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The list and OFAC's own entity number, joined by a hyphen, e.g. `sdn-36`: the key."},"list":{"type":"string","enum":["sdn","non_sdn"],"description":"`sdn` for the Specially Designated Nationals and Blocked Persons list, `non_sdn` for the consolidated list of the other sanctions programs."},"entity_number":{"type":"integer","description":"OFAC's own number for the party, unique within its list."},"name":{"type":"string","description":"The party's primary name as OFAC writes it: `LAST, First` for a person."},"party_type":{"type":"string","enum":["individual","entity","vessel","aircraft"],"description":"`individual`, `entity` (a company or organisation), `vessel` or `aircraft`."},"programs":{"type":"array","items":{"type":"string"},"description":"The sanctions programs the party is designated under, e.g. `RUSSIA-EO14024`, `SDGT`, `CUBA`."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The person's title or role, when OFAC records one."},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"OFAC's own note, which is where dates and places of birth, passport and tax numbers and other identifiers are written."},"vessel":{"anyOf":[{"type":"object","properties":{"call_sign":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"tonnage":{"anyOf":[{"type":"string"},{"type":"null"}]},"gross_registered_tonnage":{"anyOf":[{"type":"string"},{"type":"null"}]},"flag":{"anyOf":[{"type":"string"},{"type":"null"}]},"owner":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["call_sign","type","tonnage","gross_registered_tonnage","flag","owner"]},{"type":"null"}],"description":"Set only for a vessel."},"aliases":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"`aka` also known as, `fka` formerly known as, `nka` now known as."},"name":{"type":"string"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","name","remarks"]},"description":"Every other name OFAC records for the party."},"alias_names":{"type":"array","items":{"type":"string"},"description":"The alias names alone, for search."},"addresses":{"type":"array","items":{"type":"object","properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"city_state_province":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rest of the line as OFAC writes it: city, state or province and postal code together."},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["address","city_state_province","country","remarks"]},"description":"Every address OFAC records for the party."},"countries":{"type":"array","items":{"type":"string"},"description":"The distinct countries of the party's addresses."}},"required":["id","list","entity_number","name","party_type","programs","title","remarks","vessel","aliases","alias_names","addresses","countries"]}}},"required":["as_of","query","list","party_type","program","country","total","page","per_page","total_pages","count","parties"]},"OfacSanctionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/OfacSanctionsSearchData"}}},"OfacSanctionedPartyData":{"type":"object","properties":{"found":{"type":"boolean"},"id":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"party":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The list and OFAC's own entity number, joined by a hyphen, e.g. `sdn-36`: the key."},"list":{"type":"string","enum":["sdn","non_sdn"],"description":"`sdn` for the Specially Designated Nationals and Blocked Persons list, `non_sdn` for the consolidated list of the other sanctions programs."},"entity_number":{"type":"integer","description":"OFAC's own number for the party, unique within its list."},"name":{"type":"string","description":"The party's primary name as OFAC writes it: `LAST, First` for a person."},"party_type":{"type":"string","enum":["individual","entity","vessel","aircraft"],"description":"`individual`, `entity` (a company or organisation), `vessel` or `aircraft`."},"programs":{"type":"array","items":{"type":"string"},"description":"The sanctions programs the party is designated under, e.g. `RUSSIA-EO14024`, `SDGT`, `CUBA`."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The person's title or role, when OFAC records one."},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"OFAC's own note, which is where dates and places of birth, passport and tax numbers and other identifiers are written."},"vessel":{"anyOf":[{"type":"object","properties":{"call_sign":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"tonnage":{"anyOf":[{"type":"string"},{"type":"null"}]},"gross_registered_tonnage":{"anyOf":[{"type":"string"},{"type":"null"}]},"flag":{"anyOf":[{"type":"string"},{"type":"null"}]},"owner":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["call_sign","type","tonnage","gross_registered_tonnage","flag","owner"]},{"type":"null"}],"description":"Set only for a vessel."},"aliases":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"`aka` also known as, `fka` formerly known as, `nka` now known as."},"name":{"type":"string"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","name","remarks"]},"description":"Every other name OFAC records for the party."},"alias_names":{"type":"array","items":{"type":"string"},"description":"The alias names alone, for search."},"addresses":{"type":"array","items":{"type":"object","properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"city_state_province":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rest of the line as OFAC writes it: city, state or province and postal code together."},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["address","city_state_province","country","remarks"]},"description":"Every address OFAC records for the party."},"countries":{"type":"array","items":{"type":"string"},"description":"The distinct countries of the party's addresses."}},"required":["id","list","entity_number","name","party_type","programs","title","remarks","vessel","aliases","alias_names","addresses","countries"]},{"type":"null"}]}},"required":["found","id","as_of","party"]},"OfacSanctionedPartyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/OfacSanctionedPartyData"}}},"DjenPublicationsSearchData":{"type":"object","properties":{"total":{"type":"integer","description":"Publications matching the filters. Exact when `from_date` and `to_date` name the same day; for a wider range or no dates it stops at 10,000, see `total_is_lower_bound`."},"total_is_lower_bound":{"type":"boolean","description":"true when `total` is the 10,000 ceiling rather than the real count: more publications match than can be paged. Narrow the dates, or query one day at a time, which pages in full."},"count":{"type":"integer","description":"Publications in this response."},"page":{"type":"integer","description":"The page returned, echoed back."},"per_page":{"type":"integer","description":"Rows per page, echoed back."},"publications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The DJEN's id for the publication."},"available_on":{"type":"string","description":"`yyyy-mm-dd` the publication became available (data de disponibilização). The publication date proper is the next business day and procedural deadlines start on the one after; this field is the availability date."},"court_code":{"type":"string","description":"The court's alias, e.g. `TJSP`, `TRT2`, `TRF1`, `STJ`."},"judicial_body":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judicial body (vara, turma, câmara) that issued it."},"judicial_body_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The DJEN's id for that judicial body."},"communication_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Intimação`, `Citação`, `Edital` or `Lista de distribuição`, as the court files it."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court's own label for the document, e.g. `Ato ordinatório`, `DESPACHO/DECISÃO`, `Edital`."},"medium":{"anyOf":[{"type":"string","enum":["diario","edital"]},{"type":"null"}],"description":"`diario` for the Diário de Justiça Eletrônico Nacional, `edital` for the Plataforma Nacional de Editais."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The CNJ case number, 20 digits."},"registration_number_formatted":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The same case number with the CNJ mask, `NNNNNNN-DD.AAAA.J.TR.OOOO`."},"class_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Procedural class, e.g. `CUMPRIMENTO DE SENTENÇA`, `AÇÃO PENAL`."},"class_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The CNJ code of the procedural class."},"sequence":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The court's sequence number for the publication."},"active":{"type":"boolean","description":"false when the court withdrew the publication."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the court withdrew it, or null."},"cancellation_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why the court withdrew it, or null."},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Link to the case in the court's own system, when the court provides one."},"text":{"type":"string","description":"The full text of the publication, as plain text with paragraph breaks."},"parties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The party's name as the publication prints it."},"pole":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which side the party is on: `A` (polo ativo, the claimant side) or `P` (polo passivo, the defendant side); other letters as the court files them."}},"required":["name","pole"]},"description":"The parties the publication is addressed to, with their side."},"lawyers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The lawyer's name as the publication prints it."},"oab_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"OAB registration number, digits only."},"oab_state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state of the OAB registration, e.g. `SP`."}},"required":["name","oab_number","oab_state"]},"description":"The lawyers the publication is addressed to; empty on most editais."}},"required":["id","available_on","court_code","judicial_body","judicial_body_id","communication_type","document_type","medium","registration_number","registration_number_formatted","class_name","class_code","sequence","active","cancelled_on","cancellation_reason","source_url","text","parties","lawyers"]},"description":"Newest availability date first; empty past the last page."},"checked_at":{"type":"string","description":"When this answer was read from the DJEN, as an ISO timestamp."}},"required":["total","total_is_lower_bound","count","page","per_page","publications","checked_at"]},"DjenPublicationsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DjenPublicationsSearchData"}}},"CguSanctionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"list":{"anyOf":[{"type":"string"},{"type":"null"}]},"party_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"sanctioning_body_state":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Sanctions matching the filters, across every page."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"sanctions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The register and CGU's own code, joined by a hyphen, e.g. `ceis-72529`: the key."},"list":{"type":"string","enum":["ceis","cnep","ceaf","cepim","leniency"],"description":"`ceis`, `cnep`, `ceaf`, `cepim` or `leniency`."},"sanction_code":{"type":"string","description":"CGU's own code for the sanction; the agreement number for a non-profit's bar; the agreement id for a leniency agreement."},"party_type":{"anyOf":[{"type":"string","enum":["individual","company"]},{"type":"null"}],"description":"`individual` or `company`; null for a foreign or unidentified party."},"document_type":{"anyOf":[{"type":"string","enum":["cpf","cnpj","foreign"]},{"type":"null"}],"description":"What `document` is: a Brazilian CPF, a CNPJ, or a foreign identifier."},"document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's document as it can be shown: a CNPJ in full (`12.345.678/0001-90`), a CPF masked the way CGU masks it (`***.456.789-**`), a foreign identifier as published."},"name":{"type":"string","description":"The party's name as the register records it."},"names":{"type":"array","items":{"type":"string"},"description":"Every name the register gives the party (as sanctioned, as the sanctioning body reported it, the company's registered and trade names), for search."},"sanction_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of sanction, as CGU words it, e.g. `Suspensão`, `Multa`, `Demissão`, `Declaração de Inidoneidade sem prazo determinado`."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the sanction started."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the sanction's term ends, when it has one. A past date does not mean the sanction has ended: CGU removes a sanction from the register when it ends."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the sanction was published."},"final_judgment_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the decision became final (trânsito em julgado), for a court-imposed sanction."},"information_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the sanctioning body reported it."},"publication":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the sanction was published, e.g. `Diário Oficial da União`."},"publication_detail":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How far the sanction reaches (abrangência), as CGU words it."},"sanctioning_body":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The body that imposed the sanction; for a non-profit's bar, the ministry that granted the transfer."},"sanctioning_body_state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state (UF) of the sanctioning body, not of the party; null for a federal body."},"sanctioning_body_sphere":{"anyOf":[{"type":"string","enum":["federal","state","municipal"]},{"type":"null"}],"description":"`federal`, `state` or `municipal`."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal basis the sanctioning body cites."},"process_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The administrative or court process the sanction came from."},"information_source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where CGU received the sanction from, e.g. `Conselho Nacional de Justiça (CNJ-DF)`."},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"fine_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The fine in reais, for a fine under the Anti-Corruption Law."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why a non-profit is barred from federal transfers."},"public_servant":{"anyOf":[{"type":"object","properties":{"position":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The permanent post the servant held (cargo efetivo)."},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The appointed role or function, when there was one."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The federal body the servant worked in."},"act_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the act that imposed the penalty."}},"required":["position","role","unit","act_number"]},{"type":"null"}],"description":"Set only for an expelled federal servant."},"agreement":{"anyOf":[{"type":"object","properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Em Execução` or `Cumprido`, as CGU words it."},"terms":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agreement's terms, as CGU summarises them."},"effects":{"type":"array","items":{"type":"object","properties":{"effect":{"type":"string","description":"What the agreement grants, as CGU words it, e.g. an exemption from a declaration of unfitness."},"detail":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["effect","detail"]},"description":"What the agreement grants the company."}},"required":["status","terms","effects"]},{"type":"null"}],"description":"Set only for a leniency agreement."}},"required":["id","list","sanction_code","party_type","document_type","document","name","names","sanction_type","start_date","end_date","publication_date","final_judgment_date","information_date","publication","publication_detail","scope","sanctioning_body","sanctioning_body_state","sanctioning_body_sphere","legal_basis","process_number","information_source","notes","fine_amount","reason","public_servant","agreement"]}}},"required":["as_of","query","list","party_type","sanctioning_body_state","total","page","per_page","total_pages","count","sanctions"]},"CguSanctionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CguSanctionsSearchData"}}},"CguSanctionData":{"type":"object","properties":{"found":{"type":"boolean"},"id":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"sanction":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The register and CGU's own code, joined by a hyphen, e.g. `ceis-72529`: the key."},"list":{"type":"string","enum":["ceis","cnep","ceaf","cepim","leniency"],"description":"`ceis`, `cnep`, `ceaf`, `cepim` or `leniency`."},"sanction_code":{"type":"string","description":"CGU's own code for the sanction; the agreement number for a non-profit's bar; the agreement id for a leniency agreement."},"party_type":{"anyOf":[{"type":"string","enum":["individual","company"]},{"type":"null"}],"description":"`individual` or `company`; null for a foreign or unidentified party."},"document_type":{"anyOf":[{"type":"string","enum":["cpf","cnpj","foreign"]},{"type":"null"}],"description":"What `document` is: a Brazilian CPF, a CNPJ, or a foreign identifier."},"document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's document as it can be shown: a CNPJ in full (`12.345.678/0001-90`), a CPF masked the way CGU masks it (`***.456.789-**`), a foreign identifier as published."},"name":{"type":"string","description":"The party's name as the register records it."},"names":{"type":"array","items":{"type":"string"},"description":"Every name the register gives the party (as sanctioned, as the sanctioning body reported it, the company's registered and trade names), for search."},"sanction_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of sanction, as CGU words it, e.g. `Suspensão`, `Multa`, `Demissão`, `Declaração de Inidoneidade sem prazo determinado`."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the sanction started."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the sanction's term ends, when it has one. A past date does not mean the sanction has ended: CGU removes a sanction from the register when it ends."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the sanction was published."},"final_judgment_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the decision became final (trânsito em julgado), for a court-imposed sanction."},"information_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the sanctioning body reported it."},"publication":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the sanction was published, e.g. `Diário Oficial da União`."},"publication_detail":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How far the sanction reaches (abrangência), as CGU words it."},"sanctioning_body":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The body that imposed the sanction; for a non-profit's bar, the ministry that granted the transfer."},"sanctioning_body_state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state (UF) of the sanctioning body, not of the party; null for a federal body."},"sanctioning_body_sphere":{"anyOf":[{"type":"string","enum":["federal","state","municipal"]},{"type":"null"}],"description":"`federal`, `state` or `municipal`."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal basis the sanctioning body cites."},"process_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The administrative or court process the sanction came from."},"information_source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where CGU received the sanction from, e.g. `Conselho Nacional de Justiça (CNJ-DF)`."},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"fine_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The fine in reais, for a fine under the Anti-Corruption Law."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why a non-profit is barred from federal transfers."},"public_servant":{"anyOf":[{"type":"object","properties":{"position":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The permanent post the servant held (cargo efetivo)."},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The appointed role or function, when there was one."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The federal body the servant worked in."},"act_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the act that imposed the penalty."}},"required":["position","role","unit","act_number"]},{"type":"null"}],"description":"Set only for an expelled federal servant."},"agreement":{"anyOf":[{"type":"object","properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Em Execução` or `Cumprido`, as CGU words it."},"terms":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agreement's terms, as CGU summarises them."},"effects":{"type":"array","items":{"type":"object","properties":{"effect":{"type":"string","description":"What the agreement grants, as CGU words it, e.g. an exemption from a declaration of unfitness."},"detail":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["effect","detail"]},"description":"What the agreement grants the company."}},"required":["status","terms","effects"]},{"type":"null"}],"description":"Set only for a leniency agreement."}},"required":["id","list","sanction_code","party_type","document_type","document","name","names","sanction_type","start_date","end_date","publication_date","final_judgment_date","information_date","publication","publication_detail","scope","sanctioning_body","sanctioning_body_state","sanctioning_body_sphere","legal_basis","process_number","information_source","notes","fine_amount","reason","public_servant","agreement"]},{"type":"null"}]}},"required":["found","id","as_of","sanction"]},"CguSanctionResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CguSanctionData"}}},"PgfnDebtsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"regime":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"status_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"debtor_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"in_court":{"type":"string"},"total":{"type":"number","description":"Debts matching the filters, across every page."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"debts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The regime, the inscription number and the company's CNPJ, joined by colons: the key."},"regime":{"type":"string","enum":["nao_previdenciario","previdenciario","fgts"],"description":"`nao_previdenciario` (federal taxes and other non-social-security debt), `previdenciario` (social security contributions) or `fgts` (the workers' severance fund)."},"inscription_number":{"type":"string","description":"The inscription's number in the dívida ativa, as PGFN publishes it."},"document_number":{"type":"string","description":"The company's CNPJ, 14 characters, no punctuation."},"document":{"type":"string","description":"The CNPJ as it is written, `12.345.678/0001-90`."},"cnpj_root":{"type":"string","description":"The CNPJ's first 8 characters: the same for every establishment of one company."},"debtor_name":{"type":"string","description":"The company's name as PGFN records it."},"debtor_type":{"type":"string","enum":["principal","co_responsible","joint"],"description":"The company's role in the debt: `principal`, `co_responsible` or `joint`. An inscription with several debtors has a row for each."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state (UF) of the company."},"responsible_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The PGFN unit in charge, e.g. `3ª REGIÃO`."},"registering_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit that registered an FGTS debt."},"collecting_entity":{"type":"string","enum":["pgfn","caixa"],"description":"Who collects the debt: PGFN, or Caixa for part of the FGTS."},"status_type":{"anyOf":[{"type":"string","enum":["in_collection","tax_benefit","guaranteed","suspended_by_court","in_negotiation"]},{"type":"null"}],"description":"`in_collection`, `tax_benefit`, `guaranteed`, `suspended_by_court` or `in_negotiation`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The inscription's detailed status, as PGFN words it."},"revenue_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the debt is for, as PGFN words it, e.g. `Receita da dívida ativa - PIS`, `Simples Nacional`."},"registered_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the debt was inscribed."},"in_court":{"type":"boolean","description":"true when the debt is being enforced in court (ajuizada)."},"amount":{"type":"number","column":"number","description":"The consolidated amount in reais, with legal charges, as of PGFN's extraction. The whole inscription's amount: repeated on each debtor's row."},"reference_month":{"type":"string","description":"`yyyy-mm`: the month PGFN's quarterly release refers to."}},"required":["id","regime","inscription_number","document_number","document","cnpj_root","debtor_name","debtor_type","state","responsible_unit","registering_unit","collecting_entity","status_type","status","revenue_type","registered_on","in_court","amount","reference_month"]}}},"required":["as_of","query","document_number","regime","state","status_type","debtor_type","in_court","total","page","per_page","total_pages","count","debts"]},"PgfnDebtsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PgfnDebtsSearchData"}}},"PgfnDebtorData":{"type":"object","properties":{"found":{"type":"boolean","description":"false when the company owes the Union nothing PGFN has inscribed."},"document_number":{"type":"string","description":"The CNPJ or root queried, echoed back."},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"reference_month":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm` of PGFN's release the answer comes from."},"debtor_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"totals":{"anyOf":[{"type":"object","properties":{"debts":{"type":"number","description":"Every debt the company appears on, as principal or co-responsible."},"principal_debts":{"type":"number","description":"Debts on which the company is the principal debtor."},"principal_amount":{"type":"number","description":"What the company owes as principal debtor, reais. Co-responsible debts are left out, since they repeat another debtor's amount."},"in_court_amount":{"type":"number","description":"The part of `principal_amount` being enforced in court."},"by_regime":{"type":"object","properties":{"nao_previdenciario":{"type":"object","properties":{"debts":{"type":"number","description":"Debts on which the company is the principal debtor."},"amount":{"type":"number","description":"Their consolidated amount, reais."}},"required":["debts","amount"]},"previdenciario":{"type":"object","properties":{"debts":{"type":"number","description":"Debts on which the company is the principal debtor."},"amount":{"type":"number","description":"Their consolidated amount, reais."}},"required":["debts","amount"]},"fgts":{"type":"object","properties":{"debts":{"type":"number","description":"Debts on which the company is the principal debtor."},"amount":{"type":"number","description":"Their consolidated amount, reais."}},"required":["debts","amount"]}},"required":["nao_previdenciario","previdenciario","fgts"]},"complete":{"type":"boolean","description":"false when the company has more debts than one answer sums; the totals then cover the largest ones."}},"required":["debts","principal_debts","principal_amount","in_court_amount","by_regime","complete"]},{"type":"null"}]},"debts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The regime, the inscription number and the company's CNPJ, joined by colons: the key."},"regime":{"type":"string","enum":["nao_previdenciario","previdenciario","fgts"],"description":"`nao_previdenciario` (federal taxes and other non-social-security debt), `previdenciario` (social security contributions) or `fgts` (the workers' severance fund)."},"inscription_number":{"type":"string","description":"The inscription's number in the dívida ativa, as PGFN publishes it."},"document_number":{"type":"string","description":"The company's CNPJ, 14 characters, no punctuation."},"document":{"type":"string","description":"The CNPJ as it is written, `12.345.678/0001-90`."},"cnpj_root":{"type":"string","description":"The CNPJ's first 8 characters: the same for every establishment of one company."},"debtor_name":{"type":"string","description":"The company's name as PGFN records it."},"debtor_type":{"type":"string","enum":["principal","co_responsible","joint"],"description":"The company's role in the debt: `principal`, `co_responsible` or `joint`. An inscription with several debtors has a row for each."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state (UF) of the company."},"responsible_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The PGFN unit in charge, e.g. `3ª REGIÃO`."},"registering_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit that registered an FGTS debt."},"collecting_entity":{"type":"string","enum":["pgfn","caixa"],"description":"Who collects the debt: PGFN, or Caixa for part of the FGTS."},"status_type":{"anyOf":[{"type":"string","enum":["in_collection","tax_benefit","guaranteed","suspended_by_court","in_negotiation"]},{"type":"null"}],"description":"`in_collection`, `tax_benefit`, `guaranteed`, `suspended_by_court` or `in_negotiation`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The inscription's detailed status, as PGFN words it."},"revenue_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the debt is for, as PGFN words it, e.g. `Receita da dívida ativa - PIS`, `Simples Nacional`."},"registered_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the debt was inscribed."},"in_court":{"type":"boolean","description":"true when the debt is being enforced in court (ajuizada)."},"amount":{"type":"number","column":"number","description":"The consolidated amount in reais, with legal charges, as of PGFN's extraction. The whole inscription's amount: repeated on each debtor's row."},"reference_month":{"type":"string","description":"`yyyy-mm`: the month PGFN's quarterly release refers to."}},"required":["id","regime","inscription_number","document_number","document","cnpj_root","debtor_name","debtor_type","state","responsible_unit","registering_unit","collecting_entity","status_type","status","revenue_type","registered_on","in_court","amount","reference_month"]},"description":"The company's largest debts first, up to 50."}},"required":["found","document_number","as_of","reference_month","debtor_name","totals","debts"]},"PgfnDebtorResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PgfnDebtorData"}}},"TstLabourCertificateData":{"type":"object","properties":{"document_number":{"type":"string","description":"The CNPJ queried, 14 characters, echoed back."},"status":{"type":"string","enum":["clear","debts","debts_secured"],"description":"`clear` (no labour debt), `debts` (unpaid labour debts), or `debts_secured` (labour debts, every one secured or suspended)."},"has_clearance_effect":{"type":"boolean","description":"true for `clear` and `debts_secured`: the certificate has the legal effect of a clearance, as public tenders require."},"status_label":{"type":"string","description":"The certificate's title, as the court prints it."},"certificate_number":{"type":"string","description":"The certificate's number and year, e.g. `75794208/2026`."},"issued_at":{"type":"string","description":"When the certificate was issued, ISO 8601 in Brasília time."},"valid_until":{"type":"string","description":"`yyyy-mm-dd` the certificate stops being valid: 180 days after it was issued."},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's name as the certificate prints it; null when the certificate is issued without one."},"total_cases":{"type":"integer","description":"Labour cases the certificate lists; 0 when clear."},"cases":{"type":"array","items":{"type":"object","properties":{"case_number":{"type":"string","description":"The case's CNJ number, `NNNNNNN-DD.AAAA.5.RR.OOOO`."},"court":{"type":"string","description":"The regional labour court, e.g. `TRT 01ª Região`."},"region":{"type":"integer","description":"The region's number, 1 to 24."},"office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The labour court (vara) the case sits in, when the certificate names it."},"debt_condition":{"type":"string","enum":["unsecured","secured","suspended"],"description":"`unsecured`; `secured` by a deposit, a freeze or an attachment of enough assets; or `suspended` (its enforceability is suspended)."}},"required":["case_number","court","region","office","debt_condition"]},"description":"The cases behind the debts, as the certificate lists them."},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A link to the official certificate PDF, when `include_pdf` was true."},"checked_at":{"type":"string","description":"When this certificate was issued for this request, as an ISO timestamp."}},"required":["document_number","status","has_clearance_effect","status_label","certificate_number","issued_at","valid_until","company_name","total_cases","cases","pdf_url","checked_at"]},"TstLabourCertificateResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TstLabourCertificateData"}}},"CaixaFgtsCertificateData":{"type":"object","properties":{"document_number":{"type":"string","description":"The CNPJ queried, 14 characters, echoed back."},"found":{"type":"boolean","description":"false when the CNPJ is not registered as an employer with the FGTS."},"status":{"anyOf":[{"type":"string","enum":["regular","irregular"]},{"type":"null"}],"description":"`regular` (a valid certificate exists) or `irregular` (impediments block it); null when not found."},"status_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's verdict sentence(s), verbatim."},"impediments":{"type":"array","items":{"type":"object","properties":{"agency":{"type":"string","enum":["PGFN","CAIXA"],"description":"Who reports it: `PGFN` (FGTS debt enrolled with the Union's attorneys) or `CAIXA` (the fund's operator)."},"message":{"type":"string","description":"What the source says, verbatim."}},"required":["agency","message"]},"description":"What blocks the certificate; empty unless `irregular`."},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's name (razão social) as the source prints it, including suffixes like `EM RECUPERACAO JUDICIAL`."},"certificate":{"anyOf":[{"type":"object","properties":{"number":{"type":"string","description":"The certificate's number (22 digits), which anyone can check with the source."},"valid_from":{"type":"string","description":"`yyyy-mm-dd` the certificate was issued and starts being valid."},"valid_until":{"type":"string","description":"`yyyy-mm-dd` it stops being valid: 30 days after issue."},"address":{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Street type and name, e.g. `AV REPUBLICA DO CHILE`."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The street number, as printed."},"complement":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Floor, suite or block; null when there is none."},"district":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The neighbourhood (bairro)."},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state (UF), e.g. `RJ`."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CEP, `NNNNN-NNN`."},"full":{"type":"string","description":"The whole address on one line, as printed."}},"required":["street","number","complement","district","city","state","postal_code","full"],"description":"The establishment's address as the certificate prints it."}},"required":["number","valid_from","valid_until","address"]},{"type":"null"}],"description":"The current certificate; null unless `regular`."},"history":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"issued_on":{"type":"string","description":"`yyyy-mm-dd` the certificate was issued."},"valid_from":{"type":"string","description":"`yyyy-mm-dd`."},"valid_until":{"type":"string","description":"`yyyy-mm-dd`."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The certificate's number; null on early-2000s entries, which carry none."}},"required":["issued_on","valid_from","valid_until","number"]}},{"type":"null"}],"description":"Certificates issued in the last 24 months, newest first, when `include_history` was true; null otherwise."},"checked_at":{"type":"string","description":"When the source answered, ISO 8601 in Brasília time."}},"required":["document_number","found","status","status_label","impediments","company_name","certificate","history","checked_at"]},"CaixaFgtsCertificateResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CaixaFgtsCertificateData"}}},"MteSlaveLabourSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"list":{"anyOf":[{"type":"string"},{"type":"null"}]},"party_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"inspection_year":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"type":"number","description":"Listings matching the filters, across every page."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"employers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The register and a fingerprint of the listing, e.g. `slave_labour-3f9a0c12d4e5b6a7`: the key."},"list":{"type":"string","enum":["slave_labour","conduct_adjustment"],"description":"`slave_labour` (the register of employers caught keeping workers in conditions analogous to slavery) or `conduct_adjustment` (employers who signed a conduct-adjustment agreement instead)."},"party_type":{"type":"string","enum":["individual","company"],"description":"`individual` (listed by CPF) or `company` (by CNPJ)."},"document_type":{"type":"string","enum":["cpf","cnpj"]},"document":{"type":"string","description":"A CNPJ in full (`12.345.678/0001-90`); a CPF masked (`***.456.789-**`)."},"employer_name":{"type":"string","description":"The employer's name as the register prints it; a CPF inside a name is masked."},"establishment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The establishment inspected (a farm, a site, an address), as printed; a CPF inside it is masked."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state (UF) of the inspection."},"inspection_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The year of the inspection that found the workers."},"workers_involved":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Workers found in conditions analogous to slavery."},"cnae":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The activity code (CNAE), e.g. `0151-2/01`."},"final_decision_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the administrative decision became final."},"listed_on":{"type":"string","description":"`yyyy-mm-dd` the current listing started."},"listing_history":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"`yyyy-mm-dd`."},"to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`; null while it lasts."}},"required":["from","to"]},"description":"Every period the employer has been on the register: a court can suspend a listing and it can later return."},"court_order":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court decision that put the employer on the register, when a court did, as the register cites it."},"conduct_adjustment_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the employer entered the conduct-adjustment register; `conduct_adjustment` only."},"agreement_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the conduct-adjustment agreement is published; `conduct_adjustment` only."}},"required":["id","list","party_type","document_type","document","employer_name","establishment","state","inspection_year","workers_involved","cnae","final_decision_date","listed_on","listing_history","court_order","conduct_adjustment_on","agreement_url"]}}},"required":["as_of","query","list","party_type","state","inspection_year","total","page","per_page","total_pages","count","employers"]},"MteSlaveLabourSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MteSlaveLabourSearchData"}}},"MteSlaveLabourEmployerData":{"type":"object","properties":{"found":{"type":"boolean","description":"false for an unknown id, which is also the answer once an employer has left the register."},"id":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"employer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The register and a fingerprint of the listing, e.g. `slave_labour-3f9a0c12d4e5b6a7`: the key."},"list":{"type":"string","enum":["slave_labour","conduct_adjustment"],"description":"`slave_labour` (the register of employers caught keeping workers in conditions analogous to slavery) or `conduct_adjustment` (employers who signed a conduct-adjustment agreement instead)."},"party_type":{"type":"string","enum":["individual","company"],"description":"`individual` (listed by CPF) or `company` (by CNPJ)."},"document_type":{"type":"string","enum":["cpf","cnpj"]},"document":{"type":"string","description":"A CNPJ in full (`12.345.678/0001-90`); a CPF masked (`***.456.789-**`)."},"employer_name":{"type":"string","description":"The employer's name as the register prints it; a CPF inside a name is masked."},"establishment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The establishment inspected (a farm, a site, an address), as printed; a CPF inside it is masked."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter state (UF) of the inspection."},"inspection_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The year of the inspection that found the workers."},"workers_involved":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Workers found in conditions analogous to slavery."},"cnae":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The activity code (CNAE), e.g. `0151-2/01`."},"final_decision_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the administrative decision became final."},"listed_on":{"type":"string","description":"`yyyy-mm-dd` the current listing started."},"listing_history":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"`yyyy-mm-dd`."},"to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`; null while it lasts."}},"required":["from","to"]},"description":"Every period the employer has been on the register: a court can suspend a listing and it can later return."},"court_order":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court decision that put the employer on the register, when a court did, as the register cites it."},"conduct_adjustment_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the employer entered the conduct-adjustment register; `conduct_adjustment` only."},"agreement_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the conduct-adjustment agreement is published; `conduct_adjustment` only."}},"required":["id","list","party_type","document_type","document","employer_name","establishment","state","inspection_year","workers_involved","cnae","final_decision_date","listed_on","listing_history","court_order","conduct_adjustment_on","agreement_url"]},{"type":"null"}]}},"required":["found","id","as_of","employer"]},"MteSlaveLabourEmployerResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MteSlaveLabourEmployerData"}}},"IbamaEmbargoesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Embargoes matching the filters, across every page."},"active":{"type":"number","description":"How many of them are `active`: a person or company's standing at a glance."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"embargoes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"IBAMA's sequence for the term, or `aie-` and the number of a term issued electronically and not yet in IBAMA's main system: the key."},"term_number":{"type":"string","description":"The term's number as IBAMA prints it (numbers repeat across series and reissues)."},"term_series":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The term's series letter, when it has one."},"status":{"type":"string","enum":["active","lifted","cancelled"],"description":"`active` (in force), `lifted` (lifted administratively or by a court) or `cancelled` (cancelled, replaced or deleted): IBAMA's own flags."},"record_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The term's status in IBAMA's system, as IBAMA words it, e.g. `Lavrado`, `Cancelado`."},"embargo_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the embargo was imposed."},"lift_type":{"anyOf":[{"type":"string","enum":["administrative","judicial","pra"]},{"type":"null"}],"description":"How it was lifted: `administrative`, `judicial`, or `pra` (an environmental recovery plan)."},"lift_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was lifted."},"lift_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was lifted, as IBAMA records it."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The embargoed person or company, as IBAMA records it; a CPF inside a name is masked."},"party_type":{"anyOf":[{"type":"string","enum":["individual","company"]},{"type":"null"}],"description":"`individual` (a CPF) or `company` (a CNPJ); null when IBAMA recorded no document."},"document_type":{"anyOf":[{"type":"string","enum":["cpf","cnpj"]},{"type":"null"}]},"document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A CNPJ in full (`12.345.678/0001-90`); a CPF masked (`***.456.789-**`)."},"process_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IBAMA's administrative process."},"infraction_notice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The infraction notice (auto de infração) the embargo came with."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What was embargoed and why, as IBAMA records it."},"state":{"type":"string","description":"Two-letter state (UF) of the embargoed place."},"municipality_code":{"type":"string","description":"The IBGE code of the embargoed place's municipality."},"municipality":{"type":"string"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How IBAMA describes where the place is."},"property_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rural property's name, when IBAMA records one."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"area_ha":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The embargoed area in hectares, when IBAMA measured one."},"area_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the area is, as IBAMA words it, e.g. `Desmatamento`, `Queimada`, `Atividade`."},"last_changed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When IBAMA last changed the term, ISO 8601 in Brasília time."}},"required":["id","term_number","term_series","status","record_status","embargo_date","lift_type","lift_date","lift_reason","name","party_type","document_type","document","process_number","infraction_notice_number","description","state","municipality_code","municipality","location","property_name","latitude","longitude","area_ha","area_type","last_changed_at"]}}},"required":["as_of","query","status","state","municipality_code","from_date","to_date","total","active","page","per_page","total_pages","count","embargoes"]},"IbamaEmbargoesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IbamaEmbargoesSearchData"}}},"IbamaEmbargoData":{"type":"object","properties":{"found":{"type":"boolean"},"id":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"embargo":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"IBAMA's sequence for the term, or `aie-` and the number of a term issued electronically and not yet in IBAMA's main system: the key."},"term_number":{"type":"string","description":"The term's number as IBAMA prints it (numbers repeat across series and reissues)."},"term_series":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The term's series letter, when it has one."},"status":{"type":"string","enum":["active","lifted","cancelled"],"description":"`active` (in force), `lifted` (lifted administratively or by a court) or `cancelled` (cancelled, replaced or deleted): IBAMA's own flags."},"record_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The term's status in IBAMA's system, as IBAMA words it, e.g. `Lavrado`, `Cancelado`."},"embargo_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the embargo was imposed."},"lift_type":{"anyOf":[{"type":"string","enum":["administrative","judicial","pra"]},{"type":"null"}],"description":"How it was lifted: `administrative`, `judicial`, or `pra` (an environmental recovery plan)."},"lift_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was lifted."},"lift_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was lifted, as IBAMA records it."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The embargoed person or company, as IBAMA records it; a CPF inside a name is masked."},"party_type":{"anyOf":[{"type":"string","enum":["individual","company"]},{"type":"null"}],"description":"`individual` (a CPF) or `company` (a CNPJ); null when IBAMA recorded no document."},"document_type":{"anyOf":[{"type":"string","enum":["cpf","cnpj"]},{"type":"null"}]},"document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A CNPJ in full (`12.345.678/0001-90`); a CPF masked (`***.456.789-**`)."},"process_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IBAMA's administrative process."},"infraction_notice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The infraction notice (auto de infração) the embargo came with."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What was embargoed and why, as IBAMA records it."},"state":{"type":"string","description":"Two-letter state (UF) of the embargoed place."},"municipality_code":{"type":"string","description":"The IBGE code of the embargoed place's municipality."},"municipality":{"type":"string"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How IBAMA describes where the place is."},"property_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rural property's name, when IBAMA records one."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"area_ha":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The embargoed area in hectares, when IBAMA measured one."},"area_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the area is, as IBAMA words it, e.g. `Desmatamento`, `Queimada`, `Atividade`."},"last_changed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When IBAMA last changed the term, ISO 8601 in Brasília time."}},"required":["id","term_number","term_series","status","record_status","embargo_date","lift_type","lift_date","lift_reason","name","party_type","document_type","document","process_number","infraction_notice_number","description","state","municipality_code","municipality","location","property_name","latitude","longitude","area_ha","area_type","last_changed_at"]},{"type":"null"}]}},"required":["found","id","as_of","embargo"]},"IbamaEmbargoResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IbamaEmbargoData"}}},"PlanaltoLawsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"measure_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Croma's id for the act: its kind, number and signature year, e.g. `lei-13105-2015`; `cf-1988` for the Constitution."},"type":{"type":"string","enum":["constitution","constitutional_amendment","complementary_law","ordinary_law","delegated_law","decree_law","decree","provisional_measure"],"description":"`constitution`, `constitutional_amendment` (including the six revision amendments of 1994), `complementary_law`, `ordinary_law`, `delegated_law`, `decree_law`, `decree` or `provisional_measure` (a medida provisória)."},"type_label":{"type":"string","description":"The kind as Brazilian law names it: \"Lei\", \"Lei Complementar\", \"Decreto-Lei\", \"Emenda Constitucional\" and so on."},"number":{"type":"string","description":"The act's number as it is cited, e.g. \"13.105\" or \"1.234-A\". Empty for the Constitution."},"year":{"type":"number","description":"The year the act was signed."},"name":{"type":"string","description":"The act's full citation, e.g. \"Lei nº 13.105, de 16 de março de 2015\"."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ementa: the act's own one-line statement of what it does, e.g. \"Código de Processo Civil.\"."},"signed_on":{"type":"string","description":"`yyyy-mm-dd` the act was signed."},"published_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was published in the Diário Oficial da União. Null for the oldest acts, published before the DOU."},"revoked":{"type":"boolean","description":"True when the Presidência marks the whole act as revoked. False does not prove the act is in force: an act can be superseded without a note saying so."},"revoked_by":{"anyOf":[{"type":"object","properties":{"law_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Id of the revoking act, to look it up in turn. Null when the citation names an instrument outside this dataset's id scheme."},"name":{"type":"string","description":"How the revoking act is cited, e.g. \"Lei nº 13.105, de 2015\"."}},"required":["law_id","name"]},{"type":"null"}],"description":"The act that revoked this one, when `revoked` is true and the note names it."},"amended_by":{"type":"array","items":{"type":"object","properties":{"law_id":{"type":"string","description":"Id of the other act, e.g. `lei-13256-2016`. It may be an act this dataset does not hold yet (a medida provisória or a decreto), so a lookup can come back `found: false`."},"name":{"type":"string","description":"How the other act is cited, e.g. \"Lei nº 13.256, de 2016\"."},"changes":{"type":"array","items":{"type":"string","enum":["amended","added","revoked","renumbered"]},"description":"What it did: `amended` (gave a provision new wording), `added` (inserted one), `revoked`, `renumbered`."},"articles":{"type":"array","items":{"type":"string"},"description":"The articles it touched, as they are numbered, e.g. [\"12\", \"1.029\", \"8-A\"]. Empty when every change it made sits outside an article (a heading, an annex)."}},"required":["law_id","name","changes","articles"]},"description":"Later acts whose changes the text records in its notes, most recent first, each with the articles it touched."},"official_url":{"type":"string","description":"The act's page at the Presidência."},"consolidated_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Presidência's consolidated version of the act, when it keeps one apart from the original."},"veto_message_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The presidential veto message, when the act was partly vetoed."},"measure_status":{"anyOf":[{"type":"string","enum":["pending","converted","lapsed","rejected","prejudiced","revoked"]},{"type":"null"}],"description":"Where a medida provisória stands: `pending` (before Congress), `converted` (into a law, named in `converted_into`), `lapsed` (it expired unvoted), `rejected`, `prejudiced` (set aside without a vote) or `revoked`. Null for every other kind, and for the pre-2001 medidas provisórias whose index records only their chain of monthly editions."},"measure_status_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A medida provisória's standing in the Presidência's own words, e.g. \"Convertida Lei nº 15.347, de 2026\" or \"Vigência encerrada Ato nº 101, de 2024\"."},"converted_into":{"anyOf":[{"type":"object","properties":{"law_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Id of the law, to look it up in turn."},"name":{"type":"string","description":"How the law is cited, e.g. \"Lei nº 15.347, de 2026\"."}},"required":["law_id","name"]},{"type":"null"}],"description":"The law a medida provisória was converted into."}},"required":["id","type","type_label","number","year","name","summary","signed_on","published_on","revoked","revoked_by","amended_by","official_url","consolidated_url","veto_message_url","measure_status","measure_status_note","converted_into"]}}},"required":["as_of","query","type","measure_status","number","year","from_date","to_date","total","page","per_page","total_pages","count","results"]},"PlanaltoLawsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlanaltoLawsSearchData"}}},"PlanaltoLawData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"law_id":{"type":"string"},"article":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The article asked for, as the text numbers it. Null when none was."},"article_found":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether that article is in the text. Null when no article was asked for."},"law":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Croma's id for the act: its kind, number and signature year, e.g. `lei-13105-2015`; `cf-1988` for the Constitution."},"type":{"type":"string","enum":["constitution","constitutional_amendment","complementary_law","ordinary_law","delegated_law","decree_law","decree","provisional_measure"],"description":"`constitution`, `constitutional_amendment` (including the six revision amendments of 1994), `complementary_law`, `ordinary_law`, `delegated_law`, `decree_law`, `decree` or `provisional_measure` (a medida provisória)."},"type_label":{"type":"string","description":"The kind as Brazilian law names it: \"Lei\", \"Lei Complementar\", \"Decreto-Lei\", \"Emenda Constitucional\" and so on."},"number":{"type":"string","description":"The act's number as it is cited, e.g. \"13.105\" or \"1.234-A\". Empty for the Constitution."},"year":{"type":"number","description":"The year the act was signed."},"name":{"type":"string","description":"The act's full citation, e.g. \"Lei nº 13.105, de 16 de março de 2015\"."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ementa: the act's own one-line statement of what it does, e.g. \"Código de Processo Civil.\"."},"signed_on":{"type":"string","description":"`yyyy-mm-dd` the act was signed."},"published_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was published in the Diário Oficial da União. Null for the oldest acts, published before the DOU."},"revoked":{"type":"boolean","description":"True when the Presidência marks the whole act as revoked. False does not prove the act is in force: an act can be superseded without a note saying so."},"revoked_by":{"anyOf":[{"type":"object","properties":{"law_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Id of the revoking act, to look it up in turn. Null when the citation names an instrument outside this dataset's id scheme."},"name":{"type":"string","description":"How the revoking act is cited, e.g. \"Lei nº 13.105, de 2015\"."}},"required":["law_id","name"]},{"type":"null"}],"description":"The act that revoked this one, when `revoked` is true and the note names it."},"amended_by":{"type":"array","items":{"type":"object","properties":{"law_id":{"type":"string","description":"Id of the other act, e.g. `lei-13256-2016`. It may be an act this dataset does not hold yet (a medida provisória or a decreto), so a lookup can come back `found: false`."},"name":{"type":"string","description":"How the other act is cited, e.g. \"Lei nº 13.256, de 2016\"."},"changes":{"type":"array","items":{"type":"string","enum":["amended","added","revoked","renumbered"]},"description":"What it did: `amended` (gave a provision new wording), `added` (inserted one), `revoked`, `renumbered`."},"articles":{"type":"array","items":{"type":"string"},"description":"The articles it touched, as they are numbered, e.g. [\"12\", \"1.029\", \"8-A\"]. Empty when every change it made sits outside an article (a heading, an annex)."}},"required":["law_id","name","changes","articles"]},"description":"Later acts whose changes the text records in its notes, most recent first, each with the articles it touched."},"official_url":{"type":"string","description":"The act's page at the Presidência."},"consolidated_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Presidência's consolidated version of the act, when it keeps one apart from the original."},"veto_message_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The presidential veto message, when the act was partly vetoed."},"measure_status":{"anyOf":[{"type":"string","enum":["pending","converted","lapsed","rejected","prejudiced","revoked"]},{"type":"null"}],"description":"Where a medida provisória stands: `pending` (before Congress), `converted` (into a law, named in `converted_into`), `lapsed` (it expired unvoted), `rejected`, `prejudiced` (set aside without a vote) or `revoked`. Null for every other kind, and for the pre-2001 medidas provisórias whose index records only their chain of monthly editions."},"measure_status_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A medida provisória's standing in the Presidência's own words, e.g. \"Convertida Lei nº 15.347, de 2026\" or \"Vigência encerrada Ato nº 101, de 2024\"."},"converted_into":{"anyOf":[{"type":"object","properties":{"law_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Id of the law, to look it up in turn."},"name":{"type":"string","description":"How the law is cited, e.g. \"Lei nº 15.347, de 2026\"."}},"required":["law_id","name"]},{"type":"null"}],"description":"The law a medida provisória was converted into."},"amends":{"type":"array","items":{"type":"object","properties":{"law_id":{"type":"string","description":"Id of the other act, e.g. `lei-13256-2016`. It may be an act this dataset does not hold yet (a medida provisória or a decreto), so a lookup can come back `found: false`."},"name":{"type":"string","description":"How the other act is cited, e.g. \"Lei nº 13.256, de 2016\"."},"changes":{"type":"array","items":{"type":"string","enum":["amended","added","revoked","renumbered"]},"description":"What it did: `amended` (gave a provision new wording), `added` (inserted one), `revoked`, `renumbered`."},"articles":{"type":"array","items":{"type":"string"},"description":"The articles it touched, as they are numbered, e.g. [\"12\", \"1.029\", \"8-A\"]. Empty when every change it made sits outside an article (a heading, an annex)."}},"required":["law_id","name","changes","articles"]},"description":"Earlier acts this one changed, as their own notes record it, each with the articles it touched there."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the text."},"offset":{"type":"number","description":"First character of the range."},"total_length":{"type":"number","description":"Length of the whole text, or of the requested article, in characters."},"has_more":{"type":"boolean","description":"Whether the text continues past this range."},"next_offset":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pass this back as `offset` to read on. Null at the end."}},"required":["text","offset","total_length","has_more","next_offset"]},{"type":"null"}],"description":"A range of the act's text (or of one article), or null when there is none to return."}},"required":["id","type","type_label","number","year","name","summary","signed_on","published_on","revoked","revoked_by","amended_by","official_url","consolidated_url","veto_message_url","measure_status","measure_status_note","converted_into","amends","content"]},{"type":"null"}]}},"required":["as_of","found","law_id","article","article_found","law"]},"PlanaltoLawResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PlanaltoLawData"}}},"CorteConstitucionalRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"reporting_judge":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's number in canonical form: the type code, the number padded to three digits with its letter suffix if any, and the two-digit year, e.g. \"T-013/25\", \"SU-502/25\", \"A-006/25\", \"C-155A/93\". A lookup accepts the court's own notation too (\"SU.502/25\", \"A. 006/25\", \"T-013-25\")."},"number":{"type":"string","description":"The ruling's number exactly as the court prints it, e.g. \"T-013/25\", \"SU.502/25\", \"A. 006/25\"."},"relatoria_id":{"type":"string","description":"The court's internal identifier for the ruling, e.g. `47977`. The rulings listed in `related_relatoria_ids` use the same identifier, and the ruling lookup accepts it."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of ruling as the court names it: \"Tutela\", \"Constitucionalidad\", \"Sentencia de unificación\" or \"Auto\"."},"type_code":{"type":"string","enum":["T","C","SU","A"],"description":"The kind of ruling as a code: `T` tutela, `C` constitucionalidad, `SU` unificación, `A` auto."},"year":{"type":"number","description":"The year of the ruling (the 2025 of T-013/25)."},"ruling_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the court handed the ruling down."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the court published the ruling. Null on most rulings before 2016, which the court lists without one."},"proceeding_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of proceeding, e.g. \"Acciones de Tutela\", \"Demandas de inconstitucionalidad\", \"Conflictos de jurisdicción\"."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber as the court records it: \"Sala plena/Revisión\" for almost every ruling, or the name of a follow-up chamber for the ones it monitors."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number (expediente), e.g. \"T-10417884\", \"D-15234\", \"CJU-6063\"."},"reporting_judges":{"type":"array","items":{"type":"string"},"column":"string[]","description":"The magistrado or magistrados ponentes, as the court names them."},"reporting_judge_keys":{"type":"array","items":{"type":"string"},"column":"string[]","description":"The same names in canonical form (lowercased, unaccented, spaces hyphenated: \"jorge-enrique-ibanez-najar\"), which is what the `reporting_judge` filter matches."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The topics the relatoría records for the ruling. Null when it records none."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's synopsis of the ruling. Null when it publishes none."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided: the RESUELVE of the ruling, as the relatoría records it."},"rights_invoked":{"type":"array","items":{"type":"string"},"description":"The rights the relatoría records as at stake in the case. Empty when it records none."},"rights_protected":{"type":"array","items":{"type":"string"},"description":"The rights the court protected, for a tutela that granted them. Empty otherwise."},"lower_instances":{"type":"array","items":{"type":"string"},"description":"The lower-court decisions the ruling reviewed, as the relatoría lists them. Empty when there were none."},"related_relatoria_ids":{"type":"array","items":{"type":"string"},"description":"`relatoria_id`s of the rulings the relatoría links to this one. Each can be looked up in turn."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the relatoría last updated the ruling's record, as an ISO 8601 timestamp in Bogotá time."},"official_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ruling's page on the Corte Constitucional's own site, where the full document is published."}},"required":["id","number","relatoria_id","type","type_code","year","ruling_date","publication_date","proceeding_type","chamber","registration_number","reporting_judges","reporting_judge_keys","subject","summary","decision","rights_invoked","rights_protected","lower_instances","related_relatoria_ids","updated_at","official_url"]}}},"required":["as_of","query","type","year","registration_number","reporting_judge","from_date","to_date","total","page","per_page","total_pages","count","results"]},"CorteConstitucionalRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CorteConstitucionalRulingsSearchData"}}},"CorteConstitucionalRulingData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"ruling_id":{"type":"string"},"ruling":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The ruling's number in canonical form: the type code, the number padded to three digits with its letter suffix if any, and the two-digit year, e.g. \"T-013/25\", \"SU-502/25\", \"A-006/25\", \"C-155A/93\". A lookup accepts the court's own notation too (\"SU.502/25\", \"A. 006/25\", \"T-013-25\")."},"number":{"type":"string","description":"The ruling's number exactly as the court prints it, e.g. \"T-013/25\", \"SU.502/25\", \"A. 006/25\"."},"relatoria_id":{"type":"string","description":"The court's internal identifier for the ruling, e.g. `47977`. The rulings listed in `related_relatoria_ids` use the same identifier, and the ruling lookup accepts it."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of ruling as the court names it: \"Tutela\", \"Constitucionalidad\", \"Sentencia de unificación\" or \"Auto\"."},"type_code":{"type":"string","enum":["T","C","SU","A"],"description":"The kind of ruling as a code: `T` tutela, `C` constitucionalidad, `SU` unificación, `A` auto."},"year":{"type":"number","description":"The year of the ruling (the 2025 of T-013/25)."},"ruling_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the court handed the ruling down."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the court published the ruling. Null on most rulings before 2016, which the court lists without one."},"proceeding_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of proceeding, e.g. \"Acciones de Tutela\", \"Demandas de inconstitucionalidad\", \"Conflictos de jurisdicción\"."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber as the court records it: \"Sala plena/Revisión\" for almost every ruling, or the name of a follow-up chamber for the ones it monitors."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number (expediente), e.g. \"T-10417884\", \"D-15234\", \"CJU-6063\"."},"reporting_judges":{"type":"array","items":{"type":"string"},"column":"string[]","description":"The magistrado or magistrados ponentes, as the court names them."},"reporting_judge_keys":{"type":"array","items":{"type":"string"},"column":"string[]","description":"The same names in canonical form (lowercased, unaccented, spaces hyphenated: \"jorge-enrique-ibanez-najar\"), which is what the `reporting_judge` filter matches."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The topics the relatoría records for the ruling. Null when it records none."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's synopsis of the ruling. Null when it publishes none."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided: the RESUELVE of the ruling, as the relatoría records it."},"rights_invoked":{"type":"array","items":{"type":"string"},"description":"The rights the relatoría records as at stake in the case. Empty when it records none."},"rights_protected":{"type":"array","items":{"type":"string"},"description":"The rights the court protected, for a tutela that granted them. Empty otherwise."},"lower_instances":{"type":"array","items":{"type":"string"},"description":"The lower-court decisions the ruling reviewed, as the relatoría lists them. Empty when there were none."},"related_relatoria_ids":{"type":"array","items":{"type":"string"},"description":"`relatoria_id`s of the rulings the relatoría links to this one. Each can be looked up in turn."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the relatoría last updated the ruling's record, as an ISO 8601 timestamp in Bogotá time."},"official_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ruling's page on the Corte Constitucional's own site, where the full document is published."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the ruling's text."},"offset":{"type":"number","description":"First character of the range, which is where the reading actually started."},"total_length":{"type":"number","description":"Length of the whole text in characters, however much of it this response carries."},"has_more":{"type":"boolean","description":"Whether the text continues past this range."},"next_offset":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pass this back as `offset` to read the next range. Null at the end of the text."}},"required":["text","offset","total_length","has_more","next_offset"]},{"type":"null"}],"description":"A range of the ruling's text, or null when the court published none."}},"required":["id","number","relatoria_id","type","type_code","year","ruling_date","publication_date","proceeding_type","chamber","registration_number","reporting_judges","reporting_judge_keys","subject","summary","decision","rights_invoked","rights_protected","lower_instances","related_relatoria_ids","updated_at","official_url","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"CorteConstitucionalRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CorteConstitucionalRulingData"}}},"CorteSupremaRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_tutela":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"reporting_judge":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's identifier in the Corte Suprema's relatoría, e.g. \"978662\". The ruling lookup accepts it."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ruling's number as the court prints it (número de providencia), e.g. \"AC6049-2026\", \"SL1234-2024\", \"STC5959-2026\". Null on most older rulings, which the court lists without one."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of ruling as the court names it (tipo de providencia): \"SENTENCIA\", \"AUTO\", \"AUTO INTERLOCUTORIO\"."},"proceeding_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of proceeding (clase de actuación), e.g. \"RECURSO DE CASACIÓN\", \"ACCIÓN DE TUTELA - PRIMERA INSTANCIA\", \"CONFLICTO DE COMPETENCIA\". Null when the court records none."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that handed the ruling down, as the court names it, e.g. \"SALA DE CASACIÓN CIVIL\", \"Sala de Casación Penal\", \"SALA DE DESCONGESTIÓN LABORAL N.º 1\", \"SALA PLENA - NEGOCIOS GENERALES\"."},"chamber_group":{"anyOf":[{"type":"string","enum":["civil","laboral","penal","plena","constitucional","negocios-generales"]},{"type":"null"}],"description":"The chamber as one of six groups, which is what the `chamber` filter matches: `civil`, `laboral`, `penal` (the criminal cassation chamber and its special chambers), `plena`, and the historic `constitucional` and `negocios-generales`."},"is_tutela":{"type":"boolean","description":"Whether the ruling decides a tutela, as the court marks it. False for the chambers' own matters."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number (número de proceso) as the court prints it: the 23-digit radicado on modern rulings, e.g. \"11001-02-03-000-2026-04999-00\". Null on most historic rulings."},"registration_digits":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The digits of `registration_number` alone, without dashes, spaces or letters. This is what the `registration_number` filter matches."},"reporting_judges":{"type":"array","items":{"type":"string"},"description":"The magistrado or magistrados ponentes, as the court names them."},"reporting_judge_keys":{"type":"array","items":{"type":"string"},"description":"The same names in canonical form (lowercased, unaccented, spaces hyphenated: \"francisco-ternera-barrios\"), which is what the `reporting_judge` filter matches."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of the ruling."},"ruling_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the court handed the ruling down."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's summary of the ruling (tema): each topic in capitals followed by what the court held on it, one paragraph per topic. Null when it records none."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The topics the relatoría indexes the ruling under, in order, e.g. [\"CONFLICTO DE COMPETENCIA\", \"COMPETENCIA\"]. Empty when it records none."},"text_status":{"type":"string","enum":["extracted","scanned","unavailable"],"description":"`extracted` when `text` holds the ruling's full text; `scanned` when the court's document is a scanned image with no text in it; `unavailable` when the court publishes no document for the ruling."},"text_source":{"type":"string","enum":["html","pdf","doc","none"],"description":"The format of the court's document the text comes from: `html`, `pdf` or `doc` (a Word file). `none` when the court publishes no document."},"official_url":{"type":"string","description":"The link to the ruling's document as the court publishes it, in the format `text_source` names; the PDF when the court publishes no text of the ruling."}},"required":["id","number","type","proceeding_class","chamber","chamber_group","is_tutela","registration_number","registration_digits","reporting_judges","reporting_judge_keys","year","ruling_date","subject","descriptors","text_status","text_source","official_url"]}}},"required":["as_of","query","chamber","type","is_tutela","year","registration_number","reporting_judge","from_date","to_date","total","page","per_page","total_pages","count","results"]},"CorteSupremaRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CorteSupremaRulingsSearchData"}}},"CorteSupremaRulingData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"ruling_id":{"type":"string"},"ruling":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The ruling's identifier in the Corte Suprema's relatoría, e.g. \"978662\". The ruling lookup accepts it."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ruling's number as the court prints it (número de providencia), e.g. \"AC6049-2026\", \"SL1234-2024\", \"STC5959-2026\". Null on most older rulings, which the court lists without one."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of ruling as the court names it (tipo de providencia): \"SENTENCIA\", \"AUTO\", \"AUTO INTERLOCUTORIO\"."},"proceeding_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of proceeding (clase de actuación), e.g. \"RECURSO DE CASACIÓN\", \"ACCIÓN DE TUTELA - PRIMERA INSTANCIA\", \"CONFLICTO DE COMPETENCIA\". Null when the court records none."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that handed the ruling down, as the court names it, e.g. \"SALA DE CASACIÓN CIVIL\", \"Sala de Casación Penal\", \"SALA DE DESCONGESTIÓN LABORAL N.º 1\", \"SALA PLENA - NEGOCIOS GENERALES\"."},"chamber_group":{"anyOf":[{"type":"string","enum":["civil","laboral","penal","plena","constitucional","negocios-generales"]},{"type":"null"}],"description":"The chamber as one of six groups, which is what the `chamber` filter matches: `civil`, `laboral`, `penal` (the criminal cassation chamber and its special chambers), `plena`, and the historic `constitucional` and `negocios-generales`."},"is_tutela":{"type":"boolean","description":"Whether the ruling decides a tutela, as the court marks it. False for the chambers' own matters."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number (número de proceso) as the court prints it: the 23-digit radicado on modern rulings, e.g. \"11001-02-03-000-2026-04999-00\". Null on most historic rulings."},"registration_digits":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The digits of `registration_number` alone, without dashes, spaces or letters. This is what the `registration_number` filter matches."},"reporting_judges":{"type":"array","items":{"type":"string"},"description":"The magistrado or magistrados ponentes, as the court names them."},"reporting_judge_keys":{"type":"array","items":{"type":"string"},"description":"The same names in canonical form (lowercased, unaccented, spaces hyphenated: \"francisco-ternera-barrios\"), which is what the `reporting_judge` filter matches."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of the ruling."},"ruling_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the court handed the ruling down."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The relatoría's summary of the ruling (tema): each topic in capitals followed by what the court held on it, one paragraph per topic. Null when it records none."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The topics the relatoría indexes the ruling under, in order, e.g. [\"CONFLICTO DE COMPETENCIA\", \"COMPETENCIA\"]. Empty when it records none."},"text_status":{"type":"string","enum":["extracted","scanned","unavailable"],"description":"`extracted` when `text` holds the ruling's full text; `scanned` when the court's document is a scanned image with no text in it; `unavailable` when the court publishes no document for the ruling."},"text_source":{"type":"string","enum":["html","pdf","doc","none"],"description":"The format of the court's document the text comes from: `html`, `pdf` or `doc` (a Word file). `none` when the court publishes no document."},"official_url":{"type":"string","description":"The link to the ruling's document as the court publishes it, in the format `text_source` names; the PDF when the court publishes no text of the ruling."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the ruling's text."},"offset":{"type":"number","description":"First character of the range, which is where the reading actually started."},"total_length":{"type":"number","description":"Length of the whole text in characters, however much of it this response carries."},"has_more":{"type":"boolean","description":"Whether the text continues past this range."},"next_offset":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pass this back as `offset` to read the next range. Null at the end of the text."}},"required":["text","offset","total_length","has_more","next_offset"]},{"type":"null"}],"description":"A range of the ruling's text, or null when there is no text (see `text_status`)."}},"required":["id","number","type","proceeding_class","chamber","chamber_group","is_tutela","registration_number","registration_digits","reporting_judges","reporting_judge_keys","year","ruling_date","subject","descriptors","text_status","text_source","official_url","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"CorteSupremaRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CorteSupremaRulingData"}}},"CiiuActivity":{"type":"object","required":["code","description"],"properties":{"code":{"type":["string","null"]},"description":{"type":["string","null"]}}},"ApiError":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","description":"Broad category: invalid_request_error, authentication_error, not_found_error, rate_limit_error, upstream_error, api_error."},"code":{"type":"string","description":"Machine-readable specific code."},"message":{"type":"string","description":"Human-readable explanation, safe to surface in UI."},"param":{"type":"string","description":"Field that triggered the error. Present on validation errors."},"details":{"type":"object","description":"Free-form structured detail."}}}}},"Pagination":{"type":"object","required":["total","page_size","total_pages","page"],"properties":{"total":{"type":"integer"},"page_size":{"type":"integer"},"total_pages":{"type":"integer"},"page":{"type":"integer"}}},"BrowsePagination":{"type":"object","required":["page","page_size","has_more"],"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"},"has_more":{"type":"boolean"}}},"JobEnvelope":{"type":"object","required":["job","data","error"],"description":"Returned by async-capable endpoints (202) and by GET /jobs/{id}. `data` holds the endpoint's normal result once `status` is `completed`; `error` is populated once `status` is `failed`.","properties":{"job":{"type":"object","required":["id","status","endpoint","created_at","finished_at","status_url"],"properties":{"id":{"type":"string"},"status":{"type":"string","enum":["queued","running","completed","failed","canceled","expired"]},"endpoint":{"type":"string","description":"The endpoint path that created this job."},"created_at":{"type":["string","null"],"format":"date-time"},"finished_at":{"type":["string","null"],"format":"date-time"},"status_url":{"type":"string","format":"uri","description":"GET this URL to poll the job."}}},"data":{"description":"The endpoint's normal result object once completed; null until then.","oneOf":[{"type":"object"},{"type":"null"}]},"error":{"description":"Populated once the job has failed; null otherwise.","oneOf":[{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}},{"type":"null"}]}}},"BatchItemError":{"type":"object","required":["type","code","message"],"description":"Per-item error envelope, same shape as the single endpoint's error.","properties":{"type":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}},"BatchSummary":{"type":"object","required":["total","completed","errors","cache_hits"],"properties":{"total":{"type":"integer"},"completed":{"type":"integer"},"errors":{"type":"integer"},"cache_hits":{"type":"integer"}}},"AdresAffiliation":{"type":"object","description":"One reported affiliation from BDUA.","required":["status","entity","regime","effective_date","termination_date","affiliate_type"],"properties":{"status":{"type":["string","null"],"description":"Affiliation state, e.g. `ACTIVO` or `RETIRADO`."},"entity":{"type":["string","null"],"description":"The entity (EPS / caja de compensación) that reported the affiliation."},"regime":{"type":["string","null"],"description":"`CONTRIBUTIVO` or `SUBSIDIADO`."},"effective_date":{"type":["string","null"],"description":"Effective affiliation start date (DD/MM/YYYY)."},"termination_date":{"type":["string","null"],"description":"Affiliation end date (DD/MM/YYYY). `31/12/2999` means still active with the entity."},"affiliate_type":{"type":["string","null"],"description":"Affiliate type, e.g. `COTIZANTE` or `BENEFICIARIO`."}}},"SimitInfraction":{"type":"object","required":["code","description","amount"],"description":"A traffic infraction code within a SIMIT fine.","properties":{"code":{"type":["string","null"],"description":"Infraction code, e.g. `C40`."},"description":{"type":["string","null"]},"amount":{"type":["number","null"]}}},"SimitPaymentProjection":{"type":"object","required":["description","amount","date"],"description":"A payment projection (deadline + amount) for a SIMIT fine.","properties":{"description":{"type":["string","null"]},"amount":{"type":["number","null"]},"date":{"type":["string","null"],"format":"date"},"days":{"type":["number","null"]},"instructions":{"type":["string","null"]}}},"SimitOffender":{"type":"object","required":["document_type","document_number","name"],"description":"The party tied to a SIMIT fine (the source masks the name).","properties":{"document_type":{"type":["string","null"]},"document_number":{"type":["string","null"]},"name":{"type":["string","null"]}}},"SimitFine":{"type":"object","required":["ticket_number","plate","amount","amount_payable"],"description":"A SIMIT fine (comparendo or multa).","properties":{"ticket_number":{"type":["string","null"]},"status":{"type":["string","null"]},"is_comparendo":{"type":["boolean","null"]},"plate":{"type":["string","null"]},"traffic_authority":{"type":["string","null"]},"department":{"type":["string","null"]},"amount":{"type":["number","null"]},"amount_payable":{"type":["number","null"]},"infraction_date":{"type":["string","null"],"format":"date"},"offender":{"$ref":"#/components/schemas/SimitOffender"},"infractions":{"type":"array","items":{"$ref":"#/components/schemas/SimitInfraction"}},"payment_projections":{"type":"array","items":{"$ref":"#/components/schemas/SimitPaymentProjection"}}}},"SatLimaDebtItem":{"type":"object","required":["group","reference","amount","status"],"description":"A single outstanding debt item from a SAT Lima account.","properties":{"group":{"type":["string","null"],"description":"Human label for the debt group (e.g. Papeletas, Impuesto vehicular)."},"group_code":{"type":["number","null"]},"concept_code":{"type":["number","null"]},"reference":{"type":["string","null"]},"document":{"type":["string","null"]},"plate":{"type":["string","null"]},"amount":{"type":["number","null"],"description":"Outstanding amount (PEN)."},"amount_with_discount":{"type":["number","null"]},"status":{"type":["string","null"]},"year":{"type":["number","null"]},"installment":{"type":["string","null"]},"due_date":{"type":["string","null"],"format":"date"},"infraction_date":{"type":["string","null"],"format":"date"},"violation_code":{"type":["string","null"]},"violation":{"type":["string","null"]},"regulation":{"type":["string","null"]}}},"WebSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"type":"object","required":["url","title","publication_date","author","highlights","score"],"properties":{"url":{"type":"string","format":"uri"},"title":{"type":["string","null"]},"publication_date":{"type":["string","null"],"format":"date-time"},"author":{"type":["string","null"]},"highlights":{"type":"array","items":{"type":"string"}},"score":{"type":["number","null"]}}}}}}}},"PageMetadata":{"type":"object","required":["title","author","published_at","image"],"properties":{"title":{"type":["string","null"]},"author":{"type":["string","null"]},"published_at":{"type":["string","null"]},"image":{"type":["string","null"],"format":"uri"}}},"ExtractMarkdownResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["url","markdown","metadata"],"properties":{"url":{"type":"string","format":"uri","description":"The page that was read, after any redirects."},"markdown":{"type":"string"},"metadata":{"oneOf":[{"$ref":"#/components/schemas/PageMetadata"},{"type":"null"}],"description":"Null unless `include_metadata` was true."}}}}},"StructuredDataResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["url","result"],"properties":{"url":{"type":"string","format":"uri","description":"The page that was read, after any redirects."},"result":{"type":"object","additionalProperties":true,"description":"The object described by the `json_schema` you sent."}}}}},"ResearchSource":{"type":"object","required":["title","url"],"properties":{"title":{"type":["string","null"]},"url":{"type":"string","format":"uri"}}},"ResearchReportResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["query","report","sources","pages_analyzed"],"properties":{"query":{"type":"string","description":"Echoes the question asked."},"report":{"type":"string","description":"The report in Markdown. Bracketed numbers such as `[1]` index into `sources`."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/ResearchSource"}},"pages_analyzed":{"type":"integer","description":"How many sources the report drew on."}}}}},"ConsejoEstadoProvidenciaSummary":{"type":"object","required":["radicado","tipo","seccion","fecha","ponente","demandante","demandado","norma_demandada","descriptores","es_unificacion","es_extension","url"],"properties":{"radicado":{"type":["string","null"],"description":"Número de proceso."},"tipo":{"type":["string","null"],"enum":["AUTO","CONCEPTO","SENTENCIA",null]},"seccion":{"type":["string","null"]},"fecha":{"type":["string","null"],"description":"ISO `YYYY-MM-DD` when parseable."},"ponente":{"type":["string","null"]},"demandante":{"type":["string","null"]},"demandado":{"type":["string","null"]},"norma_demandada":{"type":["string","null"]},"descriptores":{"type":"array","items":{"type":"string"}},"es_unificacion":{"type":"boolean"},"es_extension":{"type":"boolean"},"url":{"type":["string","null"],"description":"Public content permalink, or null when the row exposes no stable address."}}},"ConsejoEstadoProvidencia":{"allOf":[{"$ref":"#/components/schemas/ConsejoEstadoProvidenciaSummary"},{"type":"object","required":["texto"],"properties":{"texto":{"type":["string","null"],"description":"Cleaned full text."}}}]},"SiemEstablishmentSummary":{"type":"object","required":["establishment_id","commercial_name","chamber","state","state_code"],"properties":{"establishment_id":{"type":"string","description":"Opaque id; pass it to `siem-establishment` for the full profile."},"commercial_name":{"type":["string","null"]},"chamber":{"type":["string","null"]},"state":{"type":["string","null"]},"state_code":{"type":["integer","null"],"description":"INEGI state code (1-32)."}}},"SiemLocation":{"type":"object","required":["street","exterior_number","interior_number","neighborhood","postal_code","municipality","between_streets","phone","email","website"],"properties":{"street":{"type":["string","null"]},"exterior_number":{"type":["string","null"]},"interior_number":{"type":["string","null"]},"neighborhood":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"municipality":{"type":["string","null"],"description":"Locality / municipality name as reported."},"between_streets":{"type":["string","null"],"description":"Cross streets (\"entre calles\"), joined when both are present."},"phone":{"type":["string","null"]},"email":{"type":["string","null"]},"website":{"type":["string","null"]}}},"SiemProfile":{"type":"object","required":["start_date","employees","women_employees","exports","imports","government_supplier","activities","chamber","business_group"],"properties":{"start_date":{"type":["string","null"],"format":"date"},"employees":{"type":["integer","null"]},"women_employees":{"type":["integer","null"]},"exports":{"type":"boolean"},"imports":{"type":"boolean"},"government_supplier":{"type":"boolean"},"activities":{"type":"array","items":{"type":"string"}},"chamber":{"type":["string","null"]},"business_group":{"type":["string","null"]}}},"SiemEstablishment":{"type":"object","required":["rfc","legal_name","person_name","commercial_name","main_activity","activity_code","state","state_code","municipality_code","status","public_listing","registration_date","updated_date","expiration_date","location","profile","products","services","export_countries","import_countries"],"properties":{"rfc":{"type":["string","null"]},"legal_name":{"type":["string","null"],"description":"Razón social (personas morales)."},"person_name":{"type":["string","null"],"description":"Full name (personas físicas)."},"commercial_name":{"type":["string","null"]},"main_activity":{"type":["string","null"],"description":"Free-text primary activity the establishment declared."},"activity_code":{"type":["integer","null"],"description":"SCIAN activity code."},"state":{"type":["string","null"]},"state_code":{"type":["integer","null"]},"municipality_code":{"type":["integer","null"],"description":"INEGI municipality code."},"status":{"type":["string","null"],"description":"Registration status (e.g. `Actualizado`, `Vencido`)."},"public_listing":{"type":"boolean","description":"Whether the establishment opted into public listing."},"registration_date":{"type":["string","null"],"format":"date"},"updated_date":{"type":["string","null"],"format":"date"},"expiration_date":{"type":["string","null"],"format":"date"},"location":{"oneOf":[{"$ref":"#/components/schemas/SiemLocation"},{"type":"null"}]},"profile":{"oneOf":[{"$ref":"#/components/schemas/SiemProfile"},{"type":"null"}]},"products":{"type":"array","items":{"type":"string"}},"services":{"type":"array","items":{"type":"string"}},"export_countries":{"type":"array","items":{"type":"string"}},"import_countries":{"type":"array","items":{"type":"string"}}}}},"headers":{"X-Request-Id":{"description":"Unique id for the request (req_…). Include it in support reports.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left before you are throttled.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"ISO 8601 timestamp when the window resets.","schema":{"type":"string","format":"date-time"}},"X-Cache":{"description":"HIT or MISS. Cached hits still count against your quota.","schema":{"type":"string","enum":["HIT","MISS"]}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"Idempotency-Key":{"description":"The `Idempotency-Key` the request carried, echoed back unchanged. Absent when the request sent none.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Quota policy for this endpoint as an IETF RateLimit-Policy structured field, e.g. `\"default\";q=100;w=86400` (100 requests per 86400-second window per organization). Endpoints with an extra hourly ceiling list both policies, e.g. `\"webSearch\";q=10;w=3600, \"default\";q=100;w=86400`. Present on every response, including 401 and 429.","schema":{"type":"string","example":"\"default\";q=100;w=86400"}},"Deprecation":{"description":"Present only on an endpoint version scheduled for removal: the date the deprecation took effect (RFC 9745). A `Sunset` header and a `Link` with `rel=\"successor-version\"` accompany it. Policy: https://docs.usecroma.com/versioning","schema":{"type":"string","example":"@1767225600"}},"Sunset":{"description":"Present only on an endpoint version scheduled for removal: the date after which it answers 410 (RFC 8594). Announced in the changelog at least 90 days ahead.","schema":{"type":"string","format":"date-time","example":"Wed, 01 Apr 2026 00:00:00 GMT"}}},"parameters":{"IdempotencyKey":{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional client-chosen key for this request (any string up to 255 characters, e.g. a UUID). Every Croma operation is an idempotent lookup: repeating a request with the same body returns the same result and creates nothing, so retrying after a timeout or network failure is always safe. The key is echoed back in the `Idempotency-Key` response header so you can correlate a retry with its first attempt. Each attempt that reaches the API counts against the rate limit.","schema":{"type":"string","maxLength":255,"example":"0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b"}},"Prefer":{"name":"Prefer","in":"header","required":false,"description":"Set `wait=N` to hold the connection up to N seconds for an inline result. If the job finishes in time you get the normal 200 body; otherwise a 202 with a `status_url` to poll.","schema":{"type":"string","example":"wait=30"}}}}}