{"openapi":"3.1.0","info":{"title":"Croma Marketplace API","version":"1.0.0","description":"Government-data APIs for Colombia, Peru, Mexico, United States, Brazil, El Salvador, Bolivia, Japan, Chile, and Venezuela, plus 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":"support@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":"RAPPI","entity_type":"juridical","active_only":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/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/emails-search/v1":{"post":{"operationId":"rama_judicial_emails_search","summary":"Rama Judicial Emails Search","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":"^([0-9 .-]{12,40})?$","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. Spaces, dots and hyphens are ignored."},"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/RamaJudicialEmailsSearchResponse"}}}},"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":"^[0-9 .-]{12,40}$","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. Spaces, dots and hyphens are ignored."}},"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/rethus/health-professional/v1":{"post":{"operationId":"rethus_health_professional","summary":"ReTHUS Health Professional","description":"Check whether a person is registered in Colombia's national register of health professionals (ReTHUS) by document number: their titles and professions, the administrative act authorizing each, the reporting entity, and any social service or sanctions on record. `document_type` defaults to `CC`. Returns `found: false` when the document is not in the register.","tags":["Colombia","ReTHUS"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/rethus"},"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","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."}},"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/RethusHealthProfessionalResponse"}}}},"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.","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. Digits only for CC; letters, digits and hyphens for CE, PA and DPO."},"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/policia-rnmc/corrective-measures/v1":{"post":{"operationId":"policia_rnmc_corrective_measures","summary":"Policía Corrective Measures (RNMC)","description":"Check whether a person or company has corrective measures pending in the Policía Nacional's Registro Nacional de Medidas Correctivas (RNMC, Ley 1801 de 2016). `document_type` defaults to `CC`; a cédula also needs its `issue_date`. Returns the verdict, the pending measures, the name on record for a cédula and the register's validation number.","tags":["Colombia","Policía Nacional RNMC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/policia-rnmc"},"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","PA","DPO","NIT"],"default":"CC","description":"Colombian document type. Defaults to `CC`."},"document_number":{"type":"string","minLength":3,"maxLength":30,"description":"Document number (alphanumeric with hyphens allowed)."},"issue_date":{"type":"string","format":"date","default":"","description":"Date the cédula was issued, in yyyy-mm-dd format. Required when `document_type` is `CC`; ignored for the other types."}},"additionalProperties":false},"example":{"document_type":"CC","document_number":"1234567890","issue_date":"2010-01-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/PoliciaRnmcResponse"}}}},"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":"Deprecated since 2026-09-16; stops answering on 2026-09-30. Use `POST /co/funcion-publica/norms-search/v1` instead.\n\nSearch 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`.","deprecated":true,"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":"Deprecated since 2026-09-16; stops answering on 2026-09-30. Use `POST /co/funcion-publica/norm/v1` instead.\n\nResolve 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.","deprecated":true,"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/fiscalia/case/v1":{"post":{"operationId":"fiscalia_case","summary":"Fiscalía Criminal Case by Number","description":"Look up a Colombian criminal case by its 21-digit noticia criminal number, live from the Fiscalía General de la Nación (SPOA): status and closing reason, procedural stage, applicable law, date and place of the facts, the assigned prosecutor's office with its contact details, the offences with their grade, and the non-reserved actions, newest first. Returns `found: false` when the Fiscalía has no case with that number.","tags":["Colombia","Fiscalía General de la Nación"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/fiscalia"},"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":21,"maxLength":21,"pattern":"^\\d{21}$","description":"Número de la noticia criminal (SPOA), de 21 dígitos, p. ej. `110016000050202154481`."}},"additionalProperties":false},"example":{"registration_number":"110016000050202154481"}}}},"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/FiscaliaCaseResponse"}}}},"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/anm/notices-search/v1":{"post":{"operationId":"anm_notices_search","summary":"ANM Notices Search","description":"Search every notice the Agencia Nacional de Minería (Colombia) has published since May 2020 to notify decisions on mining titles and applications: estados, avisos, edictos and notices of general character. Filter by `title_number` (the placa, exact match), `office` (regional office), `type`, `year` and the publication date (`from_date`/`to_date`); free text matches the notice number and the full text. Each result lists every placa the notice covers and links to its document. Read one notice's full text with `anm_notice`. 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","Agencia Nacional de Minería (ANM)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/anm"},"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 notice number and the full text."},"title_number":{"type":"string","maxLength":40,"default":"","description":"Optional placa (mining title or application number), e.g. `ABC-12345`. Exact match; case and spaces are ignored."},"office":{"type":"string","enum":["","bogota","bucaramanga","cali","cartagena","cucuta","ibague","manizales","medellin","nobsa","pasto","quibdo","valledupar"],"default":"","description":"Optional regional office: `bogota`, `bucaramanga`, `cali`, `cartagena`, `cucuta`, `ibague`, `manizales`, `medellin`, `nobsa`, `pasto`, `quibdo` or `valledupar`. The same slug comes back in `office_key`."},"type":{"type":"string","enum":["","estado","aviso","edicto","caracter_general"],"default":"","description":"Optional kind of notice: `estado`, `aviso`, `edicto` or `caracter_general`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of publication. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"office":"bogota","type":"estado"}}}},"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/AnmNoticesSearchResponse"}}}},"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/anm/notice/v1":{"post":{"operationId":"anm_notice","summary":"ANM Notice","description":"Retrieve one notice of the Agencia Nacional de Minería (Colombia) by its `id` from a search result (e.g. `GGDN-2026-P-0378.pdf`) or its `document_url`: its full text, the notice number, kind, regional office, publication date, every placa it covers and the link to its document. The text comes back a character range at a time (`offset`, `limit`); follow `next_offset` until `has_more` is false. Find a `notice_id` with `anm_notices_search`.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Agencia Nacional de Minería (ANM)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/anm"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["notice_id"],"properties":{"notice_id":{"type":"string","minLength":5,"maxLength":400,"description":"The notice's `id` from a search result, e.g. `GGDN-2026-P-0378.pdf`. Its `document_url` works too."},"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":{"notice_id":"GGDN-2026-P-0378.pdf"}}}},"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/AnmNoticeResponse"}}}},"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, the processes it is reported in and 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 (whole pesos, as the registry publishes them), current legitimate holder, validations, and events, each with its `code` (030, 032, 033...), name, date and parties. Set `include_pdf: true` to also receive `pdf_url`, the URL of the official PDF representation. The issuer may protect that PDF with a password; when handing it over, tell the user which passwords to try, in this order: (1) the issuer's NIT without check digit (`issuer.nit`, e.g. 900108281), the most common; (2) the recipient's document number without check digit (`recipient.nit`); (3) the recipient's NIT with its check digit appended. If none works, point the user to DIAN's public catalog (https://catalogo-vpfe.dian.gov.co/User/SearchDocument), where pasting the CUFE downloads DIAN's own graphical representation. Do not try to open or extract a protected PDF with other tools; give the user the link and the password hints instead. A result is reused for 24 hours; pass `cache: false` to read the registry again, for instance after filing an event. `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."},"cache":{"type":"boolean","default":true,"description":"Set to `false` to skip any stored result for this lookup and read the source again. The fresh answer replaces the stored one and is charged as a new request. Default `true`."},"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/dian-muisca/electronic-invoices/v1":{"post":{"operationId":"dian_muisca_electronic_invoices","summary":"DIAN Electronic Invoices","description":"Read the electronic invoices issued to the connected DIAN account holder in one tax year (2023 onward): issuer, dates, invoiced and net amounts, deductible amount, payment method, invoice number and CUFE, with totals. Persons only: runs as your organization's own DIAN connection signed in on its own behalf.\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-muisca"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["year"],"properties":{"year":{"type":"integer","minimum":2023,"maximum":2100,"description":"Tax year (año gravable), from 2023 to the last year that has ended."},"connection_id":{"type":"string","default":"","description":"Optional. Run as this connection (`conn_…`). Empty lets Croma pick among your organization's connections, moving to the next one when one reaches its daily allowance."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"year":2024}}}},"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/DianMuiscaElectronicInvoicesResponse"}}}},"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/dian-muisca/third-party-reports/v1":{"post":{"operationId":"dian_muisca_third_party_reports","summary":"DIAN Third-Party Reports","description":"Read what third parties reported to DIAN about the connected account holder (the person, or the company the connection signs in for) in one tax year (información exógena, 2018 onward): the reporter, the concept and amount, and from 2023 the suggested use in the tax return, additional detail and the filing-threshold summary. Runs as your organization's own DIAN connection.\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-muisca"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["year"],"properties":{"year":{"type":"integer","minimum":2018,"maximum":2100,"description":"Tax year (año gravable), from 2018 to the last year that has ended."},"connection_id":{"type":"string","default":"","description":"Optional. Run as this connection (`conn_…`). Empty lets Croma pick among your organization's connections, moving to the next one when one reaches its daily allowance."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"year":2024}}}},"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/DianMuiscaThirdPartyReportsResponse"}}}},"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/dian-facturacion/access-requests/v1":{"post":{"operationId":"dian_facturacion_access_requests","summary":"DIAN Invoicing Access Request","description":"Ask DIAN to email an access link for its electronic-invoicing system to the address in the person's RUT (for a company, its legal representative's). Register the link as a dian-facturacion connection within 60 minutes. Runs without a connection.","tags":["Colombia","DIAN"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dian-facturacion"},"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","RC","PA","NIT"],"default":"CC","description":"Colombian document type. Defaults to `CC`."},"document_number":{"type":"string","pattern":"^[A-Za-z0-9-]{3,30}$","description":"The document number of the person the access is for (the legal representative's, for a company), without dots or commas. DIAN sends the link to the email registered in that person's RUT."},"company_nit":{"type":"string","pattern":"^(\\d{5,10})?$","default":"","description":"Optional. The NIT of the company the access is for, without the verification digit, dots or dashes; `document_number` is then its legal representative's. Empty asks for the person's own access."}},"additionalProperties":false},"example":{"document_type":"CC","document_number":"1234567890","company_nit":"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/DianFacturacionAccessRequestResponse"}}}},"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-facturacion/issued-documents/v1":{"post":{"operationId":"dian_facturacion_issued_documents","summary":"DIAN Issued Electronic Documents","description":"List the electronic documents the connected account issued in a date range (up to a year): invoices, credit and debit notes, support documents, payroll and events, each with its CUFE, number, dates, recipient, currency, payment form and method, every tax and withholding, total, DIAN status and RADIAN status, with counts and totals per type. Runs as your organization's own dian-facturacion connection.\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-facturacion"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["from_date","to_date"],"properties":{"from_date":{"type":"string","format":"date","description":"First issue date to include, `yyyy-mm-dd`."},"to_date":{"type":"string","format":"date","description":"Last issue date to include, `yyyy-mm-dd`. At most a year after `from_date`."},"connection_id":{"type":"string","default":"","description":"Optional. Run as this connection (`conn_…`). Empty lets Croma pick among your organization's connections, moving to the next one when one reaches its daily allowance."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"from_date":"2026-01-01","to_date":"2026-06-30"}}}},"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/DianFacturacionDocumentsResponse"}}}},"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/dian-facturacion/received-documents/v1":{"post":{"operationId":"dian_facturacion_received_documents","summary":"DIAN Received Electronic Documents","description":"List the electronic documents the connected account received in a date range (up to a year): invoices from its suppliers, credit and debit notes and events, each with its CUFE, number, dates, issuer, currency, payment form and method, every tax and withholding, total, DIAN status and RADIAN status, with counts and totals per type. Runs as your organization's own dian-facturacion connection.\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-facturacion"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["from_date","to_date"],"properties":{"from_date":{"type":"string","format":"date","description":"First issue date to include, `yyyy-mm-dd`."},"to_date":{"type":"string","format":"date","description":"Last issue date to include, `yyyy-mm-dd`. At most a year after `from_date`."},"connection_id":{"type":"string","default":"","description":"Optional. Run as this connection (`conn_…`). Empty lets Croma pick among your organization's connections, moving to the next one when one reaches its daily allowance."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"from_date":"2026-01-01","to_date":"2026-06-30"}}}},"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/DianFacturacionDocumentsResponse"}}}},"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/dian-facturacion/document/v1":{"post":{"operationId":"dian_facturacion_document","summary":"DIAN Electronic Document","description":"Read one electronic document of the connected account in full: header, lines with quantities, prices and taxes, monetary totals, payment terms, notes, the legitimate holder, DIAN's validations, its RADIAN events, and the original XML (UBL 2.1) and PDF. Takes the CUFE and issue date from the issued or received documents. Runs as your organization's own dian-facturacion connection.\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-facturacion"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cufe","issued_on"],"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."},"issued_on":{"type":"string","format":"date","description":"The document's issue date, `yyyy-mm-dd`, as the issued or received documents list it (`issued_on`)."},"connection_id":{"type":"string","default":"","description":"Optional. Run as this connection (`conn_…`). Empty lets Croma pick among your organization's connections, moving to the next one when one reaches its daily allowance."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"cufe":"a1b2c3d4e5f60718a1b2c3d4e5f60718a1b2c3d4e5f60718a1b2c3d4e5f60718a1b2c3d4e5f60718a1b2c3d4e5f60718","issued_on":"2026-03-09"}}}},"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/DianFacturacionDocumentResponse"}}}},"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/dian-facturacion/monthly-reports/v1":{"post":{"operationId":"dian_facturacion_monthly_reports","summary":"DIAN Electronic Invoicing Monthly Report","description":"Read DIAN's monthly electronic-invoicing report for the connected account: documents registered in the month and in the year so far, per document type, issued and received, with amounts, and DIAN's indicators for the last three months. Runs as your organization's own dian-facturacion connection.\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-facturacion"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["year","month"],"properties":{"year":{"type":"integer","minimum":2019,"maximum":2100,"description":"The report's year."},"month":{"type":"integer","minimum":1,"maximum":12,"description":"The report's month, 1 to 12."},"connection_id":{"type":"string","default":"","description":"Optional. Run as this connection (`conn_…`). Empty lets Croma pick among your organization's connections, moving to the next one when one reaches its daily allowance."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"year":2025,"month":12}}}},"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/DianFacturacionMonthlyReportResponse"}}}},"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/dian-facturacion/profile/v1":{"post":{"operationId":"dian_facturacion_profile","summary":"DIAN Electronic Invoicing Profile","description":"Read the connected account's profile in DIAN's electronic-invoicing system: NIT, name, status, the email where it receives invoices, its legal representatives, operation modes and software, and the numbering ranges (prefix, resolution, range, dates). Runs as your organization's own dian-facturacion connection.\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-facturacion"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"connection_id":{"type":"string","default":"","description":"Optional. Run as this connection (`conn_…`). Empty lets Croma pick among your organization's connections, moving to the next one when one reaches its daily allowance."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"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/DianFacturacionProfileResponse"}}}},"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/dian-trade/directory-search/v1":{"post":{"operationId":"dian_trade_directory_search","summary":"DIAN Importers and Exporters Search","description":"Search DIAN's directories of importers and exporters of goods, every year since 2017 and both directories at once: by company name (`query`), `flow` (`import` or `export`), `year`, and `tariff_code` (a 4-digit heading, 6-digit HS subheading or 10-digit subpartida among each company's five main ones). Each result is one company's row in one year's directory: NIT, name, rank, CIF (imports) or FOB (exports) value in US dollars, net weight, declarations or declaration items, and its main subpartidas arancelarias. Newest year first, then by value. Served by Croma (`as_of` says how current the data is), brought up to date weekly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","DIAN Importers and Exporters"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dian-trade"},"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 words matched against the name (razón social) as DIAN prints it."},"flow":{"type":"string","enum":["any","import","export"],"default":"any","description":"Which directory: `import` (importers, valued CIF), `export` (exporters, valued FOB), or `any`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional directory year (2017 or later). 0 searches every year."},"tariff_code":{"type":"string","pattern":"^(?:\\d{4}|\\d{6}|\\d{10})?$","default":"","description":"Optional tariff code, digits only, matched against the five main subpartidas of each row: a 4-digit heading (`8703`), a 6-digit HS subheading (`870323`) or a full 10-digit subpartida (`8703239090`)."},"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":{"flow":"import","year":2025,"tariff_code":"8703"}}}},"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/DianTradeDirectorySearchResponse"}}}},"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-trade/profile/v1":{"post":{"operationId":"dian_trade_profile","summary":"DIAN Company Trade Profile","description":"A Colombian company's foreign trade history by NIT, from DIAN's yearly directories of importers and exporters since 2017: its row in each year's importers directory (rank, CIF value in US dollars, net weight, declarations, main subpartidas arancelarias) and in each year's exporters directory (rank, FOB value, net weight, declaration items, main subpartidas), newest first. `found: false` when the NIT appears in no directory. Served by Croma (`as_of` says how current the data is), brought up to date weekly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","DIAN Importers and Exporters"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dian-trade"},"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":"899999068"}}}},"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/DianTradeProfileResponse"}}}},"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/vuce/tariff/v1":{"post":{"operationId":"vuce_tariff","summary":"VUCE Import Requirements by Subpartida","description":"Retrieve what importing goods into Colombia under one 10-digit subpartida arancelaria requires, from VUCE: the subpartida's description, import regime and whether it needs a prior import license, status, tariff decree and license validity in months, every entity that must approve the import (visto bueno) with its full name, prior requirement, norms and notes, and the minimum description the import declaration must carry, split into sections and fields. Also returns the heading and 6-digit HS code, for joining with trade data. The first ask of a subpartida reads VUCE; later asks within 7 days answer from Croma's stored answer (`served_from`). An unknown subpartida returns `found: false`.\n\n**Lookup endpoint**: answers from Croma's copy when it holds a recent answer for the key, otherwise reads the source and keeps the answer; carries `checked_at` and `served_from`.","x-served-from":"lookup","tags":["Colombia","VUCE"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/vuce"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tariff_code"],"properties":{"tariff_code":{"type":"string","pattern":"^\\d{4}\\.?\\d{2}\\.?\\d{2}\\.?\\d{2}$","description":"The 10-digit Colombian subpartida arancelaria, e.g. `6101909000`. Dots between the groups (`6101.90.90.00`) are accepted."}},"additionalProperties":false},"example":{"tariff_code":"3004902900"}}}},"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/VuceTariffResponse"}}}},"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-arancel/tariff/v1":{"post":{"operationId":"dian_arancel_tariff","summary":"DIAN Tariff Rates by Subpartida","description":"Retrieve the tariff of one 10-digit Colombian subpartida arancelaria from DIAN: its official text (texto oficial) level by level, the physical unit quantities are declared in, the general import duty (gravamen arancelario), the VAT on imports (with exempt or excluded treatment and per-product splits), the preferential import duty under every trade agreement for each country of origin with its preference index, and the trade regime for imports. Every rate carries its validity (valid_from, valid_to) and the norm DIAN cites for it. Pass `date` (yyyy-mm-dd, from 2007-01-01) for the rates in force on that day instead of today's, e.g. to check what applied when a declaration was filed; each date is kept as its own answer. Also returns the heading and 6-digit HS code, for joining with trade data. The first ask of a subpartida reads DIAN; later asks within 7 days answer from Croma's stored answer (`served_from`). An unknown subpartida, or one not yet in force on the date asked, returns `found: false`.\n\n**Lookup endpoint**: answers from Croma's copy when it holds a recent answer for the key, otherwise reads the source and keeps the answer; carries `checked_at` and `served_from`.","x-served-from":"lookup","tags":["Colombia","DIAN Tariff"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dian-arancel"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tariff_code"],"properties":{"tariff_code":{"type":"string","pattern":"^\\d{4}\\.?\\d{2}\\.?\\d{2}\\.?\\d{2}$","description":"The 10-digit Colombian subpartida arancelaria, e.g. `6101909000`. Dots between the groups (`6101.90.90.00`) are accepted."},"date":{"type":"string","pattern":"^(\\d{4}-\\d{2}-\\d{2})?$","default":"","description":"Optional day, `yyyy-mm-dd`, to read the rates in force on that day. Empty is today. History starts on 2007-01-01; a later date returns what is already decreed for it."}},"additionalProperties":false},"example":{"tariff_code":"6101909000"}}}},"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/DianArancelTariffResponse"}}}},"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/dane/labour-market/v1":{"post":{"operationId":"dane_labour_market","summary":"DANE Labour Market","description":"Colombia's labour-market series from DANE's household survey (GEIH): unemployment (TD), employment (TO), participation (TGP) and underemployment (TS) rates and the populations behind them, monthly for the nation (total and cabeceras) since 2001 and for the 13 main cities, as rolling quarters for 23 cities and metropolitan areas since 2007, and as rolling years for 32 cities since 2021. Filter by DIVIPOLA code, territory level, indicator, period type, domain and date range. Newest first. 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","DANE"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dane"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"territory_code":{"type":"string","pattern":"^(?:\\d{2}|\\d{5})?$","default":"","description":"Optional DIVIPOLA code: 2 digits for a department (`44`), 5 for a municipality (`44001`)."},"territory_level":{"type":"string","enum":["","national","region","department","metropolitan_area","city","city_aggregate"],"default":"","description":"Optional kind of territory: `national`, `region`, `department`, `metropolitan_area`, `city` or `city_aggregate` (a group of cities, e.g. the 13 main cities)."},"indicator_code":{"type":"string","enum":["","unemployment_rate","employment_rate","participation_rate","underemployment_rate","working_age_share","unemployment_underemployment_rate","unemployment_potential_labour_force_rate","labour_underutilization_rate","population","working_age_population","labour_force","employed","unemployed","outside_labour_force","underemployed","potential_labour_force"],"default":"","description":"Optional indicator, e.g. `unemployment_rate` (TD), `employment_rate` (TO), `participation_rate` (TGP). Empty returns every indicator."},"period_type":{"type":"string","enum":["","monthly","rolling_quarter","rolling_year"],"default":"","description":"Optional period type: `monthly`, `rolling_quarter` (three months ending in `period`) or `rolling_year` (twelve months ending in `period`)."},"domain":{"type":"string","enum":["","total","urban","rural"],"default":"","description":"Optional domain: `total`, `urban` (cabeceras) or `rural` (centros poblados y rural disperso)."},"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":500,"default":100,"description":"Results per page (1-500)."}},"additionalProperties":false},"example":{"indicator_code":"unemployment_rate","territory_level":"national","period_type":"monthly","domain":"total","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/DaneLabourMarketResponse"}}}},"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/dane/poverty/v1":{"post":{"operationId":"dane_poverty","summary":"DANE Poverty","description":"Colombia's poverty and inequality from DANE: monetary and extreme poverty (incidence and people), Gini coefficient, income per capita and poverty lines for the nation, 23 departments and Bogotá since 2021; and multidimensional poverty (IPM) for the nation and its regions since 2010 and for all 33 departments since 2018, by total, cabeceras and rural. Filter by DIVIPOLA code, territory level, indicator, domain and years. 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","DANE"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dane"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"territory_code":{"type":"string","pattern":"^(?:\\d{2})?$","default":"","description":"Optional 2-digit DIVIPOLA code of a department, e.g. `44` (La Guajira); Bogotá is `11`."},"territory_level":{"type":"string","enum":["","national","region","department"],"default":"","description":"Optional kind of territory: `national`, `region` or `department` (Bogotá counts as a department)."},"indicator_code":{"type":"string","enum":["","monetary_poverty_rate","monetary_poverty_persons","extreme_poverty_rate","extreme_poverty_persons","gini","income_per_capita","poverty_line","extreme_poverty_line","multidimensional_poverty_rate"],"default":"","description":"Optional indicator, e.g. `monetary_poverty_rate`, `extreme_poverty_rate`, `multidimensional_poverty_rate` (IPM), `gini`. Empty returns every indicator."},"domain":{"type":"string","enum":["","total","urban","rural"],"default":"","description":"Optional domain: `total`, `urban` (cabeceras) or `rural` (centros poblados y rural disperso)."},"year_from":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional first year (inclusive). 0 sets no lower bound."},"year_to":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional last year (inclusive). 0 sets no upper bound."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":500,"default":100,"description":"Results per page (1-500)."}},"additionalProperties":false},"example":{"territory_code":"44","indicator_code":"multidimensional_poverty_rate","domain":"total"}}}},"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/DanePovertyResponse"}}}},"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/dane/municipal-ipm/v1":{"post":{"operationId":"dane_municipal_ipm","summary":"DANE Municipal IPM","description":"Multidimensional poverty (IPM) of each of Colombia's 1,122 municipalities from the 2018 census (DANE), by total, cabecera and rural, with the fifteen deprivations behind it (illiteracy, informal work, health insurance, water, overcrowding...). Filter by DIVIPOLA code (a municipality, or every municipality of a department) or by name. 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","DANE"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dane"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"territory_code":{"type":"string","pattern":"^(?:\\d{2}|\\d{5})?$","default":"","description":"Optional DIVIPOLA code: 2 digits for a department (`44`), 5 for a municipality (`44001`)."},"query":{"type":"string","maxLength":100,"default":"","description":"Optional words of the municipality's name, e.g. `riohacha`."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":500,"default":100,"description":"Results per page (1-500)."}},"additionalProperties":false},"example":{"territory_code":"44001"}}}},"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/DaneMunicipalIpmResponse"}}}},"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/dane/census-municipalities/v1":{"post":{"operationId":"dane_census_municipalities","summary":"DANE Census by Municipality","description":"The 2018 national population and housing census (CNPV, DANE) for each of Colombia's 1,122 municipalities: people by sex and age, education, households, dwellings by type and occupancy, public services and internet, dwellings by estrato as billed for electricity, and land use. Filter by DIVIPOLA code (a municipality, or every municipality of a department) or by name. 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","DANE"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/dane"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"territory_code":{"type":"string","pattern":"^(?:\\d{2}|\\d{5})?$","default":"","description":"Optional DIVIPOLA code: 2 digits for a department (`44`), 5 for a municipality (`44001`)."},"query":{"type":"string","maxLength":100,"default":"","description":"Optional words of the municipality's name, e.g. `riohacha`."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":500,"default":100,"description":"Results per page (1-500)."}},"additionalProperties":false},"example":{"territory_code":"44001"}}}},"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/DaneCensusMunicipalitiesResponse"}}}},"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/igac/properties-search/v1":{"post":{"operationId":"igac_properties_search","summary":"IGAC Properties Search","description":"Search the properties (predios) of Colombia's national cadastre administered by IGAC, about 6.8 million in 831 municipalities: by `municipality_code` (DANE), `block_code` (the manzana or vereda, the first 17 digits of a cadastral number), words of the `address`, `economic_destination` (`A` housing, `C` commerce, `D` agricultural and others), `zone` (`urban`/`rural`) or `previous_cadastral_number`. At least a municipality, a block or a previous number is required. Each result carries the 30-digit cadastral number, address, destination, land and built areas, the land zones and every building unit with its use and score. Not for Bogotá, Medellín, Cali, Barranquilla or Antioquia, which keep their own cadastre. Read the appraisal of one with `igac_property`. 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","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"municipality_code":{"type":"string","pattern":"^(\\d{5})?$","default":"","description":"Optional five-digit DANE code of the municipality, e.g. `17013` for Aguadas."},"query":{"type":"string","maxLength":120,"default":"","description":"Optional words matched against the property's address or farm name, e.g. `calle 10` or `la esperanza`."},"block_code":{"type":"string","pattern":"^(\\d{17})?$","default":"","description":"Optional 17-digit code of the manzana (urban) or vereda (rural): the first 17 digits of any property's cadastral number in it, e.g. `17013000100000001`."},"economic_destination":{"type":"string","maxLength":2,"default":"","description":"Optional economic destination code as IGAC assigns it: `A` housing, `B` industrial, `C` commercial, `D` agricultural, `I` institutional, `L` agricultural crops, `M` livestock, `S` urbanized lot not built, among others. Case is ignored."},"zone":{"type":"string","enum":["","urban","rural"],"default":"","description":"Optional: `urban` or `rural`."},"previous_cadastral_number":{"type":"string","pattern":"^(\\d{20})?$","default":"","description":"Optional 20-digit number the property had before the national numbering, e.g. `17013000100010001000`."},"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":{"municipality_code":"17013","economic_destination":"C","zone":"urban"}}}},"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/IgacPropertiesSearchResponse"}}}},"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/igac/property/v1":{"post":{"operationId":"igac_property","summary":"IGAC Property","description":"Retrieve one property of Colombia's national cadastre by its 30-digit número predial nacional, as IGAC's cadastre answers it today: the current avalúo catastral in pesos with its vigencia (whether the municipality's cadastre for that zone is in formación, actualización or conservación, and the year of its last update, since an avalúo carried forward for years is not comparable with a freshly updated one), address, land and built areas, economic destination, every building with its use, score and floors, and the parcel polygon. The first ask of a number reads IGAC; later asks within 30 days answer from Croma's stored answer (`served_from`), which is re-read regularly. Only for the 842 municipalities IGAC administers: a number from Bogotá, Medellín, Cali, Barranquilla or Antioquia returns `found: false`. Find numbers with `igac_properties_search` or a point with `igac_property_by_point`.\n\n**Lookup endpoint**: answers from Croma's copy when it holds a recent answer for the key, otherwise reads the source and keeps the answer; carries `checked_at` and `served_from`.","x-served-from":"lookup","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cadastral_number"],"properties":{"cadastral_number":{"type":"string","pattern":"^[0-9 .-]{30,40}$","description":"The 30-digit número predial nacional, e.g. `170130001000000010001000000000`. Spaces, dots and hyphens are ignored."}},"additionalProperties":false},"example":{"cadastral_number":"170130001000000010001000000000"}}}},"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/IgacPropertyResponse"}}}},"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/igac/property-by-point/v1":{"post":{"operationId":"igac_property_by_point","summary":"IGAC Property by Point","description":"Find the property of Colombia's national cadastre at a point (`latitude`, `longitude`, WGS84) and answer as `igac_property` does: the parcel IGAC draws under the point, then its current avalúo catastral, address, areas, destination, buildings and polygon, served from Croma's stored answer when it holds a recent one. `found: false` when no IGAC parcel contains the point, which includes the cities that keep their own cadastre.\n\n**Lookup endpoint**: answers from Croma's copy when it holds a recent answer for the key, otherwise reads the source and keeps the answer; carries `checked_at` and `served_from`.","x-served-from":"lookup","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","minimum":-4.5,"maximum":13.5,"description":"Latitude of the point, decimal degrees (WGS84), within Colombia."},"longitude":{"type":"number","minimum":-82,"maximum":-66,"description":"Longitude of the point, decimal degrees (WGS84), within Colombia."}},"additionalProperties":false},"example":{"latitude":5.6096,"longitude":-75.4557}}}},"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/IgacPropertyByPointResponse"}}}},"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/igac/parcel/v1":{"post":{"operationId":"igac_parcel","summary":"IGAC Parcel","description":"Retrieve the polygon of one parcel (terreno) of Colombia's national cadastre by its 30-digit cadastral number: the geometry as GeoJSON in WGS84, its centre, the block or vereda it sits in, the zone and the previous number. From IGAC's monthly publication, about 5.1 million parcels. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cadastral_number"],"properties":{"cadastral_number":{"type":"string","pattern":"^[0-9 .-]{30,40}$","description":"The 30-digit número predial nacional, e.g. `170130001000000010001000000000`. Spaces, dots and hyphens are ignored."}},"additionalProperties":false},"example":{"cadastral_number":"170130001000000010001000000000"}}}},"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/IgacParcelResponse"}}}},"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/igac/parcels-search/v1":{"post":{"operationId":"igac_parcels_search","summary":"IGAC Parcels Search","description":"List the parcels (terrenos) of Colombia's national cadastre in a municipality, optionally within one block or vereda (`block_code`) or one `zone`, each with its GeoJSON polygon in WGS84, centre and previous number. About 5.1 million parcels from IGAC's monthly publication. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["municipality_code"],"properties":{"municipality_code":{"type":"string","pattern":"^\\d{5}$","description":"Five-digit DANE code of the municipality, e.g. `17013` for Aguadas or `52001` for Pasto."},"block_code":{"type":"string","pattern":"^(\\d{17})?$","default":"","description":"Optional 17-digit code of the manzana (urban) or vereda (rural): the first 17 digits of any property's cadastral number in it, e.g. `17013000100000001`."},"zone":{"type":"string","enum":["","urban","rural"],"default":"","description":"Optional: `urban` or `rural`."},"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 its geometry."}},"additionalProperties":false},"example":{"municipality_code":"17013","block_code":"17013000100000001"}}}},"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/IgacParcelsSearchResponse"}}}},"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/igac/buildings-by-property/v1":{"post":{"operationId":"igac_buildings_by_property","summary":"IGAC Buildings by Property","description":"List the buildings (construcciones) IGAC's cadastre draws on one property, by its 30-digit cadastral number: each with its letter, type (`CONVENCIONAL` or `NO CONVENCIONAL`), ownership regime, floors, basements, mezzanines and footprint as GeoJSON in WGS84. About 3.8 million buildings. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cadastral_number"],"properties":{"cadastral_number":{"type":"string","pattern":"^[0-9 .-]{30,40}$","description":"The 30-digit número predial nacional, e.g. `170130001000000010001000000000`. Spaces, dots and hyphens are ignored."}},"additionalProperties":false},"example":{"cadastral_number":"170130001000000010001000000000"}}}},"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/IgacBuildingsByPropertyResponse"}}}},"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/igac/blocks-search/v1":{"post":{"operationId":"igac_blocks_search","summary":"IGAC Blocks Search","description":"List the urban blocks (manzanas) of a municipality in Colombia's national cadastre, each with its 17-digit code, neighbourhood and GeoJSON polygon in WGS84. About 172,000 blocks. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["municipality_code"],"properties":{"municipality_code":{"type":"string","pattern":"^\\d{5}$","description":"Five-digit DANE code of the municipality, e.g. `17013` for Aguadas or `52001` for Pasto."},"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 its geometry."}},"additionalProperties":false},"example":{"municipality_code":"17013"}}}},"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/IgacBlocksSearchResponse"}}}},"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/igac/rural-districts-search/v1":{"post":{"operationId":"igac_rural_districts_search","summary":"IGAC Rural Districts Search","description":"List the rural districts (veredas) of a municipality in Colombia's national cadastre, by name words when given, each with its 17-digit code, name, sector and GeoJSON polygon in WGS84. About 17,000 veredas. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["municipality_code"],"properties":{"municipality_code":{"type":"string","pattern":"^\\d{5}$","description":"Five-digit DANE code of the municipality, e.g. `17013` for Aguadas or `52001` for Pasto."},"query":{"type":"string","maxLength":120,"default":"","description":"Optional words matched against the name, e.g. `el porvenir`."},"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 its geometry."}},"additionalProperties":false},"example":{"municipality_code":"17013"}}}},"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/IgacRuralDistrictsSearchResponse"}}}},"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/igac/sectors-search/v1":{"post":{"operationId":"igac_sectors_search","summary":"IGAC Sectors Search","description":"List the cadastral sectors of a municipality in Colombia's national cadastre, urban and rural, each with its polygon, and the municipality's urban perimeters (the line dividing urban from rural land) with the centre's name and appraisal regime. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["municipality_code"],"properties":{"municipality_code":{"type":"string","pattern":"^\\d{5}$","description":"Five-digit DANE code of the municipality, e.g. `17013` for Aguadas or `52001` for Pasto."},"zone":{"type":"string","enum":["","urban","rural"],"default":"","description":"Optional: `urban` or `rural`."},"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 its geometry."}},"additionalProperties":false},"example":{"municipality_code":"17013"}}}},"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/IgacSectorsSearchResponse"}}}},"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/igac/economic-zones-search/v1":{"post":{"operationId":"igac_economic_zones_search","summary":"IGAC Economic Zones Search","description":"List the homogeneous geoeconomic zones (zonas homogéneas geoeconómicas) IGAC has adopted in a municipality, urban and rural, each with the land value per m² (urban, `value_per_m2`) or per hectare (rural, `value_per_hectare`) in pesos, the date the value is from, the physical zones it covers and its GeoJSON polygon. A property's `land_zones[].economic_zone_code` points at these; the land half of its appraisal is this value times the area. About 130,000 zones. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["municipality_code"],"properties":{"municipality_code":{"type":"string","pattern":"^\\d{5}$","description":"Five-digit DANE code of the municipality, e.g. `17013` for Aguadas or `52001` for Pasto."},"zone":{"type":"string","enum":["","urban","rural"],"default":"","description":"Optional: `urban` or `rural`."},"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 its geometry."}},"additionalProperties":false},"example":{"municipality_code":"17013","zone":"urban"}}}},"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/IgacEconomicZonesSearchResponse"}}}},"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/igac/physical-zones-search/v1":{"post":{"operationId":"igac_physical_zones_search","summary":"IGAC Physical Zones Search","description":"List the homogeneous physical zones (zonas homogéneas físicas) IGAC has adopted in a municipality, urban and rural: topography, road influence, public services, land use and its norm and construction typology for urban zones; land class and water availability for rural ones; each with the date it is from and its GeoJSON polygon. About 190,000 zones. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["municipality_code"],"properties":{"municipality_code":{"type":"string","pattern":"^\\d{5}$","description":"Five-digit DANE code of the municipality, e.g. `17013` for Aguadas or `52001` for Pasto."},"zone":{"type":"string","enum":["","urban","rural"],"default":"","description":"Optional: `urban` or `rural`."},"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 its geometry."}},"additionalProperties":false},"example":{"municipality_code":"17013","zone":"urban"}}}},"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/IgacPhysicalZonesSearchResponse"}}}},"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/igac/municipal-statistics/v1":{"post":{"operationId":"igac_municipal_statistics","summary":"IGAC Municipal Statistics","description":"IGAC's cadastral statistics for one municipality of Colombia, whoever administers its cadastre, per zone and reporting year since 2017: the sum of every property's avalúo catastral (`appraisal_total`, pesos), the number of properties, built and land areas, the years of the last urban and rural updates and the cadastre's status. Optionally one `year` or one `zone`. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["municipality_code"],"properties":{"municipality_code":{"type":"string","pattern":"^\\d{5}$","description":"Five-digit DANE code of the municipality, e.g. `17013` for Aguadas or `52001` for Pasto."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional reporting year, e.g. `2025`. Omit it for every year IGAC reports."},"zone":{"type":"string","enum":["","urban","rural"],"default":"","description":"Optional: `urban` or `rural`."}},"additionalProperties":false},"example":{"municipality_code":"17013"}}}},"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/IgacMunicipalStatisticsResponse"}}}},"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/igac/cadastral-managers/v1":{"post":{"operationId":"igac_cadastral_managers","summary":"IGAC Cadastral Managers","description":"Who administers each of Colombia's 1,122 municipal cadastres, as IGAC maps it: IGAC itself for 842, a departmental, metropolitan or municipal gestor catastral for the rest. Filter by `municipality_code` or by words of the manager's or municipality's name. `is_igac` says whether the municipality's properties are in this source. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"municipality_code":{"type":"string","pattern":"^(\\d{5})?$","default":"","description":"Optional five-digit DANE code of the municipality, e.g. `17013` for Aguadas."},"query":{"type":"string","maxLength":120,"default":"","description":"Optional words matched against the manager's name, e.g. `antioquia` or `cundinamarca`."},"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":"antioquia"}}}},"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/IgacCadastralManagersResponse"}}}},"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/igac/address-plates-by-property/v1":{"post":{"operationId":"igac_address_plates_by_property","summary":"IGAC Address Plates by Property","description":"The address plates (nomenclatura domiciliaria) IGAC draws for one parcel of Colombia's national cadastre, by its 30-digit cadastral number: the text of each plate and where it sits, as GeoJSON in WGS84. About 3 million plates. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cadastral_number"],"properties":{"cadastral_number":{"type":"string","pattern":"^[0-9 .-]{30,40}$","description":"The 30-digit número predial nacional, e.g. `170130001000000010001000000000`. Spaces, dots and hyphens are ignored."}},"additionalProperties":false},"example":{"cadastral_number":"170130001000000010001000000000"}}}},"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/IgacAddressPlatesByPropertyResponse"}}}},"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/igac/street-names-search/v1":{"post":{"operationId":"igac_street_names_search","summary":"IGAC Street Names Search","description":"The street names (nomenclatura vial) IGAC draws on the cadastral map of a municipality in Colombia, by words of the name when given, each with where it sits as GeoJSON in WGS84. About 150,000 names. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["municipality_code"],"properties":{"municipality_code":{"type":"string","pattern":"^\\d{5}$","description":"Five-digit DANE code of the municipality, e.g. `17013` for Aguadas or `52001` for Pasto."},"query":{"type":"string","maxLength":120,"default":"","description":"Optional words matched against the name, e.g. `el porvenir`."},"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 its geometry."}},"additionalProperties":false},"example":{"municipality_code":"17013"}}}},"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/IgacStreetNamesSearchResponse"}}}},"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/banrep/series-search/v1":{"post":{"operationId":"banrep_series_search","summary":"Banco de la República Series Search","description":"Search the catalog of statistical series the Banco de la República, Colombia's central bank, publishes: about 850 series covering the TRM exchange rate, the monetary policy rate, IBR, DTF and deposit rates, lending rates by credit type, credit and monetary aggregates, consumer prices, unemployment, GDP, the balance of payments, remittances and regional activity. Free text matches the name, description, keywords and categories; filter by `frequency`. Each result carries the series code, unit, producer, first and latest observation, and the last and next update dates. Read a series' observations with `banrep_series`. 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","Banco de la República"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/banrep"},"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 series name, description, keywords and categories, e.g. `TRM`, `tasa de política monetaria`, `crédito de consumo` or `desempleo`."},"frequency":{"type":"string","enum":["","daily","weekly","monthly","quarterly","semiannual","annual"],"default":"","description":"Optional native frequency of the series: `daily`, `weekly`, `monthly`, `quarterly`, `semiannual` or `annual`."},"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":"crédito de consumo","frequency":"monthly"}}}},"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/BanrepSeriesSearchResponse"}}}},"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/banrep/series/v1":{"post":{"operationId":"banrep_series","summary":"Banco de la República Series","description":"Read the observations of one statistical series of the Banco de la República (Colombia) by its code, the `id` of a search result, e.g. `1` (TRM), `59` (monetary policy rate), `15126` (consumer lending rate) or `15000` (consumer price index), optionally over a date range (`from_date`, `to_date`). Returns the series' metadata (name, unit, frequency, producer, last and next update) and every observation in the range as `date` and `value`, oldest first. Find a code with `banrep_series_search`. 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","Banco de la República"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/banrep"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["series_code"],"properties":{"series_code":{"type":"string","pattern":"^\\d{1,8}$","description":"The Banco de la República code of the series, the `id` of a search result, e.g. `1` (TRM) or `59` (policy rate)."},"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."}},"additionalProperties":false},"example":{"series_code":"1","from_date":"2026-09-01","to_date":"2026-09-30"}}}},"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/BanrepSeriesResponse"}}}},"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/banrep-research/publications-search/v1":{"post":{"operationId":"banrep_research_publications_search","summary":"Banco de la República Publications Search","description":"Search every publication of the Banco de la República, Colombia's central bank: the Borradores de Economía working papers, the regional and urban economics working papers, Ensayos sobre Política Económica, the monetary policy and financial stability reports, the board's reports to Congress, the regional economic bulletins and ICER reports, the labour market, credit and financial markets reports, and books, about 5,700 in all. Free text matches the title, abstracts, keywords, subjects, authors and the full text; filter by `series`, `author` surname, `jel_code` (or its prefix, e.g. `E5`), `region` (a Colombian department) and date. Each result carries the authors, date, series, abstracts, JEL codes, departments covered, DOI and links to a copy of every file. Read one publication's text with `banrep_research_publication`. 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","Banco de la República: research and reports"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/banrep-research"},"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 matched against the title, abstracts, summary, keywords, subjects, authors and full text, e.g. `remesas`, `inflación de alimentos` or `pobreza Chocó`."},"series":{"type":"string","enum":["","borradores","regional_working_papers","regional_essays","espe","monetary_policy_report","financial_stability_report","financial_stability_special_reports","financial_stability_topics","board_report_to_congress","icer","regional_bulletin","labour_market_report","credit_report","financial_markets_report","other"],"default":"","description":"Optional series: `borradores` (Borradores de Economía), `regional_working_papers` (Documentos de Trabajo sobre Economía Regional y Urbana), `regional_essays` (Ensayos sobre Economía Regional), `espe` (Ensayos sobre Política Económica), `monetary_policy_report` (Informe de Política Monetaria), `financial_stability_report` (Reporte de Estabilidad Financiera), `financial_stability_special_reports`, `financial_stability_topics`, `board_report_to_congress` (Informe de la Junta Directiva al Congreso), `icer` (Informes de Coyuntura Económica Regional), `regional_bulletin` (Boletín Económico Regional), `labour_market_report`, `credit_report`, `financial_markets_report` or `other` (books, chapters and the smaller series)."},"author":{"type":"string","maxLength":120,"default":"","description":"Optional author surname, with or without accents, e.g. `Ayala` or `Ayala-García`."},"jel_code":{"type":"string","pattern":"^([A-Za-z]\\d{0,2})?$","default":"","description":"Optional JEL classification code or its prefix: `E52` (monetary policy), `E5` (every code under it) or `R` (urban, rural and regional economics)."},"region":{"type":"string","maxLength":80,"default":"","description":"Optional Colombian department the publication covers, with or without accents, e.g. `Chocó` or `La Guajira`. The regional bulletins and ICER reports carry it."},"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":{"query":"remesas","series":"regional_working_papers"}}}},"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/BanrepResearchPublicationsSearchResponse"}}}},"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/banrep-research/publication/v1":{"post":{"operationId":"banrep_research_publication","summary":"Banco de la República Publication","description":"Retrieve one publication of the Banco de la República (Colombia) by its handle, the `id` of a search result (e.g. `11430`), or its handle link: everything the search returns plus the text of its main document, a character range at a time (`offset`, `limit`; follow `next_offset` until `has_more` is false), and links to a copy of every file published with it. Find a handle with `banrep_research_publications_search`. 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","Banco de la República: research and reports"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/banrep-research"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["handle"],"properties":{"handle":{"type":"string","minLength":1,"maxLength":200,"description":"The publication's handle, the `id` of a search result (e.g. `11430`), or its link (`https://hdl.handle.net/20.500.12134/11430`)."},"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":{"handle":"11449"}}}},"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/BanrepResearchPublicationResponse"}}}},"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/icfes/saber11-schools-search/v1":{"post":{"operationId":"icfes_saber11_schools_search","summary":"ICFES Saber 11 Results by School","description":"Saber 11 results of every Colombian school per exam period, 2010 to 2022 (Colombia's end-of-secondary exam, run by ICFES): students who sat it (each counted once) and their mean global score (0 to 500) and mean score in mathematics, critical reading, natural sciences, social studies and English, with the school's DANE code, name, sector, calendar, area and municipality. Free text matches the school and municipality names. Filter by `school_code` (12-digit DANE), `territory_code` (5-digit DIVIPOLA municipality or 2-digit department), `year`, `period` (`yyyy-1` or `yyyy-2`) and `school_sector` (`oficial`, `no_oficial`). Newest period first, highest mean global score first within it. 2018-2 and 2021-2 are not published. 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","ICFES"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/icfes"},"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 words matched against the school's name and its municipality."},"school_code":{"type":"string","pattern":"^(\\d{12})?$","default":"","description":"Optional DANE code of the school (establecimiento educativo), 12 digits, e.g. `111001000078`."},"territory_code":{"type":"string","pattern":"^(\\d{2}|\\d{5})?$","default":"","description":"Optional DIVIPOLA code: 5 digits for one municipality (e.g. `05001`, Medellín) or 2 digits for every municipality of a department (e.g. `05`, Antioquia)."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional exam year, 2010 to 2022. 0 returns every year."},"period":{"type":"string","pattern":"^(\\d{4}-[12])?$","default":"","description":"Optional exam period as `yyyy-1` (the first sitting of the year) or `yyyy-2` (the second), e.g. `2022-2`."},"school_sector":{"type":"string","enum":["","oficial","no_oficial"],"default":"","description":"Optional sector of the school: `oficial` (public) or `no_oficial` (private)."},"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":{"territory_code":"11001","period":"2022-2","school_sector":"oficial"}}}},"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/IcfesSaber11SchoolsSearchResponse"}}}},"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/icfes/saber11-strata-search/v1":{"post":{"operationId":"icfes_saber11_strata_search","summary":"ICFES Saber 11 Results by Stratum","description":"Saber 11 results of every Colombian municipality by the socioeconomic stratum of the students' homes, per exam period, 2010 to 2022 (Colombia's end-of-secondary exam, run by ICFES): students who sat it (each counted once) and their mean global and per-area scores. Stratum is `1` to `6`, `sin_estrato` or `no_reportado`, as each student reported it. Filter by `territory_code` (5-digit DIVIPOLA municipality of the school or 2-digit department), `year`, `period` (`yyyy-1` or `yyyy-2`) and `stratum`. 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","ICFES"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/icfes"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"territory_code":{"type":"string","pattern":"^(\\d{2}|\\d{5})?$","default":"","description":"Optional DIVIPOLA code: 5 digits for one municipality (e.g. `05001`, Medellín) or 2 digits for every municipality of a department (e.g. `05`, Antioquia)."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional exam year, 2010 to 2022. 0 returns every year."},"period":{"type":"string","pattern":"^(\\d{4}-[12])?$","default":"","description":"Optional exam period as `yyyy-1` (the first sitting of the year) or `yyyy-2` (the second), e.g. `2022-2`."},"stratum":{"type":"string","enum":["","1","2","3","4","5","6","sin_estrato","no_reportado"],"default":"","description":"Optional socioeconomic stratum of the student's home as the student reported it: `1` to `6`, `sin_estrato` (the home has none) or `no_reportado` (not answered)."},"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":{"territory_code":"11001","period":"2022-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/IcfesSaber11StrataSearchResponse"}}}},"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/igac-transactions/search/v1":{"post":{"operationId":"igac_transactions_search","summary":"IGAC Property Transactions Search","description":"Search the acts registered on Colombian property folios filed 2015-2023 (about 31 million annotations from the registry, published by IGAC): sales (act `125` compraventa), mortgages, embargoes, cancellations and others, each with the matrícula, municipality, zone, filing date, instrument and the value it declares. Requires `municipality_code` (DANE) or `registration_number` (matrícula, `<office>-<folio>`); narrow by `act_code`, `zone`, `year_from`/`year_to`, `min_value`/`max_value` (pesos) or `with_value`. Newest first. For a sale the value is the price in the deed, which can sit below the price agreed. Use `igac_transactions_price_statistics` for medians. 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","IGAC Property Transactions"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac-transactions"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"municipality_code":{"type":"string","pattern":"^(\\d{5})?$","default":"","description":"Optional five-digit DANE code of the municipality, e.g. `17013` for Aguadas."},"registration_number":{"type":"string","pattern":"^(\\s*[0-9A-Za-z]{1,4}\\s*-\\s*\\d{1,8}\\s*)?$","default":"","description":"Optional matrícula inmobiliaria as `<registry office>-<folio>`, e.g. `001-1234567` or `50C-123456`."},"act_code":{"type":"integer","minimum":0,"maximum":9999,"default":0,"description":"Optional code of the registered act (naturaleza jurídica), e.g. `125` compraventa, `219` hipoteca abierta, `843` cancelación por voluntad de las partes. 0 means every act."},"zone":{"type":"string","enum":["","urban","rural"],"default":"","description":"Optional: `urban` or `rural`."},"year_from":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional first year of filing (radicación) to include, e.g. `2020`. 0 means no lower bound."},"year_to":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional last year of filing (radicación) to include, e.g. `2023`. 0 means no upper bound."},"min_value":{"type":"number","minimum":0,"default":0,"description":"Optional lowest declared value to include, in Colombian pesos, e.g. `100000000`. 0 means no lower bound."},"max_value":{"type":"number","minimum":0,"default":0,"description":"Optional highest declared value to include, in Colombian pesos. 0 means no upper bound."},"with_value":{"type":"boolean","default":false,"description":"Optional: `true` returns only annotations that declare a value."},"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":{"municipality_code":"17013","act_code":125,"year_from":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/IgacTransactionsSearchResponse"}}}},"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/igac-transactions/folio-history/v1":{"post":{"operationId":"igac_transactions_folio_history","summary":"IGAC Folio History","description":"Retrieve every act registered on one Colombian property folio filed 2015-2023, by its matrícula inmobiliaria (`<registry office>-<folio>`, e.g. `002-8032`), in the folio's order: sales with their declared price, mortgages, embargoes, cancellations, subdivisions. `found: false` when the folio had no act in those years or does not exist. No names of parties. 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","IGAC Property Transactions"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac-transactions"},"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":"^\\s*[0-9A-Za-z]{1,4}\\s*-\\s*\\d{1,8}\\s*$","description":"The matrícula inmobiliaria as `<registry office>-<folio>`, e.g. `001-1234567` or `50C-123456`. A numeric office may be written without its leading zeros (`1-1234567`)."}},"additionalProperties":false},"example":{"registration_number":"002-8032"}}}},"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/IgacFolioHistoryResponse"}}}},"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/igac-transactions/price-statistics/v1":{"post":{"operationId":"igac_transactions_price_statistics","summary":"IGAC Property Price Statistics","description":"Declared values of the property acts registered in one Colombian municipality (`municipality_code`, DANE), per filing year (2015-2023), zone (`urban`/`rural`) and act: how many acts declared a value above zero, and their median, mean, lowest, highest and sum in pesos. Act `125` (compraventa) gives the median sale price written in deeds. Optionally one `act_code`, one `zone` and a `year_from`/`year_to` range. Prefer the median: a few acts declare whole-portfolio amounts. Served by Croma.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","IGAC Property Transactions"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/igac-transactions"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["municipality_code"],"properties":{"municipality_code":{"type":"string","pattern":"^\\d{5}$","description":"Five-digit DANE code of the municipality, e.g. `17013` for Aguadas or `52001` for Pasto."},"act_code":{"type":"integer","minimum":0,"maximum":9999,"default":0,"description":"Optional code of the registered act (naturaleza jurídica), e.g. `125` compraventa, `219` hipoteca abierta, `843` cancelación por voluntad de las partes. 0 means every act."},"zone":{"type":"string","enum":["","urban","rural"],"default":"","description":"Optional: `urban` or `rural`."},"year_from":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional first year of filing (radicación) to include, e.g. `2020`. 0 means no lower bound."},"year_to":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional last year of filing (radicación) to include, e.g. `2023`. 0 means no upper bound."}},"additionalProperties":false},"example":{"municipality_code":"17013","act_code":125}}}},"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/IgacPriceStatisticsResponse"}}}},"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/upra/land-prices-search/v1":{"post":{"operationId":"upra_land_prices_search","summary":"UPRA Rural Land Prices Search","description":"Search UPRA's map of commercial prices of rural agricultural land in Colombia: about 179,000 zones in 18 departments, each with its price range in pesos per hectare (`min_price_cop_per_ha`, `max_price_cop_per_ha`), the year of the study (2015-2023), its market category, area and polygon. Requires `municipality_code` (DANE, 5 digits) or `department_code` (2 digits); narrow by `min_price_per_hectare` (ranges starting at or above) and `max_price_per_hectare` (ranges ending at or below). Most expensive first. Not an appraisal of any one property. Find the zone under a coordinate with `upra_land_price_by_point`. 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","UPRA Rural Land Prices"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/upra"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"municipality_code":{"type":"string","pattern":"^(\\d{5})?$","default":"","description":"Optional five-digit DANE code of the municipality, e.g. `17013` for Aguadas."},"department_code":{"type":"string","pattern":"^(\\d{2})?$","default":"","description":"Optional two-digit DANE code of the department, e.g. `73` for Tolima or `50` for Meta."},"min_price_per_hectare":{"type":"number","minimum":0,"default":0,"description":"Optional: only zones whose price range starts at or above this price per hectare, in Colombian pesos, e.g. `20000000`. 0 means no bound."},"max_price_per_hectare":{"type":"number","minimum":0,"default":0,"description":"Optional: only zones whose price range ends at or below this price per hectare, in Colombian pesos. 0 means no bound."},"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 its geometry."}},"additionalProperties":false},"example":{"municipality_code":"73001"}}}},"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/UpraLandPricesSearchResponse"}}}},"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/upra/land-price-by-point/v1":{"post":{"operationId":"upra_land_price_by_point","summary":"UPRA Rural Land Price by Point","description":"Find the commercial price range of rural agricultural land at a point in Colombia (`latitude`, `longitude`, WGS84) from UPRA's land-market map: the zone that covers the point, with its price range in pesos per hectare, the year of the study, its market category, area and polygon. Land outside the market (urban zones, indigenous reserves, parks, páramos) comes back as a zone with `price_status: excluded` and the reason; `found: false` outside the 18 departments UPRA has studied and where no zone covers the point. Not an appraisal of any one property.","tags":["Colombia","UPRA Rural Land Prices"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/upra"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","minimum":-4.5,"maximum":13.5,"description":"Latitude of the point, decimal degrees (WGS84), within Colombia."},"longitude":{"type":"number","minimum":-82,"maximum":-66,"description":"Longitude of the point, decimal degrees (WGS84), within Colombia."}},"additionalProperties":false},"example":{"latitude":4.3,"longitude":-75}}}},"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/UpraLandPriceByPointResponse"}}}},"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/invima/registrations-search/v1":{"post":{"operationId":"invima_registrations_search","summary":"INVIMA Registrations Search","description":"Search every sanitary registration (registro sanitario) and mandatory notification (NSO) INVIMA, Colombia's food and drug authority, has issued or let expire: about 385,000 across medicines, food and drinks, cosmetics, medical devices, diagnostic reagents, supplements, biologicals and more. Free text matches the product names, the holder and the companies and people in every role. Filter by `registration_number` (any spelling), `holder` (matched from the start), `product_group` (e.g. `MEDICAMENTOS`, `COSMETICOS`), `status` (`vigente` or `vencido`) and the expiry date (`expires_from`/`expires_to`). Each result carries the number, dates, holder, every product name and every party. Read one registration with `invima_registration`. 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","INVIMA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/invima"},"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 product names, the holder and the companies and people in every role of the registration."},"registration_number":{"type":"string","maxLength":60,"default":"","description":"Optional registration or notification number in any spelling, e.g. `INVIMA 2020M-0019848`, `2020M-0019848` or `NSO-PC-C 32.233 -VE`. Spaces, hyphens, dots and case are ignored."},"holder":{"type":"string","maxLength":200,"default":"","description":"Optional holder (titular) of the registration, matched from the start. Case and accents are ignored."},"product_group":{"type":"string","maxLength":40,"default":"","description":"Optional product group as INVIMA names it: `MEDICAMENTOS`, `ALIMENTOS`, `COSMETICOS`, `MEDICO QUIRURGICOS`, `REACTIVO DIAGNOSTICO`, `REACTIVOS IN VITRO`, `BEBIDAS ALCOHOLICAS`, `ASEO Y LIMPIEZA`, `SUPLEMENTO DIETARIO`, `BIOLOGICOS`, `HOMEOPATICOS`, `FITOTERAPEUTICO`, `ODONTOLOGICOS` or `PLAGUICIDAS`. Case and accents are ignored."},"status":{"type":"string","maxLength":60,"default":"","description":"Optional status as INVIMA states it: `vigente` (in force) or `vencido` (expired). Case and accents are ignored."},"expires_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"expires_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":100,"default":20,"description":"Results per page (1-100)."}},"additionalProperties":false},"example":{"query":"acetaminofen","product_group":"MEDICAMENTOS","status":"vigente"}}}},"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/InvimaRegistrationsSearchResponse"}}}},"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/invima/registration/v1":{"post":{"operationId":"invima_registration","summary":"INVIMA Registration","description":"Retrieve one sanitary registration of INVIMA (Colombia) by its file number (expediente), the `id` of a search result, e.g. `20190868`: the registration number, status, issue and expiry dates, holder, product group, modality, every product name it covers and every company or person in a role on it (manufacturer, importer, packager, attorney, legal representative, pharmacist). Find a file number with `invima_registrations_search`.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","INVIMA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/invima"},"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,12}$","description":"The INVIMA file number (expediente) that identifies the registration, e.g. `20190868`."}},"additionalProperties":false},"example":{"file_number":"20190868"}}}},"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/InvimaRegistrationResponse"}}}},"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/invima/medicines-search/v1":{"post":{"operationId":"invima_medicines_search","summary":"INVIMA Medicines Search","description":"Search every commercial presentation of every medicine registered with INVIMA (Colombia), about 163,000 with their CUM code (Código Único de Medicamento): the registration and its status, holder, ATC code, pharmaceutical form, active ingredients with concentration, routes, pack, whether the presentation is active, and the manufacturers and importers. Free text matches the name, the active ingredients, the holder and the ATC description. Filter by `active_ingredient` (exact, e.g. `ACETAMINOFEN`), `atc_code` (a code or a prefix such as `N02`), `registration_number`, `file_number`, `holder`, `status` (`vigente`, `vencido` and others), `cum_status` (`activo`/`inactivo`) and the expiry date. Read one presentation with `invima_medicine`. 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","INVIMA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/invima"},"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 medicine's name, its active ingredients, the holder and the ATC description."},"registration_number":{"type":"string","maxLength":60,"default":"","description":"Optional registration or notification number in any spelling, e.g. `INVIMA 2020M-0019848`, `2020M-0019848` or `NSO-PC-C 32.233 -VE`. Spaces, hyphens, dots and case are ignored."},"file_number":{"type":"string","pattern":"^(\\d{1,12})?$","default":"","description":"Optional INVIMA file number (expediente), e.g. `20042480`: every presentation of that one registration."},"active_ingredient":{"type":"string","maxLength":120,"default":"","description":"Optional active ingredient as INVIMA names it, e.g. `ACETAMINOFEN` or `AMOXICILINA TRIHIDRATO`. Exact match; case and accents are ignored."},"atc_code":{"type":"string","pattern":"^[A-Za-z0-9]{0,7}$","default":"","description":"Optional ATC code or prefix, e.g. `N02BE51` for a substance or `N02` for a whole group."},"holder":{"type":"string","maxLength":200,"default":"","description":"Optional holder (titular) of the registration, matched from the start. Case and accents are ignored."},"status":{"type":"string","maxLength":60,"default":"","description":"Optional status of the registration as INVIMA states it: `vigente`, `vencido`, `perdida fuerza ejec`, `cancelado`, `negado`, `suspendido`, `en tramite renov`, `temp. no comerc - vigente`, among others. Case and accents are ignored."},"cum_status":{"type":"string","enum":["","activo","inactivo"],"default":"","description":"Optional state of the presentation in the CUM: `activo` or `inactivo`."},"expires_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"expires_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":100,"default":20,"description":"Results per page (1-100)."}},"additionalProperties":false},"example":{"active_ingredient":"ACETAMINOFEN","status":"vigente","cum_status":"activo"}}}},"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/InvimaMedicinesSearchResponse"}}}},"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/invima/medicine/v1":{"post":{"operationId":"invima_medicine","summary":"INVIMA Medicine","description":"Retrieve one presentation of a medicine registered with INVIMA (Colombia) by its CUM code (Código Único de Medicamento), the `id` of a search result, e.g. `20042480-41`: the registration and its status, holder, ATC code, pharmaceutical form, every active ingredient with its concentration, routes of administration, pack, whether the presentation is active and since when, and the manufacturers and importers. Find a CUM with `invima_medicines_search`.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","INVIMA"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/invima"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cum"],"properties":{"cum":{"type":"string","pattern":"^\\d{1,12}\\s*[^0-9A-Za-z]\\s*\\d{1,6}$","description":"The CUM code of the presentation: the file number and the sequence joined by a hyphen, e.g. `20042480-41`."}},"additionalProperties":false},"example":{"cum":"20042480-41"}}}},"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/InvimaMedicineResponse"}}}},"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/mineducacion/indicators-search/v1":{"post":{"operationId":"mineducacion_indicators_search","summary":"MinEducación Municipal Education Indicators","description":"Education indicators of Colombia's Ministry of Education for every municipality and school year since 2011 (about 15,700 municipality-years): population aged 5 to 16, enrollment rate, net and gross coverage, dropout, approval, failure and repetition, overall and by level (transición, primaria, secundaria, media), in percent. Filter by `territory_code` (5-digit DIVIPOLA municipality or 2-digit department), `year`, or match municipality and department names with `query`. Newest year first. 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","MinEducación"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/mineducacion"},"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 words matched against the municipality and department names."},"territory_code":{"type":"string","pattern":"^(\\d{2}|\\d{5})?$","default":"","description":"Optional DIVIPOLA code: 5 digits for one municipality (e.g. `05001`, Medellín) or 2 digits for every municipality of a department (e.g. `05`, Antioquia)."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional school year, from 2011. 0 returns 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":{"territory_code":"05001"}}}},"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/MineducacionIndicatorsSearchResponse"}}}},"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 `parte` or `clase` search requires `corporacion`: use 1100103 for the Consejo de Estado, or get a Tribunal or Juzgado code from SAMAI Corporaciones first. 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 cédula of the contractor's legal representative, 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)."},"legal_rep_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/simev/shareholders/v1":{"post":{"operationId":"simev_shareholders","summary":"SIMEV Issuer Shareholders","description":"Principal shareholders a Colombian securities issuer reported to the Superintendencia Financiera, by NIT: each holder's identity document, name, nationality, shares and share per class (ordinary, privileged, preferred) at a June or December cut-off, plus the issuer's share register summary. Latest cut-off by default, or a given one; every cut-off on record is listed. Covers the roughly 110 registered issuers with a published list, most of the country's banks among them. Served by Croma (`as_of` says how current the data is), brought up to date weekly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SIMEV"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/simev"},"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."},"cutoff_date":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."}},"additionalProperties":false},"example":{"document_number":"860002964"}}}},"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/SimevShareholdersResponse"}}}},"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/adres/uninsured-accident-debts/v1":{"post":{"operationId":"adres_uninsured_accident_debts","summary":"ADRES Uninsured Accident Debts","description":"What a person or company owes ADRES for the victims of an accident their vehicle had without SOAT, by cédula or NIT (`document_number`, 5-12 digits, no leading zero). Returns `total_owed` in COP and every claim: plate, accident and payment dates, amounts and collection status. `found: false` means no debt. For health-system affiliation use `adres_affiliation_status` instead.\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_number":{"type":"string","minLength":5,"maxLength":12,"pattern":"^[1-9]\\d{4,11}$","description":"Colombian cédula or NIT of the person or company to check. 5-12 digits, no leading zero."},"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/AdresUninsuredAccidentDebtsResponse"}}}},"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/terridata/indicators-search/v1":{"post":{"operationId":"terridata_indicators_search","summary":"TerriData Indicators Search","description":"Search the catalog of Colombia's territorial statistics (DNP TerriData) by words in the indicator's name (Spanish) and by dimension (`14` poverty, `04` education, `05` health, `16` labour market, `07` public finance, ...). Returns each indicator's nine-digit code, unit, producing agency, how many territories report it and the years it spans. Use the code with the series and ranking endpoints. 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","DNP TerriData"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/terridata"},"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 words to find in the indicator's name, in Spanish, e.g. `pobreza multidimensional`, `cobertura neta`, `homicidios`."},"dimension_code":{"type":"string","enum":["","11","12","13","14","15","16","19","20","22","25","26","27","28","29","30","31","01","02","03","04","05","06","07","08"],"default":"","description":"Optional two-digit dimension: `14` poverty, `04` education, `05` health, `16` labour market, `07` public finance, `12` economy, `06` safety, `03` housing and public services, `02` demographics. Empty searches every dimension."},"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":"pobreza multidimensional"}}}},"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/TerridataIndicatorsSearchResponse"}}}},"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/terridata/series/v1":{"post":{"operationId":"terridata_series","summary":"TerriData Series by Territory","description":"Colombia's territorial statistics (DNP TerriData) for one territory, by its five-digit DANE code (`05001` Medellín, `05000` Antioquia, `01001` Colombia): every indicator's yearly values with unit and producing agency, optionally narrowed to one indicator code, one dimension or words in the indicator's name. `found: false` when the panel holds nothing for that territory. 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","DNP TerriData"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/terridata"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["territory_code"],"properties":{"territory_code":{"type":"string","pattern":"^\\d{5}$","description":"Five-digit DANE code of the territory: a municipality (`05001` Medellín, `11001` Bogotá), a department (its two digits plus `000`, e.g. `05000` Antioquia) or `01001` for Colombia as a whole."},"indicator_code":{"type":"string","pattern":"^(\\d{9})?$","default":"","description":"Optional nine-digit indicator code, as the indicator search returns it. Empty returns every indicator of the territory."},"dimension_code":{"type":"string","enum":["","11","12","13","14","15","16","19","20","22","25","26","27","28","29","30","31","01","02","03","04","05","06","07","08"],"default":"","description":"Optional two-digit dimension: `14` poverty, `04` education, `05` health, `16` labour market, `07` public finance, `12` economy, `06` safety, `03` housing and public services, `02` demographics. Empty searches every dimension."},"query":{"type":"string","maxLength":200,"default":"","description":"Optional words to find in the indicator's name, in Spanish, e.g. `pobreza multidimensional`, `cobertura neta`, `homicidios`."},"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":{"territory_code":"05001","dimension_code":"14"}}}},"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/TerridataSeriesResponse"}}}},"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/terridata/ranking/v1":{"post":{"operationId":"terridata_ranking","summary":"TerriData Ranking","description":"Rank Colombia's municipalities (or departments) on one indicator of the DNP's territorial statistics (TerriData) for a year, or on each territory's latest value: highest or lowest first, optionally within one department. Returns rank, territory, year and value, plus the indicator's unit and producing agency. 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","DNP TerriData"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/terridata"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["indicator_code"],"properties":{"indicator_code":{"type":"string","pattern":"^\\d{9}$","description":"Nine-digit indicator code, as the indicator search returns it."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year to compare, e.g. `2024`. `0` compares each territory's latest value."},"level":{"type":"string","enum":["municipality","department"],"default":"municipality","description":"Optional level to compare: `municipality` (default) or `department`."},"department_code":{"type":"string","pattern":"^(\\d{2})?$","default":"","description":"Optional two-digit DANE code of a department, e.g. `05` for Antioquia: only its municipalities are compared."},"order":{"type":"string","enum":["desc","asc"],"default":"desc","description":"Optional order: `desc` (highest value first, the default) or `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":{"indicator_code":"140030015","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/TerridataRankingResponse"}}}},"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/transmilenio/stops-search/v1":{"post":{"operationId":"transmilenio_stops_search","summary":"TransMilenio Stops Search","description":"Search the stops and stations of Bogotá's public transport network (TransMilenio, feeders, SITP zonal buses, TransMiCable) by name or code, by the route that serves them (`B10`, `C25`), or near a point (latitude, longitude and radius in metres, nearest first). Each stop carries its location, accessibility, its platforms and every route that stops there. Schedule data refreshed daily.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","TransMilenio"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/transmilenio"},"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 words in the stop's or station's name, or its code, e.g. `Portal Norte`, `Calle 72`, `Héroes`."},"route":{"type":"string","maxLength":40,"default":"","description":"Optional route: its `route_id` (e.g. `10075`) or its public code as printed on the bus (e.g. `B10`, `C25`, `T25`). A code matches every direction of that route."},"kind":{"type":"string","enum":["","station","stop"],"default":"","description":"Optional kind: `station` (a TransMilenio or TransMiCable station, which holds platforms) or `stop` (a platform inside a station, or a street stop). Empty returns both."},"latitude":{"type":["number","null"],"default":null,"minimum":3.5,"maximum":5.5,"description":"Optional latitude in decimal degrees, e.g. `4.6486`. With `longitude`, returns only what is within `radius_m` of that point, nearest first."},"longitude":{"type":["number","null"],"default":null,"minimum":-75,"maximum":-73,"description":"Optional longitude in decimal degrees, e.g. `-74.0633`. With `latitude`, returns only what is within `radius_m` of that point, nearest first."},"radius_m":{"type":"integer","minimum":50,"maximum":5000,"default":500,"description":"Radius in metres around `latitude` and `longitude` (50-5000). Default `500`."},"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":"Portal Norte"}}}},"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/TransmilenioStopsSearchResponse"}}}},"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/transmilenio/stop/v1":{"post":{"operationId":"transmilenio_stop","summary":"TransMilenio Stop","description":"One stop or station of Bogotá's public transport network by its `stop_id`: name, code, location, accessibility, platforms and every route that stops there, plus the station a platform belongs to.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","TransMilenio"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/transmilenio"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["stop_id"],"properties":{"stop_id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,40}$","description":"The stop's or station's `stop_id`, as the stop search returns it, e.g. `10000` (Portal 20 de Julio). A station covers every platform inside it."}},"additionalProperties":false},"example":{"stop_id":"10000"}}}},"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/TransmilenioStopResponse"}}}},"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/transmilenio/stop-departures/v1":{"post":{"operationId":"transmilenio_stop_departures","summary":"TransMilenio Stop Departures","description":"The scheduled departures from a stop or station of Bogotá's public transport network, for today or any date, from now or a given time, across every route or one (`B10`): time, route, destination and minutes from now. Weekends and public holidays follow their own timetable, and trips past midnight are included. For buses already on their way, use stop-arrivals.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","TransMilenio"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/transmilenio"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["stop_id"],"properties":{"stop_id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,40}$","description":"The stop's or station's `stop_id`, as the stop search returns it, e.g. `10000` (Portal 20 de Julio). A station covers every platform inside it."},"date":{"type":"string","pattern":"^(\\d{4}-\\d{2}-\\d{2})?$","default":"","description":"Optional day, `yyyy-mm-dd`, in Bogotá. Empty is today. Weekends and public holidays follow their own timetable."},"from_time":{"type":"string","pattern":"^(([01]\\d|2[0-3]):[0-5]\\d)?$","default":"","description":"Optional time of day, `HH:MM` in 24-hour Bogotá time, e.g. `07:30`. Empty is now for today and the start of the day for any other date."},"route":{"type":"string","maxLength":40,"default":"","description":"Optional route: its `route_id` (e.g. `10075`) or its public code as printed on the bus (e.g. `B10`, `C25`, `T25`). A code matches every direction of that route."},"limit":{"type":"integer","minimum":1,"maximum":200,"default":20,"description":"How many to return (1-200). Default `20`."}},"additionalProperties":false},"example":{"stop_id":"10000"}}}},"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/TransmilenioStopDeparturesResponse"}}}},"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/transmilenio/routes-search/v1":{"post":{"operationId":"transmilenio_routes_search","summary":"TransMilenio Routes Search","description":"Search the routes of Bogotá's public transport network by code (`B10`, `G43`) or destination, by system (`troncal`, `alimentador`, `dual`, `zonal_urbano`, `zonal_complementario`, `zonal_especial`, `transmicable`), or by a stop they serve. Each route carries its colour, number of stops, trips a week, first and last departures and its timetables.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","TransMilenio"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/transmilenio"},"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 route code or words in its destination, e.g. `B10`, `G43`, `Portal Suba`."},"system":{"type":"string","enum":["","troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable"],"default":"","description":"Optional part of the network: `troncal` (TransMilenio BRT), `alimentador` (feeders), `dual` (routes that run on the busway and the street), `zonal_urbano`, `zonal_complementario`, `zonal_especial` (the SITP street buses) or `transmicable` (the cable car). Empty returns every system."},"stop_id":{"type":"string","pattern":"^([A-Za-z0-9_-]{1,40})?$","default":"","description":"Optional `stop_id` of a stop or station, as the stop search returns it. A station covers every platform inside it."},"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":"B10"}}}},"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/TransmilenioRoutesSearchResponse"}}}},"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/transmilenio/route/v1":{"post":{"operationId":"transmilenio_route","summary":"TransMilenio Route","description":"One route of Bogotá's public transport network by its `route_id`: its timetables, first and last departures, and every sequence of stops it runs in order, with each stop's location and scheduled minutes from the start. With `include_geometry`, each sequence carries its path as a GeoJSON LineString for a map.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","TransMilenio"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/transmilenio"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["route_id"],"properties":{"route_id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,40}$","description":"The route's `route_id`, as the route search returns it, e.g. `10075`. Each direction of a route has its own id."},"include_geometry":{"type":"boolean","default":false,"description":"When true, each pattern carries its path as a GeoJSON `LineString`, ready to draw on a map. Default `false`."}},"additionalProperties":false},"example":{"route_id":"10075"}}}},"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/TransmilenioRouteResponse"}}}},"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/transmilenio/vehicles/v1":{"post":{"operationId":"transmilenio_vehicles","summary":"TransMilenio Live Vehicles","description":"Where the buses and cable cars of Bogotá's public transport network are right now: position, speed, route, trip and the stop each one is at or heading to, updated about every 20 seconds. Filter by route (`B10`) or around a point (latitude, longitude, radius in metres, nearest first).","tags":["Colombia","TransMilenio"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/transmilenio"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"route":{"type":"string","maxLength":40,"default":"","description":"Optional route: its `route_id` (e.g. `10075`) or its public code as printed on the bus (e.g. `B10`, `C25`, `T25`). A code matches every direction of that route."},"latitude":{"type":["number","null"],"default":null,"minimum":3.5,"maximum":5.5,"description":"Optional latitude in decimal degrees, e.g. `4.6486`. With `longitude`, returns only what is within `radius_m` of that point, nearest first."},"longitude":{"type":["number","null"],"default":null,"minimum":-75,"maximum":-73,"description":"Optional longitude in decimal degrees, e.g. `-74.0633`. With `latitude`, returns only what is within `radius_m` of that point, nearest first."},"radius_m":{"type":"integer","minimum":50,"maximum":5000,"default":500,"description":"Radius in metres around `latitude` and `longitude` (50-5000). Default `500`."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":500,"default":100,"description":"Vehicles per page (1-500). Default `100`."}},"additionalProperties":false},"example":{"route":"B10"}}}},"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/TransmilenioVehiclesResponse"}}}},"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/transmilenio/stop-arrivals/v1":{"post":{"operationId":"transmilenio_stop_arrivals","summary":"TransMilenio Live Arrivals","description":"The vehicles of Bogotá's public transport network about to reach a stop or station, live: route, destination, predicted arrival time, minutes away and delay against the timetable, updated about every 20 seconds. Pair it with stop-departures for the rest of the day's timetable.","tags":["Colombia","TransMilenio"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/transmilenio"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["stop_id"],"properties":{"stop_id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,40}$","description":"The stop's or station's `stop_id`, as the stop search returns it, e.g. `10000` (Portal 20 de Julio). A station covers every platform inside it."},"route":{"type":"string","maxLength":40,"default":"","description":"Optional route: its `route_id` (e.g. `10075`) or its public code as printed on the bus (e.g. `B10`, `C25`, `T25`). A code matches every direction of that route."},"limit":{"type":"integer","minimum":1,"maximum":200,"default":20,"description":"How many to return (1-200). Default `20`."}},"additionalProperties":false},"example":{"stop_id":"10000"}}}},"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/TransmilenioStopArrivalsResponse"}}}},"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/transmilenio/alerts/v1":{"post":{"operationId":"transmilenio_alerts","summary":"TransMilenio Service Alerts","description":"The service alerts of Bogotá's public transport network in force now: detours, closed stops, reduced service and delays, with their cause, effect, text, active period and the routes and stops affected. Filter by route (`B10`) or stop.","tags":["Colombia","TransMilenio"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/transmilenio"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"route":{"type":"string","maxLength":40,"default":"","description":"Optional route: its `route_id` (e.g. `10075`) or its public code as printed on the bus (e.g. `B10`, `C25`, `T25`). A code matches every direction of that route."},"stop_id":{"type":"string","pattern":"^([A-Za-z0-9_-]{1,40})?$","default":"","description":"Optional `stop_id` of a stop or station, as the stop search returns it. A station covers every platform inside it."}},"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/TransmilenioAlertsResponse"}}}},"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/shareholders/v1":{"post":{"operationId":"supersociedades_shareholders","summary":"Supersociedades Shareholders","description":"Shareholders or partners a Colombian company declared in the notes of its annual financial statements filed with the Superintendencia de Sociedades, by NIT: each holder's name, identity document, shares and percentage, plus the foreign investors, subsidiaries, associates and officers (legal representatives, accountant, revisor fiscal) declared in the same filing. Latest fiscal year by default, or a given year. Only companies that file with the Superintendencia (about 30,000 a year) are covered.","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."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional fiscal year of the filing to read (2016 or later). 0 reads the latest filing."}},"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/SupersociedadesShareholdersResponse"}}}},"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"}}}}}}},"/co/supersociedades/companies-search/v1":{"post":{"operationId":"supersociedades_companies_search","summary":"Supersociedades Companies Search","description":"Every company that files annual financial statements with Colombia's Superintendencia de Sociedades (about 30,000 a year since fiscal 2015), searchable by name, fiscal year, macrosector (`construccion`, `comercio`, `manufactura`, ...), CIIU section, division or code, department, region, supervision status and minimum revenue. Each result is one filing: NIT, name, activity, location, supervision status, employees, and the headline figures (revenue, profit, assets, liabilities, equity, cash flows, ratios, ranking) in thousands of COP. Largest revenue first. One filing per company and year unless `include_all_filings` is true. Served by Croma (`as_of` says how current the data is); the latest year is searched when `fiscal_year` is 0.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","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":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Optional words matched against the company name (razón social) as filed."},"fiscal_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional fiscal year (2015 or later). 0 searches the latest year available."},"macrosector":{"type":"string","enum":["any","agropecuario","minero","manufactura","construccion","comercio","servicios","transporte"],"default":"any","description":"Optional macrosector as the Superintendencia groups activities: `agropecuario`, `minero` (mining and hydrocarbons), `manufactura`, `construccion`, `comercio`, `servicios`, `transporte`, or `any`."},"ciiu_code":{"type":"string","pattern":"^(?:[A-Ua-u]|\\d{2,4})?$","default":"","description":"Optional CIIU Rev. 4 A.C. filter: a section letter (`F` for construction), a two-digit division (`42`), or a full four-digit code (`4220`)."},"department":{"type":"string","maxLength":80,"default":"","description":"Optional department of the company's domicile, e.g. `ANTIOQUIA`, `BOGOTA D.C.`. Case and accents are ignored."},"region":{"type":"string","enum":["any","bogota_cundinamarca","antioquia","costa_pacifica","region_caribe","centro_oriente","eje_cafetero","centro_sur","llanos"],"default":"any","description":"Optional region as the Superintendencia groups departments."},"supervision_status":{"type":"string","enum":["any","inspeccion","vigilancia","control","cancelada","exenta","nueva","camara_de_comercio"],"default":"any","description":"Optional standing before the Superintendencia: `inspeccion`, `vigilancia`, `control`, `cancelada`, `exenta`, `nueva` (roster only), `camara_de_comercio` (roster only), or `any`."},"min_revenue":{"type":"number","minimum":0,"default":0,"description":"Optional revenue floor for the fiscal year, in thousands of COP (`1000000` is one billion pesos). 0 applies no floor."},"include_all_filings":{"type":"boolean","default":false,"description":"`false` (default) returns one filing per company and fiscal year (the individual books when filed, else the separado, else the consolidado). `true` returns every filing, including consolidated ones."},"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":{"macrosector":"construccion","fiscal_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/SupersociedadesCompaniesSearchResponse"}}}},"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/company/v1":{"post":{"operationId":"supersociedades_company","summary":"Supersociedades Company","description":"A company's whole history of filings with the Superintendencia de Sociedades by NIT: every fiscal year since 2015, newest first, each with its activity, location, supervision status and headline figures (revenue, profit, assets, liabilities, equity, cash flows, ratios, ranking) in thousands of COP. The preferred filing of each year comes first. 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","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/SupersociedadesCompanyResponse"}}}},"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/filing-statements/v1":{"post":{"operationId":"supersociedades_filing_statements","summary":"Supersociedades Filing Statements","description":"The full financial statements of one filing with the Superintendencia de Sociedades, by NIT and fiscal year (the latest by default): the filing cover (objeto social, corporate form, status, revisor fiscal and opinion, reporting unit), every line of the statement of financial position, the income statement, other comprehensive income and the cash flow statement with the previous year's restatement, the statement of changes in equity by component, the cash breakdown and the Superintendencia's financial indicators. Figures in thousands of COP. 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","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."},"fiscal_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional fiscal year of the filing to read (2016 or later). 0 reads the latest filing."},"statement_type":{"type":"string","enum":["preferred","individual","separado","consolidado","combinado"],"default":"preferred","description":"Which filing of the year to read: `preferred` (the individual books when filed, else the separado, else the consolidado), or one of `individual`, `separado`, `consolidado`, `combinado`."}},"additionalProperties":false},"example":{"document_number":"900249127","fiscal_year":0}}}},"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/SupersociedadesFilingStatementsResponse"}}}},"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/ownership-search/v1":{"post":{"operationId":"supersociedades_ownership_search","summary":"Supersociedades Ownership Search","description":"Find the filings with the Superintendencia de Sociedades that declare a given person or company: by the identity document or NIT of a shareholder, an officer (legal representative, accountant, revisor fiscal) or a related company (subsidiary, associate, joint venture), optionally by role, company name and fiscal year. Each result is one filing's declared parties: shareholders with shares and percentage, foreign investors, subsidiaries, associates, joint ventures, officers and investor classes. Newest filing first. 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","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":[],"properties":{"party_document_number":{"type":"string","pattern":"^(?:\\d{4,15})?$","default":"","description":"Optional identity document or NIT of a person or company, numeric, as declared in the notes: finds the filings that declare it as a shareholder, officer or related company."},"party_role":{"type":"string","enum":["any","shareholder","officer","related"],"default":"any","description":"Where to match `party_document_number`: among the `shareholder`s (and foreign investors), the `officer`s (legal representatives, accountant, revisor fiscal), the `related` companies (subsidiaries, associates, joint ventures), or `any`."},"query":{"type":"string","maxLength":200,"default":"","description":"Optional words matched against the company name (razón social) as filed."},"fiscal_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional fiscal year (2015 or later). 0 searches every year."},"include_all_filings":{"type":"boolean","default":false,"description":"`false` (default) returns one filing per company and fiscal year (the individual books when filed, else the separado, else the consolidado). `true` returns every filing, including consolidated ones."},"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":{"party_document_number":"900249127","party_role":"any"}}}},"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/SupersociedadesOwnershipSearchResponse"}}}},"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/filing-ownership/v1":{"post":{"operationId":"supersociedades_filing_ownership","summary":"Supersociedades Filing Ownership","description":"The parties one filing with the Superintendencia de Sociedades declares, by NIT and fiscal year (the latest by default): shareholders or partners with identity document, shares and percentage, foreign investors, subsidiaries, associates and joint ventures with their NIT, the legal representatives, accountant and revisor fiscal, and the classes of investor. 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","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."},"fiscal_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional fiscal year of the filing to read (2016 or later). 0 reads the latest filing."},"statement_type":{"type":"string","enum":["preferred","individual","separado","consolidado","combinado"],"default":"preferred","description":"Which filing of the year to read: `preferred` (the individual books when filed, else the separado, else the consolidado), or one of `individual`, `separado`, `consolidado`, `combinado`."}},"additionalProperties":false},"example":{"document_number":"900249127","fiscal_year":0}}}},"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/SupersociedadesFilingOwnershipResponse"}}}},"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/filing-disclosures/v1":{"post":{"operationId":"supersociedades_filing_disclosures","summary":"Supersociedades Filing Disclosures","description":"The disclosure notes of one filing with the Superintendencia de Sociedades, by NIT and fiscal year (the latest by default), whole: property, plant and equipment, intangibles, leases, payables and receivables by age, revenue by activity, expenses, provisions, impairment, biological assets, investment property, the anti-money-laundering questionnaire of the Circular Básica Jurídica (five yes/no answers, also lifted as fields), and a parent's consolidated summary. Each note keeps every concept and member as filed. 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","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."},"fiscal_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional fiscal year of the filing to read (2016 or later). 0 reads the latest filing."},"statement_type":{"type":"string","enum":["preferred","individual","separado","consolidado","combinado"],"default":"preferred","description":"Which filing of the year to read: `preferred` (the individual books when filed, else the separado, else the consolidado), or one of `individual`, `separado`, `consolidado`, `combinado`."}},"additionalProperties":false},"example":{"document_number":"900249127","fiscal_year":0}}}},"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/SupersociedadesFilingDisclosuresResponse"}}}},"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/insolvency-processes-search/v1":{"post":{"operationId":"supersociedades_insolvency_processes_search","summary":"Supersociedades Insolvency Processes Search","description":"Every insolvency process a company reports in its annual filings with the Superintendencia de Sociedades (reorganización, liquidación judicial, acuerdos de reestructuración, concordatos, liquidación obligatoria, validación judicial), searchable by NIT, company name, process type, whether still open and admission date range. Each result is one process as the latest filing reports it: type, stage, origin, admission and closing dates. Most recently admitted first. 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","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":[],"properties":{"document_number":{"type":"string","pattern":"^(?:\\d{4,15})?$","default":"","description":"Optional Colombian NIT (numeric, no verification digit) to restrict the search to one company."},"query":{"type":"string","maxLength":200,"default":"","description":"Optional words matched against the company name (razón social) as filed."},"process_type":{"type":"string","enum":["any","reorganizacion","liquidacion_judicial","acuerdos_de_reestructuracion","concordatos","liquidacion_obligatoria","validacion"],"default":"any","description":"Optional process type: `reorganizacion`, `liquidacion_judicial`, `acuerdos_de_reestructuracion` (Ley 550), `concordatos`, `liquidacion_obligatoria`, `validacion` (validación judicial de acuerdos), or `any`."},"active_only":{"type":"boolean","default":false,"description":"`true` returns only processes with no closing date reported."},"admitted_from":{"type":"string","pattern":"^(?:\\d{4}-\\d{2}-\\d{2})?$","default":"","description":"Optional earliest admission date, `yyyy-mm-dd`, inclusive."},"admitted_to":{"type":"string","pattern":"^(?:\\d{4}-\\d{2}-\\d{2})?$","default":"","description":"Optional latest admission date, `yyyy-mm-dd`, inclusive."},"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":{"process_type":"reorganizacion","active_only":true,"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/SupersociedadesInsolvencyProcessesSearchResponse"}}}},"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/largest-companies-search/v1":{"post":{"operationId":"supersociedades_largest_companies_search","summary":"Supersociedades Largest Companies Search","description":"The 10,000 largest companies in Colombia each fiscal year since 2021, as the Superintendencia de Sociedades publishes them, whichever superintendencia supervises them (Supersociedades, Superfinanciera, Supersalud, Superservicios, Supertransporte, Supervigilancia): searchable by name, year, macrosector, supervisor, CIIU and department. Each result is one company in one year: NIT, name, supervisor, region, department, city, CIIU, macrosector, rank, and revenue, profit, assets, liabilities and equity in billions of COP. By rank. Served by Croma (`as_of` says how current the data is); the latest year is searched when `fiscal_year` is 0.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","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":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Optional words matched against the company name (razón social) as filed."},"fiscal_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional fiscal year (2015 or later). 0 searches the latest year available."},"macrosector":{"type":"string","enum":["any","agropecuario","minero","manufactura","construccion","comercio","servicios","transporte"],"default":"any","description":"Optional macrosector as the Superintendencia groups activities: `agropecuario`, `minero` (mining and hydrocarbons), `manufactura`, `construccion`, `comercio`, `servicios`, `transporte`, or `any`."},"supervisor":{"type":"string","enum":["any","supersociedades","superfinanciera","supersalud","superservicios","supertransporte","supervigilancia"],"default":"any","description":"Optional supervisor of the company: `supersociedades`, `superfinanciera`, `supersalud`, `superservicios`, `supertransporte`, `supervigilancia`, or `any`."},"ciiu_code":{"type":"string","pattern":"^(?:[A-Ua-u]|\\d{2,4})?$","default":"","description":"Optional CIIU Rev. 4 A.C. filter: a section letter (`F` for construction), a two-digit division (`42`), or a full four-digit code (`4220`)."},"department":{"type":"string","maxLength":80,"default":"","description":"Optional department of the company's domicile, e.g. `ANTIOQUIA`, `BOGOTA D.C.`. 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":{"fiscal_year":2025,"macrosector":"construccion","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/SupersociedadesLargestCompaniesSearchResponse"}}}},"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/supervised-entities-search/v1":{"post":{"operationId":"supersociedades_supervised_entities_search","summary":"Supersociedades Supervised Entities Search","description":"The roster of entities under the supervision of Colombia's Superintendencia de Sociedades at each year-end since 2021 (about 32,000 a year), searchable by name, NIT, standing (inspección, vigilancia, control, nueva) and department. Each result is one entity at one corte: NIT and check digit, name, standing, and the judicial notification address, department, city and email. Served by Croma (`as_of` says how current the data is); the latest corte is searched when `fiscal_year` is 0.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","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":[],"properties":{"query":{"type":"string","maxLength":200,"default":"","description":"Optional words matched against the company name (razón social) as filed."},"document_number":{"type":"string","pattern":"^(?:\\d{4,15})?$","default":"","description":"Optional Colombian NIT (numeric, no verification digit) to restrict the search to one company."},"supervision_status":{"type":"string","enum":["any","inspeccion","vigilancia","control","cancelada","exenta","nueva","camara_de_comercio"],"default":"any","description":"Optional standing before the Superintendencia: `inspeccion`, `vigilancia`, `control`, `cancelada`, `exenta`, `nueva` (roster only), `camara_de_comercio` (roster only), or `any`."},"department":{"type":"string","maxLength":80,"default":"","description":"Optional department of the company's domicile, e.g. `ANTIOQUIA`, `BOGOTA D.C.`. Case and accents are ignored."},"fiscal_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional fiscal year (2015 or later). 0 searches the latest year available."},"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":{"supervision_status":"vigilancia","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/SupersociedadesSupervisedEntitiesSearchResponse"}}}},"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-baranda/publications-search/v1":{"post":{"operationId":"supersociedades_baranda_publications_search","summary":"Supersociedades Baranda Publications Search","description":"Everything the Superintendencia de Sociedades has published on its Baranda Virtual since 2024 (estados, traslados, avisos, sentencias, autos, edictos and publicidad of every delegatura and intendencia regional), searchable by the NIT or cédula of the company or person it is about, by words of its name, subject or trámite, by list, dependencia, radicado, expediente and date. Each result carries the trámite, the dates, the company, the source's viewer link and our copy of the radicado's files. An estado row is the list itself; to search what the notified autos say, use `supersociedades_baranda_decisions_search`. Served by Croma from its copy (`as_of` says how current it is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Supersociedades Baranda Virtual"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-baranda"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"document_number":{"type":"string","maxLength":15,"default":"","description":"Optional NIT or cédula of the company or person the publication is about, digits only."},"query":{"type":"string","maxLength":200,"default":"","description":"Optional words matched against the company or person name, the subject and the trámite of the publication."},"kind":{"type":"string","enum":["any","estado","traslado","aviso","sentencia","auto","edicto","publicidad"],"default":"any","description":"Optional list to search: `estado`, `traslado`, `aviso`, `sentencia`, `auto`, `edicto`, `publicidad`, or `any`."},"dependency":{"type":"string","maxLength":60,"default":"","description":"Optional dependencia code as the source keys its lists, e.g. `apoyoJudicialR` (reorganización y concordato), `apoyoJudicialL` (liquidaciones), `apoyoJudicialPM` (procedimientos mercantiles), `notificaciones`, `medellinNew`. Every publication carries its `dependency`."},"filing_id":{"type":"string","maxLength":14,"default":"","description":"Optional número de radicado, `yyyy-01-nnnnnn`."},"file_number":{"type":"string","maxLength":40,"default":"","description":"Optional expediente (process file) number as the source prints it."},"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":"Rows per page, 1-100."}},"additionalProperties":false},"example":{"kind":"aviso","from_date":"2026-08-01","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/SupersociedadesBarandaPublicationsSearchResponse"}}}},"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-baranda/publication/v1":{"post":{"operationId":"supersociedades_baranda_publication","summary":"Supersociedades Baranda Publication","description":"One radicado as the Superintendencia de Sociedades published it on its Baranda Virtual: every list it appeared under (estado, traslado, aviso, ...), with the trámite, the dates, the company or person it is about, the source's viewer link and our copy of its files. Served by Croma from its copy of the publications since 2024.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Supersociedades Baranda Virtual"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-baranda"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filing_id"],"properties":{"filing_id":{"type":"string","minLength":14,"maxLength":14,"pattern":"^\\d{4}-\\d{2}-\\d{6}$","description":"Número de radicado as the Superintendencia prints it, `yyyy-01-nnnnnn`."}},"additionalProperties":false},"example":{"filing_id":"2026-01-706561"}}}},"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/SupersociedadesBarandaPublicationResponse"}}}},"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-baranda/decisions-search/v1":{"post":{"operationId":"supersociedades_baranda_decisions_search","summary":"Supersociedades Decisions Search","description":"Search the full text of the autos (court orders) the Superintendencia de Sociedades notifies in its daily estados since 2024: procedimientos mercantiles (corporate and commercial disputes, where it acts as a court), reorganización, liquidación judicial, intervención and its six intendencias regionales. Use it to find how the Superintendencia has recently ruled on a legal issue (write `query` in Spanish legal wording, e.g. `levantamiento de medidas cautelares poseedor`, `nulidad por indebida notificación`, `desestimación de la personalidad jurídica`), to follow every decision in a company's insolvency by NIT, or to read a day's estados without opening PDFs (`from_date` = `to_date`). Each result is one auto, newest notified first: the company or parties, the process, the asunto, the expediente and case number, the court officer, the dates, the estado line that notified it, the opening of what it orders, and our copy of the PDF. Results carry no full text: call `supersociedades_baranda_decision` with a result's `filing_id` to read the reasoning. Served by Croma from its copy (`as_of` says how current it is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Supersociedades Baranda Virtual"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-baranda"},"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 matched against the full text of each auto (the antecedentes, the Superintendencia's reasoning and what it orders), the company or parties, the asunto and the estado line, in Spanish, e.g. `levantamiento medidas cautelares poseedor` or `nulidad por indebida notificación`. Results stay newest first."},"document_number":{"type":"string","maxLength":15,"default":"","description":"Optional NIT or cédula of the company or person the process is about, digits only, no verification digit. Autos of procedimientos mercantiles name parties instead; search those with `query`."},"dependency":{"type":"string","enum":["any","apoyoJudicialPM","apoyoJudicialR","apoyoJudicialL","apoyoJudicialI","barranquillaNew","bucaramangaNew","caliNew","cartagenaNew","manizalesNew","medellinNew"],"default":"any","description":"Optional dependencia that notified the auto: `apoyoJudicialPM` (procedimientos mercantiles: corporate disputes, shareholder actions, piercing the corporate veil, the Superintendencia acting as a commercial court), `apoyoJudicialR` (reorganización), `apoyoJudicialL` (liquidación judicial), `apoyoJudicialI` (intervención), an intendencia regional (`barranquillaNew`, `bucaramangaNew`, `caliNew`, `cartagenaNew`, `manizalesNew`, `medellinNew`), or `any`."},"case_number":{"type":"string","maxLength":40,"default":"","description":"Optional número de proceso exactly as the auto prints it, e.g. `2024-800-00267` (procedimientos mercantiles) or `2024-INS-3404`."},"file_number":{"type":"string","maxLength":40,"default":"","description":"Optional expediente (process file) number as the source prints it."},"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":"Rows per page, 1-100."}},"additionalProperties":false},"example":{"query":"medidas cautelares","dependency":"apoyoJudicialL","from_date":"2026-09-01","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/SupersociedadesBarandaDecisionsSearchResponse"}}}},"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-baranda/decision/v1":{"post":{"operationId":"supersociedades_baranda_decision","summary":"Supersociedades Decision","description":"One auto (court order) of the Superintendencia de Sociedades by its radicado, with its full text: the antecedentes, the Superintendencia's reasoning with the norms and precedents it cites, and what it orders, plus the company or parties, the process, the expediente, the court officer, the dates, the estado that notified it and our copy of the PDF. Use it after `supersociedades_baranda_decisions_search` to read a decision worth citing, or with a radicado taken from an estado. Served by Croma from its copy of the autos notified since 2024.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Supersociedades Baranda Virtual"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-baranda"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filing_id"],"properties":{"filing_id":{"type":"string","minLength":14,"maxLength":14,"pattern":"^\\d{4}-\\d{2}-\\d{6}$","description":"Número de radicado as the Superintendencia prints it, `yyyy-01-nnnnnn`."}},"additionalProperties":false},"example":{"filing_id":"2026-01-732052"}}}},"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/SupersociedadesBarandaDecisionResponse"}}}},"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-baranda/company-file/v1":{"post":{"operationId":"supersociedades_baranda_company_file","summary":"Supersociedades Company File","description":"A company's or person's file at the Superintendencia de Sociedades, read live from its Baranda Virtual by NIT or cédula: its standing (inspección, vigilancia, control), situation (activa, reorganización, liquidación, ...), stage, cause, activity and domicile; its legal representatives, auditors and accountants; and, ten per page, the decisions (providencias) the Superintendencia issued in its processes and what was filed into them (entradas), newest first, each with the source's viewer link. Asynchronous: the source needs a verification per session.\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","Supersociedades Baranda Virtual"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-baranda"},"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":15,"pattern":"^\\d{4,15}$","description":"NIT or cédula of the company or person, digits only, no verification digit. 4-15 digits."},"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":{"document_number":"900553004"}}}},"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/SupersociedadesBarandaCompanyFileResponse"}}}},"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/supersociedades-baranda/company-search/v1":{"post":{"operationId":"supersociedades_baranda_company_search","summary":"Supersociedades Company Search","description":"Companies and persons the Superintendencia de Sociedades holds a file on, by words of their name or sigla, read live from its Baranda Virtual: NIT, name, type, supervision standing, situation, stage, activity and domicile of each match. Asynchronous: the source needs a verification per session.\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","Supersociedades Baranda Virtual"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-baranda"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string","minLength":3,"maxLength":120,"description":"Words of the company's name (razón social) or sigla, at least 3 characters."},"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":"Rows per page, 1-100."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"query":"TERRA BUNKERING"}}}},"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/SupersociedadesBarandaCompanySearchResponse"}}}},"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/supersociedades-baranda/filing/v1":{"post":{"operationId":"supersociedades_baranda_filing","summary":"Supersociedades Filing by Radicado","description":"One radicado of the Superintendencia de Sociedades read live from its Baranda Virtual: the trámite, the process, the dates, the company or person it is about, the source's viewer link, and the other radicados of the same expediente. Asynchronous: the source needs a verification per session.\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","Supersociedades Baranda Virtual"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-baranda"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filing_id"],"properties":{"filing_id":{"type":"string","minLength":14,"maxLength":14,"pattern":"^\\d{4}-\\d{2}-\\d{6}$","description":"Número de radicado as the Superintendencia prints it, `yyyy-01-nnnnnn`."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"filing_id":"2026-01-706561"}}}},"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/SupersociedadesBarandaFilingResponse"}}}},"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/supersociedades-relatoria/documents-search/v1":{"post":{"operationId":"supersociedades_relatoria_documents_search","summary":"Supersociedades Relatoría Search","description":"The Superintendencia de Sociedades' conceptos jurídicos (since 1993) and the sentencias of its Delegatura de Procedimientos Mercantiles, searchable by words over the title, subject and full text, by kind, thesaurus descriptor, subject, party NIT or cédula, radicado, case number, year and date. Each result carries the descriptors, the parties and the dates; the `document` endpoint returns the full text, the legal sources, the problemas jurídicos and the sentencia's parts. Served by Croma from its copy (`as_of` says how current it is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Supersociedades Relatoría"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-relatoria"},"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 matched against the title, the subject and the full text."},"content_type":{"type":"string","enum":["any","legal_opinion","ruling","oral_ruling","topic"],"default":"any","description":"Optional kind of document: `legal_opinion` (concepto jurídico), `ruling` (sentencia escrita), `oral_ruling` (sentencia en audiencia), `topic` (tema y problema), or `any`."},"descriptor":{"type":"string","maxLength":120,"default":"","description":"Optional main descriptor of the relatoría's thesaurus, exactly as it prints it, e.g. `Administradores`."},"subject":{"type":"string","maxLength":200,"default":"","description":"Optional tema exactly as the relatoría names it, e.g. `Responsabilidad de los administradores`."},"party_document_number":{"type":"string","maxLength":15,"default":"","description":"Optional NIT or cédula of the company or person the publication is about, digits only."},"consecutive":{"type":"string","maxLength":10,"default":"","description":"Optional consecutivo of the concepto or sentencia, `nnn-nnnnnn`, e.g. `220-001087`."},"filing_id":{"type":"string","maxLength":14,"default":"","description":"Optional número de radicado, `yyyy-01-nnnnnn`."},"case_number":{"type":"string","maxLength":30,"default":"","description":"Optional número de proceso as the Superintendencia prints it, e.g. `2019-800-00212`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year (1990 or later). 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":"Rows per page, 1-100."}},"additionalProperties":false},"example":{"query":"abuso del derecho de voto","content_type":"ruling","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/SupersociedadesRelatoriaDocumentsSearchResponse"}}}},"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-relatoria/document/v1":{"post":{"operationId":"supersociedades_relatoria_document","summary":"Supersociedades Relatoría Document","description":"One concepto jurídico or sentencia of the Superintendencia de Sociedades by its identifier, whole: the full text as the relatoría transcribed it, the legal sources and citations, the parties, the problemas jurídicos with the doctrinal positions on them, and the sentencia split in its parts (facts, claims, considerations, resolution). Served by Croma from its copy.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Supersociedades Relatoría"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-relatoria"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$","description":"The document's identifier, as a search result carries it in `id`."}},"additionalProperties":false},"example":{"id":"49850"}}}},"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/SupersociedadesRelatoriaDocumentResponse"}}}},"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-relatoria/historical-rulings-search/v1":{"post":{"operationId":"supersociedades_relatoria_historical_rulings_search","summary":"Supersociedades Historical Rulings Search","description":"The ruling files the Superintendencia de Sociedades keeps on its portal, one PDF each: about 18,000 autos and sentencias of the insolvency delegatura (2012-2021) and about 330 of the mercantile delegatura (2012-2019), searchable by words over the title, description, case and subject, by collection, category, year and date, each with the Superintendencia's metadata and our copy of the file. Served by Croma from its copy.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Supersociedades Relatoría"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-relatoria"},"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 matched against the title, the subject and the full text."},"collection":{"type":"string","enum":["any","insolvency","mercantile"],"default":"any","description":"Optional collection: `insolvency` (rulings of the insolvency delegatura), `mercantile` (rulings of the mercantile delegatura), or `any`."},"category":{"type":"string","maxLength":120,"default":"","description":"Optional category as the Superintendencia names it, e.g. `Liquidaciones`, `Reorganización`, `Régimen de Administradores`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year (1990 or later). 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":"Rows per page, 1-100."}},"additionalProperties":false},"example":{"collection":"mercantile","query":"administradores","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/SupersociedadesRelatoriaHistoricalRulingsSearchResponse"}}}},"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-relatoria/opinion-files-search/v1":{"post":{"operationId":"supersociedades_relatoria_opinion_files_search","summary":"Supersociedades Opinion Files Search","description":"The conceptos of the Superintendencia de Sociedades as its portal publishes them, one PDF each: about 13,000 conceptos jurídicos of its legal office and about 900 conceptos contables since 2013, searchable by words over the title and epígrafe, by collection, consecutivo, year, whether the Superintendencia marks them as vigente, and date, each with our copy of the file. The consecutivo joins a concepto jurídico to its full text in `documents-search`. Served by Croma from its copy.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Supersociedades Relatoría"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-relatoria"},"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 matched against the title, the subject and the full text."},"collection":{"type":"string","enum":["any","legal","accounting"],"default":"any","description":"Optional collection: `legal` (conceptos jurídicos), `accounting` (conceptos contables), or `any`."},"consecutive":{"type":"string","maxLength":10,"default":"","description":"Optional consecutivo of the concepto or sentencia, `nnn-nnnnnn`, e.g. `220-001087`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year (1990 or later). 0 searches every year."},"in_force":{"type":"string","enum":["any","yes","no"],"default":"any","description":"Optional: `yes` for conceptos the Superintendencia marks as vigente, `no` for the ones it marks as no longer in force, or `any`."},"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":"Rows per page, 1-100."}},"additionalProperties":false},"example":{"collection":"legal","query":"oficial de cumplimiento","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/SupersociedadesRelatoriaOpinionFilesSearchResponse"}}}},"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-relatoria/bulletins-search/v1":{"post":{"operationId":"supersociedades_relatoria_bulletins_search","summary":"Supersociedades Bulletins Search","description":"The bulletins of the Superintendencia de Sociedades: the monthly Boletín de Conceptos Jurídicos since 2010 and the Boletín de Conceptos Contables by semester of its legal office, plus the mercantile delegatura's compilations (the six volumes of its Boletín de Jurisprudencia and the four Libros de Jurisprudencia Societaria), searchable by words over the title and summary, by series and date, each with our copy of the PDF where the Superintendencia hosts it. Served by Croma from its copy.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Supersociedades Relatoría"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-relatoria"},"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 matched against the title, the subject and the full text."},"series":{"type":"string","enum":["any","legal_opinions","accounting","jurisprudence"],"default":"any","description":"Optional series: `legal_opinions` (Boletín de Conceptos Jurídicos), `accounting` (Boletín de Conceptos Contables), `jurisprudence` (Boletín de Jurisprudencia and Libros de Jurisprudencia Societaria of the mercantile delegatura), or `any`."},"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":"Rows per page, 1-100."}},"additionalProperties":false},"example":{"series":"legal_opinions","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/SupersociedadesRelatoriaBulletinsSearchResponse"}}}},"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-relatoria/notices-search/v1":{"post":{"operationId":"supersociedades_relatoria_notices_search","summary":"Supersociedades Notices Search","description":"The notices the Superintendencia de Sociedades publishes on its portal since 2006: avisos of agentes interventores, reorganizations, judicial and mandatory liquidations, liquidations by adjudication, special proceedings and general insolvency matters, each with its text and our copy of its files; and the autos of civil courts on insolvency processes, which the Superintendencia lists for about a week and this copy keeps. Searchable by words over the title and text, by kind and date. Served by Croma from its copy.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Supersociedades Relatoría"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-relatoria"},"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 matched against the title, the subject and the full text."},"kind":{"type":"string","enum":["any","intervention","reorganization","judicial_liquidation","mandatory_liquidation","adjudication","special","general","court_order"],"default":"any","description":"Optional kind of notice: `intervention`, `reorganization`, `judicial_liquidation`, `mandatory_liquidation`, `adjudication`, `special`, `general`, `court_order`, or `any`."},"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":"Rows per page, 1-100."}},"additionalProperties":false},"example":{"kind":"intervention","from_date":"2026-01-01","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/SupersociedadesRelatoriaNoticesSearchResponse"}}}},"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-relatoria/notice/v1":{"post":{"operationId":"supersociedades_relatoria_notice","summary":"Supersociedades Notice","description":"One notice of the Superintendencia de Sociedades' portal by its identifier, with its text and our copy of its files. Served by Croma from its copy.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","Supersociedades Relatoría"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/supersociedades-relatoria"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","minLength":7,"maxLength":30,"pattern":"^(notice|order):\\d+$","description":"The notice's identifier, as a search result carries it in `id`: `notice:<n>` or `order:<n>`."}},"additionalProperties":false},"example":{"id":"notice:10086353"}}}},"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/SupersociedadesRelatoriaNoticeResponse"}}}},"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/sunarp/registry-search/v1":{"post":{"operationId":"sunarp_registry_search","summary":"SUNARP Registry Search","description":"Search one SUNARP registry office (e.g. `LIMA`) and registry (`vehicles`, `real_estate`, `legal_entities`, ...) by partida, plate or ficha number. Returns the matching partidas with their zone, office and status; for vehicles also the plate and vehicle status. Pass a `partida_number` to `sunarp-registry-entry` for its inscriptions and pages. `found: false` when nothing 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","SUNARP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/sunarp"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["office","registry_area","number"],"properties":{"office":{"type":"string","minLength":2,"maxLength":60,"description":"The registry office (oficina registral) by name, e.g. `LIMA`, `AREQUIPA`, `CUSCO`. Case and accents are ignored."},"registry_area":{"type":"string","enum":["real_estate","non_land_property","legal_entities","natural_persons","vehicles","mining","vessels","aircraft","movable_contracts"],"description":"The registry: `real_estate` (propiedad inmueble predial), `non_land_property` (propiedad inmueble no predial), `legal_entities` (personas jurídicas), `natural_persons` (personas naturales), `vehicles` (propiedad vehicular), `mining` (propiedad minera), `vessels` (naves y embarcaciones), `aircraft` (aeronaves) or `movable_contracts` (registro mobiliario de contratos)."},"search_by":{"type":"string","enum":["partida","plate","ficha"],"default":"partida","description":"What `number` is: `partida` (the registry entry number, the default), `plate` (vehicles only) or `ficha` (the older card number, every registry except vehicles). A partida starting with P is written as `P12345678`."},"number":{"type":"string","minLength":3,"maxLength":12,"pattern":"^[A-Za-z0-9][A-Za-z0-9 -]{1,10}[A-Za-z0-9]$","description":"The partida, plate or ficha number, e.g. `53237569` or `AKI774`. Spaces and hyphens are ignored."},"connection_id":{"type":"string","default":"","description":"Optional. Run as this connection (`conn_…`). Empty lets Croma pick among your organization's connections, moving to the next one when one reaches its daily allowance."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"office":"LIMA","registry_area":"vehicles","search_by":"plate","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/SunarpRegistrySearchResponse"}}}},"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/sunarp/registry-entry/v1":{"post":{"operationId":"sunarp_registry_entry","summary":"SUNARP Registry Entry","description":"Read one SUNARP partida: its inscriptions (asientos), newest first, with act, date, title and section, the older cards and book folios it continues from, and every page as a PDF we keep (`document_url`). Take `office`, `registry_area` and `partida_number` from a `sunarp-registry-search` result. `found: false` when the office has no such partida; `has_images: false` when SUNARP shows no pages for it (vehicle partidas: for a vehicle's characteristics and owners use `sunarp-vehicular-vehicle-by-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","SUNARP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/sunarp"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["office","registry_area","partida_number"],"properties":{"office":{"type":"string","minLength":2,"maxLength":60,"description":"The registry office (oficina registral) by name, e.g. `LIMA`, `AREQUIPA`, `CUSCO`. Case and accents are ignored."},"registry_area":{"type":"string","enum":["real_estate","non_land_property","legal_entities","natural_persons","vehicles","mining","vessels","aircraft","movable_contracts"],"description":"The registry: `real_estate` (propiedad inmueble predial), `non_land_property` (propiedad inmueble no predial), `legal_entities` (personas jurídicas), `natural_persons` (personas naturales), `vehicles` (propiedad vehicular), `mining` (propiedad minera), `vessels` (naves y embarcaciones), `aircraft` (aeronaves) or `movable_contracts` (registro mobiliario de contratos)."},"partida_number":{"type":"string","minLength":3,"maxLength":12,"pattern":"^[A-Za-z0-9][A-Za-z0-9 -]{1,10}[A-Za-z0-9]$","description":"The partida number from a search result, e.g. `53237569`. A partida starting with P is written as `P12345678`."},"connection_id":{"type":"string","default":"","description":"Optional. Run as this connection (`conn_…`). Empty lets Croma pick among your organization's connections, moving to the next one when one reaches its daily allowance."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"office":"LIMA","registry_area":"real_estate","partida_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/SunarpRegistryEntryResponse"}}}},"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/sunarp-vehicular/vehicle-by-plate/v1":{"post":{"operationId":"sunarp_vehicular_vehicle_by_plate","summary":"SUNARP Vehicle by Plate","description":"Look up a vehicle in SUNARP's vehicle registry by plate: make, model, model year, color, engine number, serial number and VIN, plate in force and previous plate, status, annotations summary, theft alert, current owners (names) and the registry office and partida number. Includes a stored copy of the record SUNARP returned. `found: false` when no vehicle has that 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","SUNARP"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/sunarp-vehicular"},"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; hyphens and spaces are ignored)."},"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/SunarpVehicleResponse"}}}},"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, CAT and Vehicle Insurance Report","description":"Look up a Peruvian vehicle plate's SOAT, CAT and vehicle insurance reports from SBS (Superintendencia de Banca, Seguros y AFP), Peru's banking and insurance regulator, in one call. The top level is SOAT (mandatory traffic-accident insurance): `accident_count` (accidents covered in the last 5 years), `policies` (issuing company, vehicle class/use, accidents per policy, policy/certificate number, coverage window, status VIGENTE/VENCIDA/ANULADA, annulment date and reason, rectification date), `has_active_soat` with the current policy as `active`, and `coverages`. `vehicle_insurance` is the private Seguro Vehicular report with the same policy shape and `has_active_policy`. `cat` is the CAT report (certificates AFOCATs issue to public transport vehicles), with `certificates`, `has_active_cat` and `coverages`. `found: false` at any level means that report has nothing on record 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":4,"maxLength":11,"pattern":"^[A-Za-z0-9][A-Za-z0-9 .·-]{2,9}[A-Za-z0-9]$","description":"Colombian vehicle plate, e.g. `ABC123`, `ABC12D`, `R12345` or `123ABC`. Spaces, dots and hyphens are ignored."},"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-by-vin/v1":{"post":{"operationId":"runt_vehicle_by_vin","summary":"RUNT Vehicle by VIN","description":"Resolve a Colombian vehicle in RUNT (Registro Único Nacional de Tránsito) by its VIN (número único de identificación) alone, with no plate and no owner document. Returns the same record and detail sections as `runt_vehicle_by_plate` (SOAT, inspections, specifications, liens, ownership limitations, armoring, civil liability, certificates), with `plate` carrying the registered plate. `found: false` when nothing is registered under the VIN.\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":["vin"],"properties":{"vin":{"type":"string","minLength":3,"maxLength":50,"pattern":"^[A-Za-z0-9]{3,50}$","description":"Vehicle identification number (VIN), e.g. `9BWZZZ377VT004251`."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"vin":"9BWZZZ377VT004251"}}}},"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/RuntVehicleByVinResponse"}}}},"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":4,"maxLength":11,"pattern":"^[A-Za-z0-9][A-Za-z0-9 .·-]{2,9}[A-Za-z0-9]$","description":"Colombian vehicle plate, e.g. `ABC123`, `ABC12D`, `R12345` or `123ABC`. Spaces, dots and hyphens are ignored."},"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/runt/citizen-by-document/v1":{"post":{"operationId":"runt_citizen_by_document","summary":"RUNT Citizen by Document","description":"Look up a person in RUNT (Registro Único Nacional de Tránsito) by identification document: the driver record (name, registration id and date, person and driver status), every driving licence with its categories, issue and expiry dates, restrictions, retention, suspension and cancellation, traffic-fine standing (paz y salvo), procedure requests (solicitudes), driving-aptitude and medical certificates with their detail, CUPL registrations, SICOV validations, ANSV payments and identity-validation history. `document_type` defaults to `CC`. `first_surname` is optional: when omitted, the surname on record is used. `found: false` when the registry has no record for the 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","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":["document_number"],"properties":{"document_type":{"type":"string","enum":["CC","CE","TI","RC","PA","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)."},"first_surname":{"type":"string","maxLength":60,"default":"","description":"First surname (primer apellido). Optional: when omitted, the surname on record is used."},"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/RuntCitizenResponse"}}}},"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/citizen-by-plate/v1":{"post":{"operationId":"runt_citizen_by_plate","summary":"RUNT Citizen by Plate","description":"Look up the current registered owner of a Colombian vehicle in RUNT (Registro Único Nacional de Tránsito) by plate alone, and return that person's citizen record: the driver record, driving licences with categories, traffic-fine standing, procedure requests, driving-aptitude and medical certificates, CUPL registrations, SICOV validations, ANSV payments and identity validation. The owner (document type, number and name) is echoed in `owner`. `found: false` when the plate has no current natural-person owner or the owner 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":4,"maxLength":11,"pattern":"^[A-Za-z0-9][A-Za-z0-9 .·-]{2,9}[A-Za-z0-9]$","description":"Colombian vehicle plate, e.g. `ABC123`, `ABC12D`, `R12345` or `123ABC`. Spaces, dots and hyphens are ignored."},"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/RuntCitizenByPlateResponse"}}}},"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"}}}}}}},"/pe/tribunal-constitucional/rulings-search/v1":{"post":{"operationId":"tribunal_constitucional_rulings_search","summary":"Tribunal Constitucional Rulings Search","description":"Search every resolution the Tribunal Constitucional del Perú has published since 1996: sentencias, autos and sentencias interlocutorias. Free text matches the case file number, the resolution number and the full text. Filter by `type`, `proceeding_type` (`AA` amparo, `HC` hábeas corpus, `HD` hábeas data, `AC` cumplimiento, `AI`/`PI` inconstitucionalidad, `CC` competencial, `Q` queja), `chamber`, `registration_number` (the expediente), `year` and the publication date (`from_date`/`to_date`). Each result links to the document 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":["Peru","Tribunal Constitucional"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/tribunal-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 case file number, the resolution number and the full text."},"type":{"type":"string","enum":["","sentencia","auto","sentencia_interlocutoria"],"default":"","description":"Optional kind of resolution: `sentencia`, `auto` (autos and decretos) or `sentencia_interlocutoria`."},"proceeding_type":{"type":"string","maxLength":40,"default":"","description":"Optional kind of proceeding, by code or by name: `AA` (amparo), `HC` (hábeas corpus), `HD` (hábeas data), `AC` (cumplimiento), `AI` or `PI` (inconstitucionalidad), `CC` (competencial), `Q` (queja)."},"chamber":{"type":"string","maxLength":20,"default":"","description":"Optional chamber: `Pleno`, `Sala Primera` or `Sala Segunda`."},"registration_number":{"type":"string","maxLength":40,"default":"","description":"Optional case file number (expediente) as the court writes it, e.g. `05005-2025-HC`. Returns every document of that case. Case and spaces are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of publication. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"debido proceso","proceeding_type":"HC"}}}},"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/TribunalConstitucionalRulingsSearchResponse"}}}},"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/tribunal-constitucional/ruling/v1":{"post":{"operationId":"tribunal_constitucional_ruling","summary":"Tribunal Constitucional Ruling","description":"Retrieve one resolution of the Tribunal Constitucional del Perú by its `id` from a search result (e.g. `2026/05005-2025-HC.pdf`) or its `official_url`: its full text, the case file number, the kind of resolution and of proceeding, the chamber and the link to the document 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":["Peru","Tribunal Constitucional"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/tribunal-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","minLength":5,"maxLength":400,"description":"The resolution's `id` from a search result, e.g. `2026/05005-2025-HC.pdf`. Its `official_url` works too."},"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":"2026/05005-2025-HC.pdf"}}}},"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/TribunalConstitucionalRulingResponse"}}}},"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/servir-tsc/resolutions-search/v1":{"post":{"operationId":"servir_tsc_resolutions_search","summary":"Tribunal del Servicio Civil Resolutions Search","description":"Search every resolution Peru's Tribunal del Servicio Civil (SERVIR) has issued since 2010, across both chambers. Free text matches the resolution number, the entity, the tribunal's summary and the full text. Filter by `chamber` (`primera_sala` or `segunda_sala`), `resolution_number`, `year` and the session date (`from_date`/`to_date`). Each result links to the document as published. 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":["Peru","Tribunal del Servicio Civil"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/servir-tsc"},"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 resolution number, the entity, the summary and the full text."},"chamber":{"type":"string","maxLength":20,"default":"","description":"Optional chamber: `primera_sala` or `segunda_sala`."},"resolution_number":{"type":"string","maxLength":20,"default":"","description":"Optional resolution number, with or without its year, e.g. `05763-2025` or `5763`. Leading zeros are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the resolution. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"régimen disciplinario","chamber":"primera_sala"}}}},"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/ServirTscResolutionsSearchResponse"}}}},"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/servir-tsc/resolution/v1":{"post":{"operationId":"servir_tsc_resolution","summary":"Tribunal del Servicio Civil Resolution","description":"Retrieve one resolution of Peru's Tribunal del Servicio Civil by its `id` from a search result (e.g. `7586381`) or its `page_url`: its full text, the number, the chamber, the session date, the entity, the case file, the employment regime, the subject and the tribunal's summary. 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":["Peru","Tribunal del Servicio Civil"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/peru/servir-tsc"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resolution_id"],"properties":{"resolution_id":{"type":"string","minLength":1,"maxLength":300,"description":"The resolution's `id` from a search result, e.g. `7586381`. Its `page_url` works too."},"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":{"resolution_id":"7586381"}}}},"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/ServirTscResolutionResponse"}}}},"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/sunbiz/fictitious-names-search/v1":{"post":{"operationId":"sunbiz_fictitious_names_search","summary":"Sunbiz Fictitious Names Search","description":"Search every fictitious name (DBA) registered with the Florida Division of Corporations since 2008, in force or not, by the trade name and its owners' names, by status, county, the owning entity's document number, a company owner's FEI and filing dates. Answers who is behind a trade name. 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","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 los nombres del registro (opcional)."},"status":{"type":"string","enum":["","active","inactive"],"default":"","description":"Estado de la entidad: `active` o `inactive` (opcional)."},"county":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (opcional)."},"owner_document_number":{"type":"string","pattern":"^(?:[A-Z]{0,2}\\d{4,12})?$","default":"","description":"Número de documento de una entidad de Florida, p. ej. `P26000044030` (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."},"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":"tacos"}}}},"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/SunbizFictitiousNamesSearchResponse"}}}},"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/fictitious-name/v1":{"post":{"operationId":"sunbiz_fictitious_name","summary":"Sunbiz Fictitious Name","description":"Read one Florida fictitious name (DBA) by its registration number, with its owners and every event filed against it since 1991: renewals, changes of address or owner, owners added or removed, cancellation. `found: false` when the Division has no such registration. Served by Croma, 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":"^G\\d{10,11}$","description":"Número de registro del nombre comercial en Florida, p. ej. `G26000123456`."}},"additionalProperties":false},"example":{"document_number":"G26000132362"}}}},"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/SunbizFictitiousNameResponse"}}}},"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/federal-liens-search/v1":{"post":{"operationId":"sunbiz_federal_liens_search","summary":"Sunbiz Federal Liens Search","description":"Search the federal tax lien notices registered with the Florida Division of Corporations since 2009, and the releases since 1993, by the debtor's or the secured party's name, status (active, released, inactive) and filing dates. Each lien with its debtors, secured parties and events. Newest first, pages of up to 50. Served by Croma, 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 los nombres del registro (opcional)."},"status":{"type":"string","enum":["","active","released","inactive"],"default":"","description":"Estado del gravamen: `active`, `released` o `inactive` (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."},"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":"construction"}}}},"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/SunbizFederalLiensSearchResponse"}}}},"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/federal-lien/v1":{"post":{"operationId":"sunbiz_federal_lien","summary":"Sunbiz Federal Lien","description":"Read one federal tax lien registered with the Florida Division of Corporations by its document number: the notice, its debtors, its secured parties and every event, release included. `found: false` when the Division has no such lien. Served by Croma, 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":"^\\d{2}FLR\\d{7}$","description":"Número de registro del gravamen federal en Florida, p. ej. `08FLR0012050`."}},"additionalProperties":false},"example":{"document_number":"26FLR0003440"}}}},"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/SunbizFederalLienResponse"}}}},"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/marks-search/v1":{"post":{"operationId":"sunbiz_marks_search","summary":"Sunbiz Marks Search","description":"Search every trademark and service mark registered with the Florida Division of Corporations, in force or not, by the mark and its owners' names, status, class, the owning entity's document number and filing dates. Newest first, pages of up to 50. Served by Croma, 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 los nombres del registro (opcional)."},"status":{"type":"string","enum":["","active","inactive"],"default":"","description":"Estado de la entidad: `active` o `inactive` (opcional)."},"class_code":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (opcional)."},"owner_document_number":{"type":"string","pattern":"^(?:[A-Z]{0,2}\\d{4,12})?$","default":"","description":"Número de documento de una entidad de Florida, p. ej. `P26000044030` (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."},"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":"coffee"}}}},"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/SunbizMarksSearchResponse"}}}},"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/mark/v1":{"post":{"operationId":"sunbiz_mark","summary":"Sunbiz Mark","description":"Read one trademark or service mark registered with the Florida Division of Corporations by its number: the mark, its classes, what it is used for, its dates and its owners. `found: false` when the Division has no such mark. Served by Croma, 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":["number"],"properties":{"number":{"type":"string","pattern":"^(?:T\\d{5}|T\\d{11}|\\d{6})$","description":"Número de registro de la marca en Florida, p. ej. `T26000123456`."}},"additionalProperties":false},"example":{"number":"T26000001070"}}}},"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/SunbizMarkResponse"}}}},"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/general-partnerships-search/v1":{"post":{"operationId":"sunbiz_general_partnerships_search","summary":"Sunbiz General Partnerships Search","description":"Search every general and limited liability partnership registered with the Florida Division of Corporations by its name and its partners' names, status, a partner entity's document number and filing dates. Newest first, pages of up to 50. Served by Croma, 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 los nombres del registro (opcional)."},"status":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (opcional)."},"partner_document_number":{"type":"string","pattern":"^(?:[A-Z]{0,2}\\d{4,12})?$","default":"","description":"Número de documento de una entidad de Florida, p. ej. `P26000044030` (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."},"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":"partners"}}}},"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/SunbizGeneralPartnershipsSearchResponse"}}}},"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/general-partnership/v1":{"post":{"operationId":"sunbiz_general_partnership","summary":"Sunbiz General Partnership","description":"Read one general or limited liability partnership registered with the Florida Division of Corporations by its document number, with its partners and every event filed against it. `found: false` when the Division has no such partnership. Served by Croma, 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":"^(?:GP|LLP)\\d{6,10}$","description":"Número de documento de la sociedad general en Florida, p. ej. `GP2600012345`."}},"additionalProperties":false},"example":{"document_number":"GP2600000361"}}}},"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/SunbizGeneralPartnershipResponse"}}}},"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/companies-search/v1":{"post":{"operationId":"sec_companies_search","summary":"SEC EDGAR Companies Search","description":"Search every filer EDGAR knows, about a million companies, funds, trusts and people, by current or former name, EIN, ticker, exchange, SIC code, state or country of incorporation, state of the business address and entity type. Returns each filer's CIK, EIN, SIC, state of incorporation, addresses, phone, tickers and former names. Most recently active 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 actual y en los nombres anteriores del filer (opcional)."},"ein":{"type":"string","pattern":"^(?:\\d{2}-?\\d{7})?$","default":"","description":"FEI/EIN de nueve dígitos de la entidad (opcional)."},"ticker":{"type":"string","pattern":"^[A-Za-z0-9.\\-]{0,12}$","default":"","description":"Ticker bursátil, p. ej. `AAPL` (opcional)."},"exchange":{"type":"string","maxLength":20,"default":"","description":"Bolsa donde cotiza, como la nombra EDGAR: `NYSE`, `Nasdaq`, `OTC` o `CBOE` (opcional)."},"sic":{"type":"string","pattern":"^(?:\\d{3,4})?$","default":"","description":"Código SIC de la actividad, p. ej. `3571` (opcional)."},"state_of_incorporation":{"type":"string","pattern":"^(?:[A-Za-z][A-Za-z0-9])?$","default":"","description":"Código de estado o país de EDGAR, p. ej. `DE` o `E9` (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Za-z][A-Za-z0-9])?$","default":"","description":"Código de estado o país de EDGAR, p. ej. `DE` o `E9` (opcional)."},"entity_type":{"type":"string","enum":["","operating","investment","other"],"default":"","description":"Tipo de filer en EDGAR: `operating`, `investment` u `other` (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":"apple"}}}},"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/SecCompaniesSearchResponse"}}}},"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/company/v1":{"post":{"operationId":"sec_company","summary":"SEC EDGAR Company","description":"Resolve one EDGAR filer by its CIK and return its record (name and former names, EIN, SIC code, state of incorporation, addresses, phone, tickers and exchanges, filing counts) with its latest event filings since 2020: 8-K current reports, mergers, delistings, registrations, late-filing notices and 13D stakes. `found: false` when EDGAR has no filer under that CIK. 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":["cik"],"properties":{"cik":{"type":"string","pattern":"^\\d{1,10}$","description":"CIK del filer en EDGAR, con o sin ceros a la izquierda, p. ej. `320193`."}},"additionalProperties":false},"example":{"cik":"320193"}}}},"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/SecCompanyResponse"}}}},"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/filing-events-search/v1":{"post":{"operationId":"sec_filing_events_search","summary":"SEC EDGAR Filing Events Search","description":"Search every event filing on EDGAR since 2020: 8-K current reports with their items (bankruptcy, acquisition completed, delisting notice, officer change, ...), mergers and tender offers (S-4, F-4, 425, merger proxies), delistings and deregistrations (25-NSE, 15-12B), registrations and listings (S-1, F-1, 8-A), late-filing notices and Schedule 13D stakes. Filter by filer name, CIK, event type, form, 8-K item and filing dates; each event comes with the filer's EIN, state of incorporation and tickers. 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 actual y en los nombres anteriores del filer (opcional)."},"cik":{"type":"string","pattern":"^\\d{0,10}$","default":"","description":"CIK del emisor en EDGAR, con o sin ceros a la izquierda (opcional)."},"event_type":{"type":"string","enum":["","current_report","merger_or_acquisition","delisting_or_deregistration","registration","late_filing_notice","beneficial_ownership"],"default":"","description":"Tipo de evento: `current_report`, `merger_or_acquisition`, `delisting_or_deregistration`, `registration`, `late_filing_notice` o `beneficial_ownership` (opcional)."},"form":{"type":"string","maxLength":20,"default":"","description":"Tipo de formulario exactamente como lo escribe EDGAR, p. ej. `8-K`, `S-4`, `25-NSE`, `SC 13D` (opcional)."},"item":{"type":"string","pattern":"^(?:\\d\\.\\d{2})?$","default":"","description":"Ítem del 8-K, p. ej. `3.01` (aviso de exclusión de cotización) o `5.02` (cambio de directivos) (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."},"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":{"form":"8-K","item":"3.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/SecFilingEventsSearchResponse"}}}},"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/filing-event/v1":{"post":{"operationId":"sec_filing_event","summary":"SEC EDGAR Filing Event","description":"Resolve one event filing by its EDGAR accession number and return it once per filer on it (a 13D's filer and the company it covers, a merger's two sides), each with the filer's EIN, state of incorporation and tickers. `found: false` when the accession number is not an event filing since 2020. 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":"0000929638-26-003569"}}}},"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/SecFilingEventResponse"}}}},"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/dol-oflc/lca-search/v1":{"post":{"operationId":"dol_oflc_lca_search","summary":"DOL H-1B LCA Search","description":"Search every Labor Condition Application DOL decided since fiscal year 2008 (the filing an employer makes to hire on an H-1B, H-1B1 or E-3 visa) by employer, trade name or job title, employer FEIN, case number, fiscal year, visa class, case status, SOC code, worksite state, minimum offered wage and decision dates. Each determination carries the employer, the job, the offered and prevailing wage, the primary worksite, the employer's contact, the attorney and Appendix A. Newest decision first, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date as DOL publishes each quarter.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","DOL H-1B and PERM"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/dol-oflc"},"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 empleador, su nombre comercial y el cargo (opcional)."},"employer_fein":{"type":"string","pattern":"^(?:\\d{2}-?\\d{7})?$","default":"","description":"FEI/EIN de nueve dígitos de la entidad (opcional)."},"case_number":{"type":"string","pattern":"^(?:[A-Z]-(?:\\d{3}-)?\\d{5}-\\d{6,7})?$","default":"","description":"Número de caso de DOL (opcional)."},"fiscal_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Año fiscal federal (octubre a septiembre), p. ej. `2026` (opcional)."},"visa_class":{"type":"string","enum":["","H-1B","H-1B1 Chile","H-1B1 Singapore","E-3 Australian"],"default":"","description":"Clase de visa: `H-1B`, `H-1B1 Chile`, `H-1B1 Singapore` o `E-3 Australian` (opcional)."},"case_status":{"type":"string","enum":["","Certified","Certified - Withdrawn","Withdrawn","Denied","Rejected","Invalidated"],"default":"","description":"Estado del caso: `Certified`, `Certified - Withdrawn`, `Withdrawn`, `Denied`, `Rejected` o `Invalidated` (opcional)."},"soc_code":{"type":"string","pattern":"^(?:\\d{2}-\\d{4}(?:\\.\\d{2})?)?$","default":"","description":"Código SOC de la ocupación, p. ej. `15-1252.00` (opcional)."},"worksite_state":{"type":"string","pattern":"^(?:[A-Z]{2})?$","default":"","description":"Código de estado de dos letras, p. ej. `FL` (opcional)."},"min_wage":{"type":"number","minimum":0,"default":0,"description":"Monto mínimo, en dólares (opcional)."},"decided_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"decided_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":{"query":"software engineer","worksite_state":"CA","case_status":"Certified"}}}},"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/DolOflcLcaSearchResponse"}}}},"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/dol-oflc/lca-case/v1":{"post":{"operationId":"dol_oflc_lca_case","summary":"DOL H-1B LCA Case","description":"Resolve one Labor Condition Application by its DOL case number: every determination of it (a certification later withdrawn is decided again in a later fiscal year), newest first, with every worksite of the newest. `found: false` when DOL has published no determination under that number since fiscal year 2008. Served by Croma (`as_of` says how current the data is), brought up to date as DOL publishes each quarter.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","DOL H-1B and PERM"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/dol-oflc"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["case_number"],"properties":{"case_number":{"type":"string","pattern":"^I-(?:\\d{3}-)?\\d{5}-\\d{6,7}$","description":"Número de caso LCA de DOL, p. ej. `I-200-25267-332158`."}},"additionalProperties":false},"example":{"case_number":"I-200-25267-332158"}}}},"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/DolOflcLcaCaseResponse"}}}},"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/dol-oflc/lca-worksites-search/v1":{"post":{"operationId":"dol_oflc_lca_worksites_search","summary":"DOL H-1B LCA Worksites Search","description":"Search every worksite of every Labor Condition Application since fiscal year 2008 by city, state, ZIP code, employer FEIN, case number and fiscal year: where H-1B workers are placed, by whom, and at what wage. Newest fiscal year first, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date as DOL publishes each quarter.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","DOL H-1B and PERM"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/dol-oflc"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"employer_fein":{"type":"string","pattern":"^(?:\\d{2}-?\\d{7})?$","default":"","description":"FEI/EIN de nueve dígitos de la entidad (opcional)."},"case_number":{"type":"string","pattern":"^(?:[A-Z]-(?:\\d{3}-)?\\d{5}-\\d{6,7})?$","default":"","description":"Número de caso de DOL (opcional)."},"fiscal_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Año fiscal federal (octubre a septiembre), p. ej. `2026` (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Z]{2})?$","default":"","description":"Código de estado de dos letras, p. ej. `FL` (opcional)."},"city":{"type":"string","maxLength":80,"default":"","description":"Ciudad del lugar de trabajo, p. ej. `Austin` (opcional)."},"postal_code":{"type":"string","pattern":"^(?:\\d{5})?$","default":"","description":"Código postal de cinco dígitos del lugar de trabajo (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":{"city":"Austin","state":"TX"}}}},"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/DolOflcLcaWorksitesSearchResponse"}}}},"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/dol-oflc/perm-search/v1":{"post":{"operationId":"dol_oflc_perm_search","summary":"DOL PERM Search","description":"Search every PERM labor certification DOL decided since fiscal year 2008 (the filing an employer makes to sponsor a foreign worker for a green card), on both the form used until 2023 and the revised one, by employer, trade name, job title or law firm, employer FEIN, case number, fiscal year, case status, SOC code, worksite state, the worker's country of citizenship, minimum offered wage and decision dates. Each determination carries the employer, the job, the offered and prevailing wage, the worksite, the attorney, the worker (on the form used until 2023) and every other answer on the form. Newest decision first, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date as DOL publishes each quarter.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","DOL H-1B and PERM"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/dol-oflc"},"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 empleador, su nombre comercial, el cargo y el bufete (opcional)."},"employer_fein":{"type":"string","pattern":"^(?:\\d{2}-?\\d{7})?$","default":"","description":"FEI/EIN de nueve dígitos de la entidad (opcional)."},"case_number":{"type":"string","pattern":"^(?:[A-Z]-(?:\\d{3}-)?\\d{5}-\\d{5,6})?$","default":"","description":"Número de caso PERM de DOL (opcional)."},"fiscal_year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Año fiscal federal (octubre a septiembre), p. ej. `2026` (opcional)."},"case_status":{"type":"string","enum":["","Certified","Certified - Expired","Withdrawn","Denied"],"default":"","description":"Estado del caso: `Certified`, `Certified - Expired`, `Withdrawn` o `Denied` (opcional)."},"soc_code":{"type":"string","pattern":"^(?:\\d{2}-\\d{4}(?:\\.\\d{2})?)?$","default":"","description":"Código SOC de la ocupación, p. ej. `15-1252.00` (opcional)."},"worksite_state":{"type":"string","pattern":"^(?:[A-Z]{2})?$","default":"","description":"Código de estado de dos letras, p. ej. `FL` (opcional)."},"country_of_citizenship":{"type":"string","pattern":"^[A-Za-z .,'()-]{0,60}$","default":"","description":"País de ciudadanía del trabajador, en inglés, p. ej. `INDIA` (opcional)."},"min_wage":{"type":"number","minimum":0,"default":0,"description":"Monto mínimo, en dólares (opcional)."},"decided_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"decided_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":{"query":"software engineer","worksite_state":"WA","case_status":"Certified"}}}},"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/DolOflcPermSearchResponse"}}}},"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/dol-oflc/perm-case/v1":{"post":{"operationId":"dol_oflc_perm_case","summary":"DOL PERM Case","description":"Resolve one PERM labor certification by its DOL case number, on either form: every determination of it, newest fiscal year first. `found: false` when DOL has published no determination under that number since fiscal year 2008. Served by Croma (`as_of` says how current the data is), brought up to date as DOL publishes each quarter.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","DOL H-1B and PERM"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/dol-oflc"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["case_number"],"properties":{"case_number":{"type":"string","pattern":"^[A-Z]-(?:\\d{3}-)?\\d{5}-\\d{5,6}$","description":"Número de caso PERM de DOL, p. ej. `G-100-25273-349207` o `A-23043-00641`."}},"additionalProperties":false},"example":{"case_number":"G-100-25273-349207"}}}},"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/DolOflcPermCaseResponse"}}}},"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-offerings/crowdfunding-search/v1":{"post":{"operationId":"sec_offerings_crowdfunding_search","summary":"SEC Crowdfunding Search","description":"Search every Regulation Crowdfunding filing since 2016 (Form C offerings, amendments, progress updates, annual reports, terminations and withdrawals) by free text over the issuer, its co-issuers, its funding portal and its signers, by issuer CIK, offering file number, form type, state, funding portal, most recent revenue, target amount and filing dates. Each filing carries the offering's terms and two years of the issuer's financials. Newest first, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date as the SEC publishes each quarter.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Crowdfunding and Reg A"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sec-offerings"},"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 actual y en los nombres anteriores del filer (opcional)."},"issuer_cik":{"type":"string","pattern":"^\\d{0,10}$","default":"","description":"CIK del emisor en EDGAR, con o sin ceros a la izquierda (opcional)."},"file_number":{"type":"string","pattern":"^(?:[0-9A-Za-z]{2,3}-\\d{3,6})?$","default":"","description":"Número de expediente en la SEC, p. ej. `020-25453` o `024-12642` (opcional)."},"form_type":{"type":"string","maxLength":12,"default":"","description":"Tipo de formulario como lo escribe EDGAR, p. ej. `C`, `C/A`, `C-U`, `C-AR`, `1-A`, `1-A POS`, `1-K` (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Za-z][A-Za-z0-9])?$","default":"","description":"Código de estado o país de EDGAR, p. ej. `DE` o `E9` (opcional)."},"intermediary_cik":{"type":"string","pattern":"^\\d{0,10}$","default":"","description":"CIK del emisor en EDGAR, con o sin ceros a la izquierda (opcional)."},"min_revenue":{"type":"number","minimum":0,"default":0,"description":"Monto mínimo, en dólares (opcional)."},"min_target_amount":{"type":"number","minimum":0,"default":0,"description":"Monto mínimo, en dólares (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."},"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":"coffee","form_type":"C"}}}},"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/SecCrowdfundingSearchResponse"}}}},"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-offerings/crowdfunding-filing/v1":{"post":{"operationId":"sec_offerings_crowdfunding_filing","summary":"SEC Crowdfunding Filing","description":"Resolve one Regulation Crowdfunding filing by its EDGAR accession number and return it in full: issuer, co-issuers, funding portal, offering terms, two years of financials, jurisdictions and signers. `found: false` when there is none under that number. Served by Croma (`as_of` says how current the data is), brought up to date as the SEC publishes each quarter.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Crowdfunding and Reg A"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sec-offerings"},"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":"0001779469-26-000002"}}}},"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/SecCrowdfundingFilingResponse"}}}},"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-offerings/crowdfunding-offering/v1":{"post":{"operationId":"sec_offerings_crowdfunding_offering","summary":"SEC Crowdfunding Offering","description":"Every filing of one Regulation Crowdfunding offering, by its SEC file number (`020-`), oldest first: the Form C, its amendments and progress updates, the issuer's annual reports and its termination. Follow one raise from launch to close. `found: false` when no filing carries the number. Served by Croma (`as_of` says how current the data is), brought up to date as the SEC publishes each quarter.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Crowdfunding and Reg A"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sec-offerings"},"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":"^020-\\d{5,6}$","description":"Número de expediente de la oferta de crowdfunding en la SEC, p. ej. `020-25453`."}},"additionalProperties":false},"example":{"file_number":"020-25453"}}}},"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/SecCrowdfundingOfferingResponse"}}}},"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-offerings/reg-a-search/v1":{"post":{"operationId":"sec_offerings_reg_a_search","summary":"SEC Regulation A Search","description":"Search every structured Regulation A filing since 2015 (offering statements 1-A, 1-A/A and 1-A POS, annual reports 1-K and exit reports 1-Z) by issuer name, issuer CIK, file number, form type, state, tier, minimum offering size and filing dates. Each offering statement carries the issuer's balance sheet and income statement and the offering's size, price and fees; each report, what its offerings sold and raised. Newest first, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date as the SEC publishes each quarter.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Crowdfunding and Reg A"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sec-offerings"},"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 actual y en los nombres anteriores del filer (opcional)."},"issuer_cik":{"type":"string","pattern":"^\\d{0,10}$","default":"","description":"CIK del emisor en EDGAR, con o sin ceros a la izquierda (opcional)."},"file_number":{"type":"string","pattern":"^(?:[0-9A-Za-z]{2,3}-\\d{3,6})?$","default":"","description":"Número de expediente en la SEC, p. ej. `020-25453` o `024-12642` (opcional)."},"form_type":{"type":"string","maxLength":12,"default":"","description":"Tipo de formulario como lo escribe EDGAR, p. ej. `C`, `C/A`, `C-U`, `C-AR`, `1-A`, `1-A POS`, `1-K` (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Za-z][A-Za-z0-9])?$","default":"","description":"Código de estado o país de EDGAR, p. ej. `DE` o `E9` (opcional)."},"tier":{"type":"string","enum":["","Tier1","Tier2"],"default":"","description":"Nivel de la oferta de Regulation A: `Tier1` o `Tier2` (opcional)."},"min_total_offering":{"type":"number","minimum":0,"default":0,"description":"Monto mínimo, en dólares (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."},"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":{"tier":"Tier2","form_type":"1-A"}}}},"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/SecRegASearchResponse"}}}},"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-offerings/reg-a-filing/v1":{"post":{"operationId":"sec_offerings_reg_a_filing","summary":"SEC Regulation A Filing","description":"Resolve one Regulation A filing by its EDGAR accession number and return it in full: issuers, balance sheet and income statement, offering terms and fees, securities, jurisdictions, and for a report what each offering sold. `found: false` when there is none under that number. Served by Croma (`as_of` says how current the data is), brought up to date as the SEC publishes each quarter.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Crowdfunding and Reg A"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sec-offerings"},"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":"0001477932-26-004123"}}}},"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/SecRegAFilingResponse"}}}},"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-offerings/reg-a-offering/v1":{"post":{"operationId":"sec_offerings_reg_a_offering","summary":"SEC Regulation A Offering","description":"Every filing of one Regulation A offering, by its SEC file number (`024-`), oldest first: the offering statement, its amendments and post-qualification amendments, and every annual (1-K) or exit (1-Z) report that names it and says what it sold (every exit report names its offerings; about one annual report in five does). `found: false` when no filing carries the number. Served by Croma (`as_of` says how current the data is), brought up to date as the SEC publishes each quarter.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","SEC Crowdfunding and Reg A"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sec-offerings"},"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":"^024-\\d{5,6}$","description":"Número de expediente de la oferta de Regulation A en la SEC, p. ej. `024-12642`."}},"additionalProperties":false},"example":{"file_number":"024-12642"}}}},"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/SecRegAOfferingResponse"}}}},"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/sanctions-screen/v1":{"post":{"operationId":"ofac_sanctions_screen","summary":"OFAC Sanctions Screening","description":"Screen one person or company against the US Treasury's OFAC sanctions lists. Send a name, and optionally a date of birth, a country and an identity number; get back the parties that may be the same one, each with a 0 to 100 score and what decided it. Names match through typos, reordering, accents and transliterations, across primary names and aliases. 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":["name"],"properties":{"name":{"type":"string","minLength":2,"maxLength":200,"description":"Nombre de la persona o empresa a verificar, en cualquier orden y con o sin tildes, p. ej. `Aero Caribbean Airlines`."},"birth_date":{"type":"string","pattern":"^(?:\\d{4}(?:-\\d{2}(?:-\\d{2})?)?)?$","default":"","description":"Fecha de nacimiento, `yyyy-mm-dd`, `yyyy-mm` o solo el año `yyyy` (opcional)."},"country":{"type":"string","maxLength":60,"default":"","description":"País de la persona o empresa: nombre en inglés o código ISO de dos letras, p. ej. `Cuba` o `CU` (opcional)."},"id_number":{"type":"string","maxLength":60,"default":"","description":"Número de pasaporte, documento de identidad, identificación tributaria o registro (opcional). Se compara sin espacios ni signos."},"party_type":{"type":"string","enum":["","individual","entity","vessel","aircraft"],"default":"","description":"Tipo de parte: `individual`, `entity` (empresa u organización), `vessel` o `aircraft` (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)."},"threshold":{"type":"integer","minimum":50,"maximum":100,"default":85,"description":"Puntaje mínimo, de 50 a 100, para que un candidato cuente como posible coincidencia. Por defecto `85`."},"limit":{"type":"integer","minimum":1,"maximum":50,"default":10,"description":"Máximo de coincidencias a devolver (1-50). Por defecto `10`."}},"additionalProperties":false},"example":{"name":"Aero Carribean Airlines","party_type":"entity","country":"Cuba"}}}},"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/OfacSanctionsScreenResponse"}}}},"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"}}}}}}},"/us/csl/parties-search/v1":{"post":{"operationId":"csl_parties_search","summary":"Consolidated Screening List Search","description":"Screen a name against every US export and sanctions screening list at once: OFAC's, the Entity List, the Denied Persons List and the other Commerce and State Department lists. Filter by name or alias, list, agency, program, country, identifying number or listing date. An identifying number (tax, registration, passport, SWIFT, digital currency address) matches ignoring spaces and punctuation. 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","Consolidated Screening List"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/csl"},"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","ssi","plc","ns_mbs","cmic","cap","fse","el","dpl","uvl","meu","isn","dtc"],"default":"","description":"Lista: `sdn`, `ssi`, `plc`, `ns_mbs`, `cmic`, `cap`, `fse` (Tesoro, OFAC), `el`, `dpl`, `uvl`, `meu` (Comercio, BIS), `isn`, `dtc` (Departamento de Estado) (opcional)."},"agency":{"type":"string","enum":["","treasury","commerce","state"],"default":"","description":"Agencia que publica la lista: `treasury` (OFAC), `commerce` (Bureau of Industry and Security) o `state` (Departamento de Estado) (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-zÀ-ÿ0-9 ._/()'’&,-]{0,120}$","default":"","description":"Programa de sanciones o ley tal como lo escribe la lista, p. ej. `SDGT`, `CMIC-EO13959` (opcional)."},"country":{"type":"string","pattern":"^(?:[A-Za-z]{2})?$","default":"","description":"Código de país de dos letras de alguna dirección de la parte, p. ej. `CN`, `VE` (opcional)."},"identifier":{"type":"string","maxLength":100,"default":"","description":"Número de identificación (tributario, de registro, pasaporte, SWIFT, dirección de criptomoneda…); se compara sin espacios ni signos (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."},"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":"huawei"}}}},"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/CslPartiesSearchResponse"}}}},"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/csl/party/v1":{"post":{"operationId":"csl_party","summary":"Consolidated Screening List Party","description":"Resolve one party on the US export and sanctions screening lists by its id and return the full record: names and aliases, addresses, programs, identifying numbers, the Federal Register notice, the dates and license terms of the listing. `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","Consolidated Screening List"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/csl"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^(?:(?:sdn|ssi|plc|ns_mbs|cmic|cap|fse)-\\d{1,9}|(?:el|dpl|uvl|meu|isn|dtc)-[0-9a-f]{32,64})$","description":"Id de la parte en la Consolidated Screening List, p. ej. `sdn-36`, como lo devuelve la búsqueda."}},"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/CslPartyResponse"}}}},"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/sam/exclusions-search/v1":{"post":{"operationId":"sam_exclusions_search","summary":"SAM.gov Exclusions Search","description":"Search every party excluded from US federal contracts, grants and programs: people, firms, clinics, pharmacies and vessels excluded by HHS, OPM, DOJ, EPA and some fifty other agencies. Filter by name, classification, excluding agency, kind of exclusion, state, Unique Entity ID, CAGE code, NPI and the date the exclusion took effect. 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","SAM.gov"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sam"},"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)."},"classification":{"type":"string","enum":["","individual","firm","special_entity_designation","vessel"],"default":"","description":"Tipo de parte excluida: `individual`, `firm`, `special_entity_designation` o `vessel` (opcional)."},"agency":{"type":"string","pattern":"^[A-Za-z]{0,8}$","default":"","description":"Sigla de la agencia que excluyó, p. ej. `HHS`, `OPM`, `DOJ`, `EPA` (opcional)."},"exclusion_type":{"type":"string","enum":["","prohibition_restriction","ineligible_proceedings_completed","ineligible_proceedings_pending","voluntary_exclusion"],"default":"","description":"Tipo de exclusión: `prohibition_restriction`, `ineligible_proceedings_completed`, `ineligible_proceedings_pending` o `voluntary_exclusion` (opcional)."},"state":{"type":"string","maxLength":80,"default":"","description":"Estado o provincia de la dirección: el código de dos letras para un estado de EE. UU., p. ej. `FL` (opcional)."},"uei":{"type":"string","pattern":"^[A-Za-z0-9]{0,12}$","default":"","description":"Unique Entity ID de SAM.gov, p. ej. `HHB9E7U2YFM4` (opcional)."},"cage":{"type":"string","pattern":"^[A-Za-z0-9]{0,5}$","default":"","description":"Código CAGE, p. ej. `L0KT7` (opcional)."},"npi":{"type":"string","pattern":"^(?:\\d{10})?$","default":"","description":"National Provider Identifier de diez dígitos de un proveedor de salud (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."},"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":"pharmacy","agency":"HHS"}}}},"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/SamExclusionsSearchResponse"}}}},"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/sam/exclusion/v1":{"post":{"operationId":"sam_exclusion","summary":"SAM.gov Exclusion","description":"Resolve one exclusion from US federal awards and programs by its SAM number and return the full record: the party, its identifiers, the excluding agency, the kind of exclusion, its dates and the agency's note. `found: false` when the list does not carry 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","SAM.gov"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sam"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Número SAM de la exclusión, como lo devuelve la búsqueda."}},"additionalProperties":false},"example":{"id":"c11dcac9-e974-4e97-9350-077d697b8909"}}}},"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/SamExclusionResponse"}}}},"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/sam/opportunities-search/v1":{"post":{"operationId":"sam_opportunities_search","summary":"SAM.gov Contract Opportunities Search","description":"Search every contract opportunity US federal agencies list as active on SAM.gov: solicitations, combined synopsis/solicitations, presolicitations, sources sought, special notices, justifications and award notices, about 75,000. Filter by words in the title, text, awardee or solicitation number, kind of notice, solicitation number, department, agency, NAICS code, product service code, set-aside, state of the place of performance or of the contracting office, posting date and response deadline; order by posting date, deadline or award amount. 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","SAM.gov"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sam-opportunities"},"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 words to find in the notice's title, description, awardee or solicitation number, e.g. `cybersecurity`, `janitorial services`. Every word must appear."},"type":{"type":"string","enum":["","solicitation","combined_synopsis_solicitation","presolicitation","sources_sought","special_notice","award_notice","justification","justification_and_approval","modification","sale_of_surplus_property","consolidate_bundle"],"default":"","description":"Optional kind of notice: `solicitation`, `combined_synopsis_solicitation`, `presolicitation`, `sources_sought`, `special_notice`, `award_notice`, `justification`, `justification_and_approval`, `modification`, `sale_of_surplus_property` or `consolidate_bundle`."},"solicitation_number":{"type":"string","pattern":"^[A-Za-z0-9._/ -]{0,80}$","default":"","description":"Optional solicitation number, exactly as the agency wrote it, e.g. `W912HN25B0012`. Case does not matter."},"department":{"type":"string","maxLength":120,"default":"","description":"Optional department or independent agency, exactly as SAM.gov writes it, e.g. `DEPT OF DEFENSE`, `VETERANS AFFAIRS, DEPARTMENT OF`, `GENERAL SERVICES ADMINISTRATION`. Case does not matter."},"sub_tier":{"type":"string","maxLength":120,"default":"","description":"Optional agency within the department, exactly as SAM.gov writes it, e.g. `DEPT OF THE ARMY`, `DEFENSE LOGISTICS AGENCY`, `FOREST SERVICE`. Case does not matter."},"naics_code":{"type":"string","pattern":"^(?:\\d{2,6})?$","default":"","description":"Optional NAICS code, two to six digits; a shorter code matches every code that starts with it, e.g. `23` for all of construction, `541512` for computer systems design."},"classification_code":{"type":"string","pattern":"^(?:[A-Za-z0-9]{1,4})?$","default":"","description":"Optional product service code (PSC), one to four characters; a shorter code matches every code that starts with it, e.g. `D` for IT services, `D302`, `7030`."},"set_aside":{"type":"string","pattern":"^[A-Za-z0-9]{0,12}$","default":"","description":"Optional set-aside code as SAM.gov writes it, e.g. `SBA` (total small business), `SBP` (partial), `SDVOSBC`, `WOSB`, `8A`, `HZC`, or `NONE` for notices that state no set-aside."},"performance_state":{"type":"string","pattern":"^(?:[A-Za-z]{2})?$","default":"","description":"Optional two-letter state of the place of performance, e.g. `VA`, `TX`."},"office_state":{"type":"string","pattern":"^(?:[A-Za-z]{2})?$","default":"","description":"Optional two-letter state of the contracting office, e.g. `PA`, `OH`."},"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."},"deadline_from":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"deadline_to":{"type":"string","format":"date","default":"","description":"Optional date filter in yyyy-mm-dd format."},"sort":{"type":"string","enum":["recent","deadline","amount_desc"],"default":"recent","description":"Order of the results: `recent` (newest posting first, the default), `deadline` (soonest response deadline first, notices with no deadline last) or `amount_desc` (largest award first)."},"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":"cybersecurity","type":"sources_sought"}}}},"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/SamOpportunitiesSearchResponse"}}}},"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/sam/opportunity/v1":{"post":{"operationId":"sam_opportunity","summary":"SAM.gov Contract Opportunity","description":"Resolve one contract opportunity on SAM.gov by its notice id and return the full record: the notice's text, the solicitation number, the department, agency and office that posted it, the NAICS and product service codes, the set-aside, the response deadline, the place of performance, the contacts and, for an award, the contractor, the amount and the date. `found: false` when the active list does not carry 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","SAM.gov"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/sam-opportunities"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$","description":"The notice's id in SAM.gov, 32 hex characters, as the search returns it."}},"additionalProperties":false},"example":{"id":"c3ade85bb7aa4603aee667173d4eb588"}}}},"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/SamOpportunityResponse"}}}},"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/fincen/msb-registrations-search/v1":{"post":{"operationId":"fincen_msb_registrations_search","summary":"FinCEN MSB Registrations Search","description":"Search every money services business registered with FinCEN (money transmitters, check cashers, currency exchangers, prepaid access providers, in the US and abroad) by legal name or DBA, registered service, state, the states where it operates, country, whether it operates abroad and the date the filing was received, or its 14-digit MSB registration number; follow one business's filings by `registrant_key`. By legal name, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date weekly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","FinCEN MSB Registrations"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/fincen"},"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)."},"activity":{"type":"string","enum":["","issuer_of_travelers_checks","seller_of_travelers_checks","redeemer_of_travelers_checks","issuer_of_money_orders","seller_of_money_orders","redeemer_of_money_orders","currency_dealer_or_exchanger","check_casher","money_transmitter","travelers_checks_sales_or_redemption","money_orders_sales_or_redemption","us_postal_service","seller_of_prepaid_access","provider_of_prepaid_access","dealer_in_foreign_exchange","other"],"default":"","description":"Actividad MSB declarada, p. ej. `money_transmitter`, `check_casher`, `dealer_in_foreign_exchange`, `seller_of_prepaid_access` (opcional)."},"state":{"type":"string","pattern":"^(?:[A-Za-z]{2})?$","default":"","description":"Código de dos letras de un estado o territorio de EE. UU., p. ej. `TX` (opcional)."},"operates_in":{"type":"string","pattern":"^(?:[A-Za-z]{2})?$","default":"","description":"Código de dos letras de un estado o territorio de EE. UU., p. ej. `TX` (opcional)."},"country":{"type":"string","maxLength":60,"default":"","description":"País de un registrante ubicado fuera de EE. UU., como lo escribe FinCEN, p. ej. `COLOMBIA`, `MEXICO`, `HONG KONG` (opcional)."},"operates_abroad":{"type":"boolean","default":false,"description":"`true` para ver solo los registros que declaran actividad fuera de EE. UU. (opcional)."},"registrant_key":{"type":"string","pattern":"^(?:[0-9a-f]{16})?$","default":"","description":"registrant_key de un registro, para ver todas las presentaciones del mismo negocio (opcional)."},"registration_number":{"type":"string","pattern":"^(?:\\d{14})?$","default":"","description":"Número de registro MSB de FinCEN, catorce dígitos (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."},"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":"remesas","activity":"money_transmitter"}}}},"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/FincenMsbRegistrationsSearchResponse"}}}},"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/fincen/msb-registration/v1":{"post":{"operationId":"fincen_msb_registration","summary":"FinCEN MSB Registration","description":"Resolve one money services business registration by its id and return the full record: names, address, registered services, the states where it operates, whether it operates abroad, branches and filing dates. `found: false` when the list does not carry that id. Served by Croma (`as_of` says how current the data is), brought up to date weekly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","FinCEN MSB Registrations"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/fincen"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{16}(?:-\\d{1,2})?$","description":"Id del registro MSB, como lo devuelve la búsqueda."}},"additionalProperties":false},"example":{"id":"550f01d4ab63c95f"}}}},"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/FincenMsbRegistrationResponse"}}}},"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/uspto/trademarks-search/v1":{"post":{"operationId":"uspto_trademarks_search","summary":"USPTO Trademarks Search","description":"Search US federal trademark applications and registrations at the USPTO (every live mark and every mark filed since 2016) by any words of the mark, the owner's name or the goods and services, narrowed by `owner` (the full name), `status` (`live`, `dead`, `registered`, `pending`), `international_class` (Nice class 1-45), `owner_country`, `registration_number` and the filing date (`from_date`/`to_date`). Each result carries the mark, its status and dates, classes, goods and services, filing basis, owners, attorney and whether an assignment was recorded. Served by Croma from its copy of the register (`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","United States Patent and Trademark Office"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/uspto"},"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 words to find in the mark, the owner's name or the goods and services, e.g. `coffee`, `nintendo`. Every word must appear."},"owner":{"type":"string","maxLength":200,"default":"","description":"Optional owner's full name as the register records it, e.g. `Nintendo of America Inc.`. Case and punctuation do not matter, but the whole name must match; use `query` for part of a name."},"status":{"type":"string","enum":["","live","dead","registered","pending"],"default":"","description":"Optional status: `live` (a pending application or an active registration), `dead` (abandoned, cancelled or expired), `registered` (live and registered) or `pending` (live and not yet registered)."},"international_class":{"type":"string","pattern":"^(?:\\d{1,3}|[ABab])?$","default":"","description":"Optional international (Nice) class of the goods or services, 1 to 45, e.g. `9` (software, electronics), `25` (clothing), `35` (business services). `A`, `B` and `200` are the USPTO's classes for certification and collective membership marks."},"owner_country":{"type":"string","maxLength":60,"default":"","description":"Optional country of the owner's address as the register writes it, e.g. `UNITED STATES`, `COLOMBIA`, `JAPAN`, `REPUBLIC OF KOREA`."},"registration_number":{"type":"string","pattern":"^(?:\\d{1,8})?$","default":"","description":"Optional registration number the USPTO issued when the mark registered, e.g. `7726306`."},"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":"nintendo","status":"registered","international_class":"9"}}}},"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/UsptoTrademarksSearchResponse"}}}},"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/uspto/trademark/v1":{"post":{"operationId":"uspto_trademark","summary":"USPTO Trademark","description":"Retrieve one US federal trademark application or registration by its eight-digit serial number, e.g. `79392077`: the mark, its status and dates, classes, goods and services, filing basis, owners, attorney and whether an assignment was recorded. Served by Croma from its copy of the register (`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","United States Patent and Trademark Office"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/uspto"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["serial_number"],"properties":{"serial_number":{"type":"string","pattern":"^\\d{8}$","description":"The mark's eight-digit serial number, assigned when the application was filed, e.g. `79392077`."}},"additionalProperties":false},"example":{"serial_number":"79392077"}}}},"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/UsptoTrademarkResponse"}}}},"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/gleif/entities-search/v1":{"post":{"operationId":"gleif_entities_search","summary":"GLEIF Entities Search","description":"Search every Legal Entity Identifier record in the world, about 3.4 million, by name (legal, trading, previous and transliterated names). Filter by legal-address country, legal jurisdiction (e.g. `US-DE`), business register and the number the entity is registered under there (a Delaware file number, a Sunbiz document number, a NIT), category and entity or registration status. By legal name, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date three times a day.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Global","GLEIF (LEI)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/global/gleif"},"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)."},"country":{"type":"string","pattern":"^(?:[A-Za-z]{2})?$","default":"","description":"País de dos letras de la dirección legal, p. ej. `US`, `CO`, `KY` (opcional)."},"jurisdiction":{"type":"string","pattern":"^(?:[A-Za-z]{2}(?:-[A-Za-z0-9]{1,3})?)?$","default":"","description":"Jurisdicción legal: un país (`GB`) o una subdivisión (`US-DE`) (opcional)."},"registration_authority":{"type":"string","pattern":"^(?:RA\\d{6})?$","default":"","description":"Registro mercantil por su código GLEIF, p. ej. `RA000602` (Delaware) o `RA000603` (Florida) (opcional)."},"registered_as":{"type":"string","maxLength":100,"default":"","description":"Número de la entidad en su registro: un file number de Delaware, un document number de Sunbiz, un NIT (opcional)."},"category":{"type":"string","enum":["","GENERAL","FUND","BRANCH","SOLE_PROPRIETOR","RESIDENT_GOVERNMENT_ENTITY","INTERNATIONAL_ORGANIZATION"],"default":"","description":"Categoría de la entidad (opcional)."},"entity_status":{"type":"string","enum":["","ACTIVE","INACTIVE"],"default":"","description":"Estado de la entidad: `ACTIVE` o `INACTIVE` (opcional)."},"registration_status":{"type":"string","enum":["","ISSUED","LAPSED","RETIRED","DUPLICATE","ANNULLED","MERGED","PENDING_TRANSFER","PENDING_ARCHIVAL"],"default":"","description":"Estado del registro LEI, p. ej. `ISSUED` o `LAPSED` (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":"bancolombia"}}}},"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/GleifEntitiesSearchResponse"}}}},"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/gleif/entity/v1":{"post":{"operationId":"gleif_entity","summary":"GLEIF Entity","description":"Resolve one Legal Entity Identifier and return the whole record with its ownership: the direct and ultimate parents that consolidate it, its fund manager, umbrella fund or head office, why it reports no parent when it does not, and up to 100 entities that report it as their parent. `found: false` when no record carries that LEI. Served by Croma (`as_of` says how current the data is), brought up to date three times a day.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Global","GLEIF (LEI)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/global/gleif"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lei"],"properties":{"lei":{"type":"string","pattern":"^[A-Za-z0-9]{18}[0-9]{2}$","description":"LEI de 20 caracteres, p. ej. `5493001KJTIIGC8Y1R12`."}},"additionalProperties":false},"example":{"lei":"HWUPKR0MPOU8FGXBT394"}}}},"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/GleifEntityResponse"}}}},"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/gleif/relationships-search/v1":{"post":{"operationId":"gleif_relationships_search","summary":"GLEIF Relationships Search","description":"Page through the parent relationships reported to GLEIF by child, by parent or by type: every subsidiary, fund or branch that reports an entity as its parent, or every parent an entity reports. Current relationships only unless asked. By child LEI, pages of up to 50. Served by Croma, brought up to date three times a day.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Global","GLEIF (LEI)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/global/gleif"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"child_lei":{"type":"string","pattern":"^(?:[A-Za-z0-9]{18}[0-9]{2})?$","default":"","description":"LEI de 20 caracteres (opcional)."},"parent_lei":{"type":"string","pattern":"^(?:[A-Za-z0-9]{18}[0-9]{2})?$","default":"","description":"LEI de 20 caracteres (opcional)."},"relationship_type":{"type":"string","enum":["","IS_DIRECTLY_CONSOLIDATED_BY","IS_ULTIMATELY_CONSOLIDATED_BY","IS_INTERNATIONAL_BRANCH_OF","IS_FUND-MANAGED_BY","IS_SUBFUND_OF","IS_FEEDER_TO"],"default":"","description":"Tipo de relación, p. ej. `IS_DIRECTLY_CONSOLIDATED_BY` (opcional)."},"include_inactive":{"type":"boolean","default":false,"description":"`true` para incluir también las relaciones que GLEIF retiró (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":{"parent_lei":"HWUPKR0MPOU8FGXBT394"}}}},"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/GleifRelationshipsSearchResponse"}}}},"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/world-bank/indicators-search/v1":{"post":{"operationId":"world_bank_indicators_search","summary":"World Bank Indicators Search","description":"Search the World Bank's World Development Indicators catalog, about 1,500 indicators, by words in the name or definition and by `topic` (`poverty`, `education`, `health`, `social_protection_labor`, `financial_sector`, `economy`...). Each result carries the indicator code to pass to `world-bank-indicator-values`, its name, unit, topics, definition and the organization that produces the data. Served by Croma from its copy (`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":["Global","World Bank"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/global/world-bank"},"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 words to find in the indicator's name or definition, e.g. `gini`, `unemployment youth`. Every word must appear."},"topic":{"type":"string","enum":["","agriculture","aid_effectiveness","climate_change","economy","education","energy_mining","environment","external_debt","financial_sector","gender","health","infrastructure","millennium_development_goals","poverty","private_sector","public_sector","science_technology","social_development","social_protection_labor","trade","urban_development"],"default":"","description":"Optional topic the World Bank files the indicator under, e.g. `poverty`, `education`, `social_protection_labor`."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Results per page (1-200)."}},"additionalProperties":false},"example":{"query":"gini","topic":"poverty"}}}},"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/WorldBankIndicatorsSearchResponse"}}}},"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/world-bank/indicator-values/v1":{"post":{"operationId":"world_bank_indicator_values","summary":"World Bank Indicator Values","description":"Read World Development Indicators values for the 42 economies of Latin America and the Caribbean, 1960 to the latest year, by `indicator_code` (e.g. `SI.POV.GINI`, `SL.UEM.TOTL.ZS`, `NY.GDP.PCAP.CD`; find codes with `world-bank-indicators-search`), `country_code` (ISO3, e.g. `COL`) and `year` or `year_from`/`year_to`. One row per country, indicator and year with a value, with its unit. Served by Croma from its copy (`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":["Global","World Bank"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/global/world-bank"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"indicator_code":{"type":"string","pattern":"^(?:[A-Za-z0-9][A-Za-z0-9_.]{1,59})?$","default":"","description":"Optional indicator code, as the indicators search returns it, e.g. `SI.POV.GINI` (Gini index), `SL.UEM.TOTL.ZS` (unemployment)."},"country_code":{"type":"string","pattern":"^(?:[A-Za-z]{3})?$","default":"","description":"Optional three-letter ISO 3166-1 country code, e.g. `COL`, `BRA`, `MEX`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional single year, e.g. `2024`. 0 means every year."},"year_from":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional first year of a range, e.g. `2015`. 0 means no lower bound."},"year_to":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional last year of a range, e.g. `2024`. 0 means no upper bound."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Results per page (1-200)."}},"additionalProperties":false},"example":{"indicator_code":"SI.POV.GINI","country_code":"COL","year_from":2015}}}},"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/WorldBankIndicatorValuesResponse"}}}},"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/world-bank/poverty/v1":{"post":{"operationId":"world_bank_poverty","summary":"World Bank Poverty and Inequality","description":"Poverty and inequality estimates from the World Bank's Poverty and Inequality Platform, country by year: the share of people below $3.00, $4.20 and $8.30 a day (2021 PPP), the poverty gap at each line, the Gini index, mean and median welfare, deciles, and the household survey behind each estimate. Filter by `country_code` (ISO3), `year` or `year_from`/`year_to`, `reporting_level` (`national`, `urban`, `rural`) and `welfare_type` (`income`, `consumption`). Served by Croma from its copy (`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":["Global","World Bank"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/global/world-bank"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"country_code":{"type":"string","pattern":"^(?:[A-Za-z]{3})?$","default":"","description":"Optional three-letter ISO 3166-1 country code, e.g. `COL`, `BRA`, `MEX`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional single year, e.g. `2024`. 0 means every year."},"year_from":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional first year of a range, e.g. `2015`. 0 means no lower bound."},"year_to":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional last year of a range, e.g. `2024`. 0 means no upper bound."},"reporting_level":{"type":"string","enum":["","national","urban","rural"],"default":"","description":"Optional coverage of the estimate: `national`, `urban` or `rural`. Some countries are covered by urban surveys only (Argentina), so leaving it empty returns every level."},"welfare_type":{"type":"string","enum":["","income","consumption"],"default":"","description":"Optional welfare measure the survey records: `income` (most of Latin America) or `consumption`."},"page":{"type":"integer","minimum":1,"maximum":1000,"default":1,"description":"1-based page number for paginated results."},"per_page":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Results per page (1-200)."}},"additionalProperties":false},"example":{"country_code":"COL","year_from":2015}}}},"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/WorldBankPovertyResponse"}}}},"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/ny-dos/corporations-search/v1":{"post":{"operationId":"ny_dos_corporations_search","summary":"New York Corporations Search","description":"Search every active entity on file with the New York Department of State (corporations, LLCs, partnerships, domestic and foreign) by name. Filter by entity type, county, jurisdiction of formation and first filing date. By name, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date weekly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","New York Department of State"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/ny-dos"},"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)."},"entity_type":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (opcional)."},"county":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (opcional)."},"jurisdiction":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (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."},"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":"acme holdings"}}}},"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/NyCorporationsSearchResponse"}}}},"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/ny-dos/corporation/v1":{"post":{"operationId":"ny_dos_corporation","summary":"New York Corporation","description":"Resolve one active entity on file with the New York Department of State by its DOS ID and return the record with its parties: service of process, chief executive, registered agent and principal office. `found: false` when the list does not carry that DOS ID, which is also the answer for an entity that is no longer active. Served by Croma, brought up to date weekly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","New York Department of State"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/ny-dos"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dos_id"],"properties":{"dos_id":{"type":"string","pattern":"^\\d{1,10}$","description":"DOS ID de la entidad en el registro del Departamento de Estado de Nueva York."}},"additionalProperties":false},"example":{"dos_id":"1560743"}}}},"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/NyCorporationResponse"}}}},"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/colorado-sos/entities-search/v1":{"post":{"operationId":"colorado_sos_entities_search","summary":"Colorado Business Entities Search","description":"Search every business entity on file with the Colorado Secretary of State since 1864, in any status, by name. Filter by status, entity type, jurisdiction of formation and formation date. 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","Colorado Secretary of State"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/colorado-sos"},"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)."},"status":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (opcional)."},"entity_type":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (opcional)."},"jurisdiction":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (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."},"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":"acme"}}}},"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/ColoradoEntitiesSearchResponse"}}}},"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/colorado-sos/entity/v1":{"post":{"operationId":"colorado_sos_entity","summary":"Colorado Business Entity","description":"Resolve one business entity on file with the Colorado Secretary of State by its id and return the record: status, type, formation, addresses and registered agent. `found: false` when the register does not carry that id. Served by Croma, 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","Colorado Secretary of State"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/colorado-sos"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["entity_id"],"properties":{"entity_id":{"type":"string","pattern":"^\\d{1,12}$","description":"ID de la entidad en el registro de la Secretaría de Estado de Colorado."}},"additionalProperties":false},"example":{"entity_id":"19871071914"}}}},"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/ColoradoEntityResponse"}}}},"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/ct-sos/businesses-search/v1":{"post":{"operationId":"ct_sos_businesses_search","summary":"Connecticut Businesses Search","description":"Search every business on the Connecticut Secretary of the State's register, in any status, by name. Filter by status, business type, account number and registration date. By name, pages of up to 50. Served by Croma (`as_of` says how current the data is), brought up to date weekly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","Connecticut Secretary of the State"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/ct-sos"},"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)."},"status":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (opcional)."},"business_type":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (opcional)."},"account_number":{"type":"string","pattern":"^\\d{0,10}$","default":"","description":"Número de cuenta de la empresa en Connecticut (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."},"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":"insurance"}}}},"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/CtBusinessesSearchResponse"}}}},"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/ct-sos/business/v1":{"post":{"operationId":"ct_sos_business","summary":"Connecticut Business","description":"Resolve one business on the Connecticut register by its id and return the whole record with its principals (up to 200) and registered agents. `found: false` when the register does not carry that id. Served by Croma, brought up to date weekly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","Connecticut Secretary of the State"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/ct-sos"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9]{15}(?:[A-Za-z0-9]{3})?$","description":"Id del registro de la empresa en Connecticut, como lo devuelve la búsqueda."}},"additionalProperties":false},"example":{"id":"001t000000WmbJKAAZ"}}}},"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/CtBusinessResponse"}}}},"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/ct-sos/principals-search/v1":{"post":{"operationId":"ct_sos_principals_search","summary":"Connecticut Principals Search","description":"Search the principals (officers, directors, members, managers) every Connecticut business reports by the person's name, to find every business a person is part of, with each business's name and status. By name, pages of up to 50. Served by Croma, brought up to date weekly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["United States","Connecticut Secretary of the State"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/ct-sos"},"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)."},"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":"john smith"}}}},"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/CtPrincipalsSearchResponse"}}}},"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/colorado-ucc/debtors-search/v1":{"post":{"operationId":"colorado_ucc_debtors_search","summary":"Colorado UCC Debtors Search","description":"Search the debtors every UCC and lien filing with the Colorado Secretary of State lists since 1966, companies and people, by name or by the organization's Colorado entity id, each with the filing that lists it and its lien's lapse date and whether it is still in force. 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","Colorado Secretary of State (UCC)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/colorado-ucc"},"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)."},"organization_id":{"type":"string","pattern":"^\\d{0,12}$","default":"","description":"ID de la entidad en el registro de la Secretaría de Estado de Colorado (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":"parker bespoke furniture"}}}},"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/ColoradoUccDebtorsSearchResponse"}}}},"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/colorado-ucc/secured-parties-search/v1":{"post":{"operationId":"colorado_ucc_secured_parties_search","summary":"Colorado UCC Secured Parties Search","description":"Search the secured parties (lenders, lessors, lienholders) every UCC and lien filing with the Colorado Secretary of State lists since 1966 by name, each with the filing that lists it and its lien's lapse date and whether it is still in force. By name, pages of up to 50. Served by Croma, 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","Colorado Secretary of State (UCC)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/colorado-ucc"},"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)."},"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":"jpmorgan chase"}}}},"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/ColoradoUccSecuredPartiesSearchResponse"}}}},"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/colorado-ucc/lien/v1":{"post":{"operationId":"colorado_ucc_lien","summary":"Colorado UCC Lien","description":"Read one UCC or lien filing with the Colorado Secretary of State by its number, or by the number of any of its amendments, and return the whole lien: every filing, every debtor and secured party, the collateral, the lapse date and whether it is still in force. `found: false` when no filing carries that number. Served by Croma, 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","Colorado Secretary of State (UCC)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/colorado-ucc"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filing_number"],"properties":{"filing_number":{"type":"string","pattern":"^\\d{4}[0-9A-Za-z]\\d{6}$","description":"Número de registro UCC en Colorado: el del registro inicial o el de cualquier modificación."}},"additionalProperties":false},"example":{"filing_number":"20262077023"}}}},"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/ColoradoUccLienResponse"}}}},"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/ct-ucc/liens-search/v1":{"post":{"operationId":"ct_ucc_liens_search","summary":"Connecticut UCC Liens Search","description":"Search the UCC and lien filings with the Connecticut Secretary of the State by the names of their debtors and secured parties, companies and people. Filter by status, lien type and filing date. Each lien comes with every filing, its parties, its lapse date and whether it is still in force. 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","Connecticut Secretary of the State (UCC)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/ct-ucc"},"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)."},"status":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (opcional)."},"lien_type":{"type":"string","maxLength":100,"default":"","description":"Valor tal como lo escribe el registro (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."},"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":"citizens bank"}}}},"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/CtUccLiensSearchResponse"}}}},"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/ct-ucc/lien/v1":{"post":{"operationId":"ct_ucc_lien","summary":"Connecticut UCC Lien","description":"Read one UCC or lien filing with the Connecticut Secretary of the State by its lien number or the number of any later filing, and return the whole lien: status, type, lapse date, every filing with the debtors and secured parties it lists, and whether it is still in force. `found: false` when the register does not carry that number. Served by Croma, 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","Connecticut Secretary of the State (UCC)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/united-states/ct-ucc"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filing_number"],"properties":{"filing_number":{"type":"string","pattern":"^[0-9A-Za-z]{1,10}$","description":"Número de registro UCC en Connecticut: el del gravamen o el de cualquier registro posterior."}},"additionalProperties":false},"example":{"filing_number":"0005046935"}}}},"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/CtUccLienResponse"}}}},"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/ibge/tables-search/v1":{"post":{"operationId":"ibge_tables_search","summary":"IBGE Statistical Tables Search","description":"Search the catalog of Brazil's official statistics from IBGE: 9,000+ aggregate tables from PNAD Contínua, IPCA, PIB dos Municípios, Censo Demográfico and some 70 other surveys. Filter by words in the title, survey or variables, subject, periodicity or territorial level. Each table returns its periodicity, the periods it covers, the levels it has data for (country, region, state, municipality...), its variables with units and its classifications with their categories: everything `ibge-table-values` needs. Refreshed weekly.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Brazil","IBGE"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/ibge"},"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":"Words to find in the table's name, its survey, its subject or its variables, e.g. `desocupação` (optional)."},"survey":{"type":"string","maxLength":200,"default":"","description":"The survey, by the two-character `survey_id` a search result returns (e.g. `DD` for PNAD Contínua trimestral, `IA` for IPCA) or by its full name, e.g. `Censo Demográfico`; case and accents ignored (optional)."},"subject":{"type":"string","maxLength":200,"default":"","description":"The subject, as IBGE names it, e.g. `Trabalho` or `Índices de preços`; case and accents ignored (optional)."},"periodicity":{"type":"string","maxLength":40,"default":"","description":"How often the table is published: `monthly`, `quarterly`, `annual`, and the rarer periodicities a search result shows (optional)."},"territory_level":{"type":"string","enum":["","country","region","state","municipality"],"default":"","description":"Only tables with data at this level: `country`, `region`, `state` or `municipality` (optional)."},"table_id":{"type":"string","pattern":"^\\d{0,6}$","default":"","description":"One table by its number, e.g. `4099` (optional)."},"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":"Tables per page (1-20)."}},"additionalProperties":false},"example":{"query":"taxa de desocupação","territory_level":"state","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/IbgeTablesSearchResponse"}}}},"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/ibge/table-values/v1":{"post":{"operationId":"ibge_table_values","summary":"IBGE Statistical Table Values","description":"Read the values of one of IBGE's statistical tables for Brazil: unemployment (table 4099), IPCA inflation (7060), municipal GDP (5938), Censo 2022 population (4709) and 9,000+ more. Choose the variables, the period (`latest`, one period or a range), the territorial level (country, region, state, municipality) with optional IBGE territory codes, and classification categories. Each value comes with its territory, period, unit and categories. Up to 15,000 values per call.","tags":["Brazil","IBGE"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/brazil/ibge"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["table_id"],"properties":{"table_id":{"type":"string","pattern":"^\\d{1,6}$","description":"The table's number, e.g. `4099` (unemployment, PNAD Contínua). `ibge-tables-search` finds it."},"variable_ids":{"type":"string","pattern":"^[\\d,\\s]*$","default":"","description":"The variables to return, by number and separated by commas, e.g. `4099` or `4099,4114`. Empty returns every variable of the table (optional)."},"period":{"type":"string","pattern":"^(latest|\\d{4}(\\d{2})?(-\\d{4}(\\d{2})?)?)$","default":"latest","description":"`latest` (the most recent period the table has), one period (`2023` for a year, `202609` for a month, `202602` for the second quarter of 2026), or a range of them, e.g. `202401-202604`."},"territory_level":{"type":"string","enum":["country","region","state","municipality"],"default":"country","description":"The territorial level of the values: `country` (Brazil), `region` (the five Grandes Regiões), `state` (the 27 UFs) or `municipality`."},"territory_code":{"type":"string","pattern":"^[\\d,\\s]*$","default":"","description":"IBGE codes of the territories, separated by commas: a region's 1 digit, a state's 2 (e.g. `35` São Paulo) or a municipality's 7 (e.g. `3550308` São Paulo). Empty returns every territory of the level (optional)."},"classifications":{"type":"string","pattern":"^[\\d,:;a-z\\s]*$","default":"","description":"Breakdowns to return, as `classification:categories`, several separated by `;`, e.g. `315:7170,7171` (two IPCA groups) or `2:all` (every category of classification 2). A classification left out returns its total (optional)."}},"additionalProperties":false},"example":{"table_id":"4099","variable_ids":"4099","period":"latest","territory_level":"country"}}}},"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/IbgeTableValuesResponse"}}}},"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/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"}}}}}}},"/co/creg/acts-search/v1":{"post":{"operationId":"creg_acts_search","summary":"CREG Acts Search","description":"Search every regulatory act of Colombia's energy and gas regulator, the Comisión de Regulación de Energía y Gas (CREG): resoluciones de carácter general and particular, circulares, conceptos jurídicos, proyectos de resolución and autos de inicio since 1994. Free text matches the title, the number and the full text. Filter by `kind`, `number`, `year` and the date of issue (`issued_from`/`issued_to`). Each result carries the CREG's notes on later amendments, Croma's copy of the act's files and links to the act on the CREG'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","CREG"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/creg"},"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 act's title, its number and its full text."},"kind":{"type":"string","enum":["any","resolution","particular_resolution","draft_resolution","circular","legal_opinion","order"],"default":"any","description":"Kind of act: `resolution` (resolución de carácter general), `particular_resolution` (about one company or one tariff), `draft_resolution` (proyecto under consultation), `circular`, `legal_opinion` (concepto jurídico), `order` (auto de inicio), or `any`."},"number":{"type":"string","maxLength":30,"default":"","description":"Optional act number, e.g. `101 128`, `131` or `345`. Leading zeros and the separator do not matter; combine it with `kind` or `year`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year in the act's designation, 1994 or later. 0 searches every year."},"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":"fronteras comerciales","kind":"resolution","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/CregActsSearchResponse"}}}},"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/creg/act/v1":{"post":{"operationId":"creg_act","summary":"CREG Act","description":"Retrieve one regulatory act of Colombia's Comisión de Regulación de Energía y Gas (CREG) by its `id` from a search result (e.g. `resolucion_101-128_2026`) or its `official_url`: its full text, number, kind, dates, Diario Oficial reference, the CREG's notes on later amendments, Croma's copy of its files and the links to the act on the CREG'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","CREG"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/creg"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["act_id"],"properties":{"act_id":{"type":"string","minLength":1,"maxLength":300,"description":"The act's `id` from a search result, e.g. `resolucion_101-128_2026`. Its `official_url` works too."},"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":{"act_id":"resolucion_101-128_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/CregActResponse"}}}},"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/sic-normativa/regulations-search/v1":{"post":{"operationId":"sic_normativa_regulations_search","summary":"SIC Regulations Search","description":"Search the normative register of Colombia's Superintendencia de Industria y Comercio (SIC): the laws and decrees it applies, its resoluciones, circulares, the títulos of the Circular Única, its doctrina, draft resolutions and appointments, about 7,600 acts. Free text matches the title and the Superintendencia's summary. Filter by `kind` (as the register files it: `Resoluciones`, `Circulares`, `Títulos Circular única`, `Leyes`, `Decretos`, `Doctrina`, ...), `topic` (its area, e.g. `Protección al Consumidor`), the date of issue and the date of publication. Each result carries Croma's copy of every attached file. 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","SIC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-normativa"},"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 title and the Superintendencia's summary."},"kind":{"type":"string","maxLength":60,"default":"","description":"Optional kind as the register files it, e.g. `Resoluciones`, `Circulares`, `Títulos Circular única`, `Leyes`, `Decretos`, `Doctrina`, `Nombramientos`. Case and accents are ignored."},"topic":{"type":"string","maxLength":80,"default":"","description":"Optional area of the Superintendencia, e.g. `Protección al Consumidor`, `Protección de Datos Personales`, `Propiedad Industrial`, matched from the start. Case and accents are ignored."},"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."},"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":"habeas data","kind":"Circulares"}}}},"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/SicRegulationsSearchResponse"}}}},"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/sic-normativa/regulation/v1":{"post":{"operationId":"sic_normativa_regulation","summary":"SIC Regulation","description":"Retrieve one act from the normative register of Colombia's Superintendencia de Industria y Comercio (SIC) by its `id` from a search result or its `official_url`: its kinds, area, dates, the Superintendencia's summary, Croma's copy of every attached file and the link to the act in the register.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SIC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-normativa"},"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":1,"maxLength":300,"description":"The act's `id` from a search result, e.g. `24968`. Its `official_url` works too."}},"additionalProperties":false},"example":{"regulation_id":"24968"}}}},"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/SicRegulationResponse"}}}},"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/sic-normativa/bulletins-search/v1":{"post":{"operationId":"sic_normativa_bulletins_search","summary":"SIC Legal Bulletin Search","description":"Search the Boletín Jurídico of Colombia's Superintendencia de Industria y Comercio (SIC): the decisions and concepts its Oficina Asesora Jurídica highlights since 2019, by area (consumer protection, personal data, industrial property, competition, jurisdictional matters, technical regulations), plus the conceptos it publishes alongside. Free text matches the title, the summary and the tags. Filter by `section` (`bulletin` or `opinion`), `topic` and the date of publication. Each result carries the Superintendencia's summary and Croma's copy of the underlying 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","SIC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-normativa"},"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 title and the Superintendencia's summary."},"section":{"type":"string","enum":["any","bulletin","opinion"],"default":"any","description":"Section: `bulletin` (an item of the Boletín Jurídico), `opinion` (a concepto published alongside), or `any`."},"topic":{"type":"string","maxLength":80,"default":"","description":"Optional area of the Superintendencia, e.g. `Protección al Consumidor`, `Protección de Datos Personales`, `Propiedad Industrial`, matched from the start. Case and accents are ignored."},"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":"retracto","topic":"Protección al Consumidor"}}}},"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/SicBulletinsSearchResponse"}}}},"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/sic-normativa/bulletin/v1":{"post":{"operationId":"sic_normativa_bulletin","summary":"SIC Legal Bulletin Item","description":"Retrieve one item of the Boletín Jurídico of Colombia's Superintendencia de Industria y Comercio (SIC), or one of its conceptos, by its `id` from a search result or its `official_url`: its section, area, tags, date, the Superintendencia's summary, Croma's copy of the underlying document and the link to the item on its site.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SIC"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-normativa"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bulletin_id"],"properties":{"bulletin_id":{"type":"string","minLength":1,"maxLength":300,"description":"The item's `id` from a search result, e.g. `24896`. Its `official_url` works too."}},"additionalProperties":false},"example":{"bulletin_id":"24896"}}}},"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/SicBulletinResponse"}}}},"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/sic-sanctions/sanctions-search/v1":{"post":{"operationId":"sic_sanctions_sanctions_search","summary":"SIC Sanctions Search","description":"Search every final (en firme) fine Colombia's Superintendencia de Industria y Comercio (SIC) has imposed through its consumer-protection investigations directorate since 2013: about 4,000 fines with the case, the resolution, the date, the party fined, the amount in pesos, the conduct and the sector. Free text matches the party, the conduct and the sector. Filter by `party` (the name, matched from the start), `sector`, `case_number`, `resolution_number` and the date of the resolution (`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","SIC Sanctions"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-sanctions"},"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 party fined, the conduct and the sector."},"party":{"type":"string","maxLength":200,"default":"","description":"Optional name of the party fined, matched from the start. Case and accents are ignored."},"sector":{"type":"string","maxLength":120,"default":"","description":"Optional sector, e.g. `Servicios de financiación`, `Turismo`, `Comercio electrónico`, matched from the start. Case and accents are ignored."},"case_number":{"type":"string","maxLength":30,"default":"","description":"Optional case (radicado), e.g. `24 503714` or `24-503714`."},"resolution_number":{"type":"string","maxLength":20,"default":"","description":"Optional number of the resolution that imposed the fine, e.g. `40639`."},"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":100,"default":20,"description":"Results per page (1-100)."}},"additionalProperties":false},"example":{"query":"usura","sector":"Servicios de financiació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/SicSanctionsSearchResponse"}}}},"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/sic-actos/acts-search/v1":{"post":{"operationId":"sic_actos_acts_search","summary":"SIC Acts Search","description":"Search every administrative act and judgment in the register of Colombia's Superintendencia de Industria y Comercio (SIC) since 2014: about 144,000 resoluciones of its investigations and 136,000 sentencias of its jurisdictional delegation. Free text matches the full text, the parties' names, the decisions and the office. Filter by `party_document_number` (a NIT or cédula of any party or representative), `case_number` (the radicado), `office`, `type` (`resolution`, `judgment`) and the date of the act (`issued_from`/`issued_to`). Each result carries the parties with their identification and Croma's copy of the act's 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","SIC Acts"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-actos"},"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 full text, the parties' names, the decisions and the office."},"type":{"type":"string","enum":["any","resolution","judgment"],"default":"any","description":"Type of act: `resolution` (resolución) or `judgment` (sentencia), or `any`."},"office":{"type":"string","maxLength":160,"default":"","description":"Optional issuing office, e.g. `Grupo de Trabajo de Defensa del Consumidor`, matched from the start. Case and accents are ignored."},"case_number":{"type":"string","maxLength":30,"default":"","description":"Optional case (radicado), e.g. `24-449511` or `24 449511`."},"party_document_number":{"type":"string","maxLength":20,"default":"","description":"Optional identification number (NIT or cédula) of any party or representative, digits only; separators are ignored."},"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","type":"resolution","issued_from":"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/SicActsSearchResponse"}}}},"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/sic-actos/act/v1":{"post":{"operationId":"sic_actos_act","summary":"SIC Act","description":"Retrieve one administrative act or judgment from the register of Colombia's Superintendencia de Industria y Comercio (SIC) by its `id` from a search result: its full text, number, date, office, case, decisions, parties with their identification and Croma's copy of its document. 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","SIC Acts"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-actos"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["act_id"],"properties":{"act_id":{"type":"string","minLength":1,"maxLength":12,"description":"The act's `id` from a search result, e.g. `2681688`."},"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":{"act_id":"2681688"}}}},"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/SicActResponse"}}}},"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/sic-tramites/case/v1":{"post":{"operationId":"sic_tramites_case","summary":"SIC Filing","description":"Read one filing (radicado) at Colombia's Superintendencia de Industria y Comercio (SIC), the way one of its parties reads it: give the `year` and `case_number` of the radicado (plus `case_control` when it has one) and the `document_type` and `document_number` of one of its parties. Returns every action (consecutivo) with its procedure (trámite), event, action, direction, date and sender or addressee, plus the administrative acts (autos, sentencias, resoluciones) issued in the filing. With `include_documents` (the default) every document of every action and every act is returned with `document_url`, a stored byte-identical copy, and `source_document_url`; this can take a few minutes, so set `include_documents: false` when only the actions are needed. `document_type` defaults to `NIT`. `found: false` when the filing does not exist or the document is not one of its parties': the Superintendencia does not tell the two apart.\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","SIC Trámites"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-tramites"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["year","case_number","document_number"],"properties":{"year":{"type":"integer","minimum":1990,"maximum":2100,"description":"Year of the filing (radicado), four digits, e.g. `2025`."},"case_number":{"type":"string","pattern":"^\\d{1,9}$","minLength":1,"maxLength":9,"description":"Number of the filing (número de radicado) without the year, e.g. `194793`."},"case_control":{"type":"string","pattern":"^[A-Za-z0-9]{0,2}$","maxLength":2,"default":"","description":"Optional control characters of the filing (control radicado), up to 2. Most filings have none."},"document_type":{"type":"string","enum":["CC","CE","NIT","PA","TI","RC","PEP","PPT"],"default":"NIT","description":"Colombian document type. Defaults to `NIT`."},"document_number":{"type":"string","minLength":3,"maxLength":30,"description":"Document number (alphanumeric with hyphens allowed)."},"include_documents":{"type":"boolean","default":true,"description":"When true (the default), every document of the filing is returned with a `document_url` to a stored copy. Set to `false` for the actions alone, which answers much faster."},"cache":{"type":"boolean","default":true,"description":"Set to `false` to skip any stored result for this lookup and read the source again. The fresh answer replaces the stored one and is charged as a new request. Default `true`."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"year":2025,"case_number":"194793","document_type":"NIT","document_number":"1234567890","include_documents":false}}}},"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/SicTramitesCaseResponse"}}}},"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/sic-gazette/entries-search/v1":{"post":{"operationId":"sic_gazette_entries_search","summary":"SIC Industrial Property Gazette Entries Search","description":"Search every entry of the Gaceta de la Propiedad Industrial of Colombia's Superintendencia de Industria y Comercio (SIC) since July 2016: trademark applications, collective marks, territorial extensions, slogans, registrations, cancellation decisions and rulings; invention patents, utility models, PCT national phases and layout designs; industrial designs. Free text matches the sign or title, the applicant, the owner, the agent and the file number. Filter by `file_number` (matched from the start), `domain`, `section`, `issue_number`, `status`, `nice_class` and the publication date (`from_date`/`to_date`). Each result carries the issue and section, the file number, the filing date, the sign or title, the Nice classes, the priorities, the status, the parties and the classification, with Croma's copy of the issue's workbook. Served by Croma from its copy of the gazette (`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","SIC Industrial Property Gazette"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-gazette"},"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 words to find in the sign or the title, the applicant, the owner, the agent or the file number, e.g. `cafe`, `bavaria`. Every word must appear."},"file_number":{"type":"string","pattern":"^[A-Z0-9/]{0,20}$","default":"","description":"Optional file (expediente) number as the gazette prints it, matched from the start, e.g. `SD2026/0099552` for one file or `NC2026/` for every new-creation file of 2026."},"domain":{"type":"string","enum":["","trademarks","patents","designs"],"default":"","description":"Optional part of the gazette: `trademarks` (distinctive signs), `patents` (inventions, utility models and layout designs) or `designs` (industrial designs)."},"section":{"type":"string","pattern":"^[a-z_]{0,40}$","default":"","description":"Optional section: `trademarks`, `collective_marks`, `territorial_extensions`, `slogans`, `registrations`, `cancellation_decisions`, `nullity_judgments`, `patents`, `utility_models`, `pct_patents`, `layout_designs`, `industrial_designs` or `judgment_publications`."},"issue_number":{"type":"integer","minimum":0,"maximum":100000,"default":0,"description":"Optional issue number of the gazette, e.g. `1116`. 0 searches every issue."},"status":{"type":"string","maxLength":40,"default":"","description":"Optional status as the gazette prints it, e.g. `Publicada`, `Registrada`, `Publicada sin pago`, `Publicado`. Case and accents are ignored."},"nice_class":{"type":"integer","minimum":0,"maximum":45,"default":0,"description":"Optional international (Nice) class of the goods or services, 1 to 45, e.g. `25` (clothing). 0 searches every class."},"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":"cafe","domain":"trademarks","section":"trademarks"}}}},"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/SicGazetteEntriesSearchResponse"}}}},"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/sic-gazette/issues-search/v1":{"post":{"operationId":"sic_gazette_issues_search","summary":"SIC Industrial Property Gazette Issues","description":"List the issues of the Gaceta de la Propiedad Industrial of Colombia's Superintendencia de Industria y Comercio (SIC) since July 2016, one row per issue and part (`trademarks`, `patents`, `designs`), newest first, filtered by part and publication date (`from_date`/`to_date`). Each carries its number, publication date, sections, entry count and Croma's copy of the workbook the Superintendencia published. Served by Croma from its copy of the gazette (`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","SIC Industrial Property Gazette"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-gazette"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"string","enum":["","trademarks","patents","designs"],"default":"","description":"Optional part of the gazette: `trademarks` (distinctive signs), `patents` (inventions, utility models and layout designs) or `designs` (industrial designs)."},"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":{"domain":"trademarks","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/SicGazetteIssuesSearchResponse"}}}},"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/sic-gazette/issue/v1":{"post":{"operationId":"sic_gazette_issue","summary":"SIC Industrial Property Gazette Issue","description":"Retrieve one issue of the Gaceta de la Propiedad Industrial of Colombia's Superintendencia de Industria y Comercio (SIC) by its `number` and part (`domain`: `trademarks`, `patents` or `designs`): its publication date, sections, entry count, when the workbook was generated and Croma's copy of the workbook the Superintendencia published. Served by Croma from its copy of the gazette (`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","SIC Industrial Property Gazette"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-gazette"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number","domain"],"properties":{"number":{"type":"integer","minimum":1,"maximum":100000,"description":"The issue number of the gazette, e.g. `1116`."},"domain":{"type":"string","enum":["trademarks","patents","designs"],"description":"The part of the gazette: `trademarks` (distinctive signs), `patents` (inventions, utility models and layout designs) or `designs` (industrial designs)."}},"additionalProperties":false},"example":{"number":1116,"domain":"trademarks"}}}},"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/SicGazetteIssueResponse"}}}},"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/sic-ip/trademarks-search/v1":{"post":{"operationId":"sic_ip_trademarks_search","summary":"SIC Trademarks Search","description":"Search Colombia's trademark register (SIC), about 0.9 million cases filed since 1930, by words of the sign or the owner's name, narrowed by `status` (as the register words it, e.g. `Registrada`), `nice_class` (1-45), `certificate_number` and the filing date (`from_date`/`to_date`). Each result carries the file number, certificate, sign, status, vigencia, owners, Nice classes, gazette and the label. Read one case in full with `sic_ip_trademark`. Served by Croma from its copy (`as_of` says how current it is).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SIC, Registro de la Propiedad Industrial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-ip"},"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 words to find in the sign or in the owner's name, e.g. `credisander`, `bancolombia`. Every word must appear."},"status":{"type":"string","maxLength":80,"default":"","description":"Optional status exactly as the register words it, e.g. `Registrada`, `Publicada`, `Concedida`, `Negada`, `Caducado`, `Bajo Examen Formal`. Case and accents matter."},"nice_class":{"type":"string","pattern":"^(?:[1-9]|[1-3]\\d|4[0-5])?$","default":"","description":"Optional Nice class of the goods or services, 1 to 45, e.g. `36` (financial services), `25` (clothing)."},"certificate_number":{"type":"string","pattern":"^\\d{0,9}$","default":"","description":"Optional registration certificate number, e.g. `612592`."},"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":"cafe","nice_class":"30"}}}},"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/SicIpTrademarksSearchResponse"}}}},"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/sic-ip/patents-search/v1":{"post":{"operationId":"sic_ip_patents_search","summary":"SIC Patents Search","description":"Search Colombia's patent register (SIC): inventions, utility models, PCT national phases and layout designs, by words of the title or the owner's name, narrowed by `status` and the filing date (`from_date`/`to_date`). Each result carries the file number, grant number, title, filing date, status, owners and the characteristic figure. Read one case in full with `sic_ip_patent`. Served by Croma from its copy (`as_of`).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SIC, Registro de la Propiedad Industrial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-ip"},"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 words to find in the title or in the owner's name, e.g. `licuadora`. Every word must appear."},"status":{"type":"string","maxLength":80,"default":"","description":"Optional status exactly as the register words it, e.g. `Registrada`, `Publicada`, `Concedida`, `Negada`, `Caducado`, `Bajo Examen Formal`. Case and accents matter."},"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":"dispositivo","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/SicIpPatentsSearchResponse"}}}},"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/sic-ip/designs-search/v1":{"post":{"operationId":"sic_ip_designs_search","summary":"SIC Industrial Designs Search","description":"Search Colombia's industrial design register (SIC) by words of the title or the owner's name, narrowed by `status` and the filing date (`from_date`/`to_date`). Each result carries the file number, registration number, title, filing date, status, owners and the characteristic figure. Read one case in full with `sic_ip_design`. Served by Croma from its copy (`as_of`).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SIC, Registro de la Propiedad Industrial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-ip"},"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 words to find in the title or in the owner's name, e.g. `licuadora`. Every word must appear."},"status":{"type":"string","maxLength":80,"default":"","description":"Optional status exactly as the register words it, e.g. `Registrada`, `Publicada`, `Concedida`, `Negada`, `Caducado`, `Bajo Examen Formal`. Case and accents matter."},"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":"botella"}}}},"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/SicIpDesignsSearchResponse"}}}},"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/sic-ip/resolutions-search/v1":{"post":{"operationId":"sic_ip_resolutions_search","summary":"SIC Industrial Property Resolutions Search","description":"Search every resolution and oficio Colombia's industrial-property office (SIC) has sent out since 2016 in trademark, patent and design cases (grants, refusals, oppositions, cancellations, transfers, licences, security interests, requirements) by words of the document type or the parties notified, narrowed by `file_number` (the case or the main case it belongs to), `kind` (`resolucion` or `oficio`) and the date it was sent (`from_date`/`to_date`). Each result carries the number, type, act date, the case numbers, the parties with their notification and ejecutoria dates and the PDF. Served by Croma from its copy (`as_of`).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Colombia","SIC, Registro de la Propiedad Industrial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-ip"},"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 words to find in the document's type or in the names of the parties it was notified to, e.g. `cancelación`, `garantía mobiliaria`. Every word must appear."},"file_number":{"type":"string","pattern":"^\\s*(?:(?:[A-Za-z]{2}\\s*\\d{4}\\s*\\/?\\s*\\d{1,7}|\\d{1,10})\\s*)?$","default":"","description":"Optional file number (expediente) the document was issued in, either the request itself or the main case it belongs to, e.g. `SD2026/0083453`."},"kind":{"type":"string","enum":["","resolucion","oficio"],"default":"","description":"Optional kind of document: `resolucion` (a decision) or `oficio` (a requirement or a notice). Empty lists both."},"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":"cancelación","kind":"resolucion"}}}},"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/SicIpResolutionsSearchResponse"}}}},"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/sic-ip/trademark/v1":{"post":{"operationId":"sic_ip_trademark","summary":"SIC Trademark","description":"Read one Colombian trademark case in full by its file number (expediente, e.g. `SD2026/0066943`): status and dates, certificate and vigencia, the sign and its label, each Nice class with its goods and services, every party (owner, applicant, agent, contact) with identification number and address, the full procedural history, linked oppositions, transfers and other requests, and every document of the file with Croma's copy. Answers from Croma's copy within a day of the last read (`served_from`, `checked_at`); `found: false` when the register has no trademark under the number. Find numbers with `sic_ip_trademarks_search`.\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}`.\n\n**Lookup endpoint**: answers from Croma's copy when it holds a recent answer for the key, otherwise reads the source and keeps the answer; carries `checked_at` and `served_from`.","x-served-from":"lookup","tags":["Colombia","SIC, Registro de la Propiedad Industrial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-ip"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_number"],"properties":{"file_number":{"type":"string","pattern":"^\\s*(?:[A-Za-z]{2}\\s*\\d{4}\\s*\\/?\\s*\\d{1,7}|\\d{1,10})\\s*$","description":"The case's file number (expediente), e.g. `SD2026/0031979` for a trademark or `NC2026/0006185` for a patent or a design, or the bare digits of a file opened before 2016 (`16137606`). The year's consecutive may be written without its leading zeros."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"file_number":"SD2026/0066943"}}}},"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/SicIpTrademarkResponse"}}}},"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/sic-ip/patent/v1":{"post":{"operationId":"sic_ip_patent","summary":"SIC Patent","description":"Read one Colombian patent case in full by its file number (e.g. `NC2026/0006185`): status and dates, grant, title, abstract, technology sector, every party (applicant, inventor, agent, contact) with identification number and address, the public specification, the procedural history, linked requests and every document of the file with Croma's copy. Answers from Croma's copy within a day of the last read; `found: false` when the register has no patent under the number. Find numbers with `sic_ip_patents_search`.\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}`.\n\n**Lookup endpoint**: answers from Croma's copy when it holds a recent answer for the key, otherwise reads the source and keeps the answer; carries `checked_at` and `served_from`.","x-served-from":"lookup","tags":["Colombia","SIC, Registro de la Propiedad Industrial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-ip"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_number"],"properties":{"file_number":{"type":"string","pattern":"^\\s*(?:[A-Za-z]{2}\\s*\\d{4}\\s*\\/?\\s*\\d{1,7}|\\d{1,10})\\s*$","description":"The case's file number (expediente), e.g. `SD2026/0031979` for a trademark or `NC2026/0006185` for a patent or a design, or the bare digits of a file opened before 2016 (`16137606`). The year's consecutive may be written without its leading zeros."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"file_number":"NC2026/0006185"}}}},"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/SicIpPatentResponse"}}}},"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/sic-ip/design/v1":{"post":{"operationId":"sic_ip_design","summary":"SIC Industrial Design","description":"Read one Colombian industrial design case in full by its file number (e.g. `NC2026/0004592`): status and dates, registration, title, Locarno classes, every party (applicant, designer, agent, contact) with identification number and address, the figures, the procedural history and every document of the file with Croma's copy. Answers from Croma's copy within a day of the last read; `found: false` when the register has no design under the number. Find numbers with `sic_ip_designs_search`.\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}`.\n\n**Lookup endpoint**: answers from Croma's copy when it holds a recent answer for the key, otherwise reads the source and keeps the answer; carries `checked_at` and `served_from`.","x-served-from":"lookup","tags":["Colombia","SIC, Registro de la Propiedad Industrial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-ip"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_number"],"properties":{"file_number":{"type":"string","pattern":"^\\s*(?:[A-Za-z]{2}\\s*\\d{4}\\s*\\/?\\s*\\d{1,7}|\\d{1,10})\\s*$","description":"The case's file number (expediente), e.g. `SD2026/0031979` for a trademark or `NC2026/0006185` for a patent or a design, or the bare digits of a file opened before 2016 (`16137606`). The year's consecutive may be written without its leading zeros."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"file_number":"NC2026/0004592"}}}},"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/SicIpDesignResponse"}}}},"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/sic-ip/trademarks-by-owner/v1":{"post":{"operationId":"sic_ip_trademarks_by_owner","summary":"SIC Trademarks by Owner","description":"List every Colombian trademark case of one owner or applicant, by NIT or cédula as the register records it (with or without the NIT's check digit): the file number, certificate, sign, status, vigencia, owners, Nice classes, gazette and the filing date, read from the register now. A portfolio of hundreds of marks takes up to a minute. `found: false` when the register knows no party under the number. Read any case in full with `sic_ip_trademark`.\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","SIC, Registro de la Propiedad Industrial"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/sic-ip"},"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":"^\\s*\\d[\\d.\\s]{3,14}(?:-\\d)?\\s*$","description":"The owner's or applicant's identification number as the register records it: a company's NIT (with or without its check digit) or a person's cédula, e.g. `890903938`."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"document_number":"800176089"}}}},"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/SicIpTrademarksByOwnerResponse"}}}},"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/suit/procedures-search/v1":{"post":{"operationId":"suit_procedures_search","summary":"Colombia Procedures Search","description":"Search every procedure (trámite) Colombia's public entities offer in the national register of procedures (SUIT), national and territorial. Free text matches the name, the entity, the purpose and the full information, requirements and fees included. Filter by `order` (`national` or `territorial`), `entity_code`, and the DANE `department_code` and `municipality_code`. Each result links to the procedure on gov.co. 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","Trámites SUIT"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/suit"},"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 procedure's name, the entity, its purpose and its full content (requirements, fees, steps, channels)."},"order":{"type":"string","enum":["any","national","territorial"],"default":"any","description":"Optional: `national` for procedures of national entities, `territorial` for departments, districts and municipalities, `any` for both."},"entity_code":{"type":"string","maxLength":20,"default":"","description":"Optional: only procedures of the entity with this code, as `entity_code` gives it in a result (e.g. `5396` for the Registraduría)."},"department_code":{"type":"string","maxLength":2,"default":"","description":"Optional: two-digit DANE code of the entity's department, e.g. `05` for Antioquia, `11` for Bogotá."},"municipality_code":{"type":"string","maxLength":5,"default":"","description":"Optional: five-digit DANE code of the entity's municipality, e.g. `11001` for Bogotá, `05001` for Medellín."},"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":"duplicado cédula","order":"national"}}}},"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/SuitProceduresSearchResponse"}}}},"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/suit/procedure/v1":{"post":{"operationId":"suit_procedure","summary":"Colombia Procedure","description":"Retrieve one procedure (trámite) of Colombia's national register of procedures (SUIT) by its número único, e.g. `44` or `T44`, or by its gov.co link: its entity, whether it can be done online, and its full information as markdown, with every step, document, condition, channel, form and fee, the time to obtain, exceptions, legal basis and points of service. `modified_at` says when the entity last updated it. 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","Trámites SUIT"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/suit"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["procedure_id"],"properties":{"procedure_id":{"type":"string","minLength":1,"maxLength":300,"description":"The procedure's `id` from a search result, e.g. `44` (also as `T44`), or its `official_url` on gov.co."},"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":{"procedure_id":"T44"}}}},"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/SuitProcedureResponse"}}}},"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/gov-pages/search/v1":{"post":{"operationId":"gov_pages_search","summary":"Colombia Entity Procedure Pages Search","description":"Search the procedure pages Colombian entities publish on their own sites: requirements, fees and how to pay, where to apply, delivery times and FAQs. Covers the Cancillería (passports, visas, apostilles) and the Unidad para las Víctimas (Registro Único de Víctimas, humanitarian aid, compensation). Free text matches each page's title and full content; filter by `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","Páginas de trámites"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/gov-pages"},"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 each page's title and full text, e.g. `pasaporte costos` or `registro único de víctimas`."},"site":{"type":"string","enum":["","cancilleria","unidad-victimas"],"default":"","description":"Optional: only the pages of `cancilleria` (Ministerio de Relaciones Exteriores) or `unidad-victimas` (Unidad para las Víctimas)."},"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":{"query":"pasaporte costos","site":"cancilleria"}}}},"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/GovPagesSearchResponse"}}}},"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/gov-pages/page/v1":{"post":{"operationId":"gov_pages_page","summary":"Colombia Entity Procedure Page","description":"Read one procedure page of a Colombian entity's own site in full, as markdown with its links, by its `id` from a search result or by its address: requirements, fees and how to pay, where to apply, delivery times or FAQs, as the entity publishes them. 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","Páginas de trámites"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/gov-pages"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["page_id"],"properties":{"page_id":{"type":"string","minLength":1,"maxLength":500,"description":"The page's `id` from a search result, or its `url`."},"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":{"page_id":"https://www.cancilleria.gov.co/atencion-y-servicio-al-ciudadano/tramites-y-servicios/pasaportes/costos-y-medios-de-pago"}}}},"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/GovPageResponse"}}}},"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"}}}}}}},"/sv/csj-sv/rulings-search/v1":{"post":{"operationId":"csj_sv_rulings_search","summary":"Corte Suprema de Justicia de El Salvador Rulings Search","description":"Search the jurisprudencia the Corte Suprema de Justicia de El Salvador publishes: every resolution since 1951 from the Corte Plena and its Salas to the Cámaras, Tribunales de Sentencia and Juzgados. Free text matches the reference number, the court, the decision, the facts, the headnotes and the full text. Filter by `court_type`, `court`, `subject` (the area of law), `proceeding_type`, `type` (the kind of resolution), `crime`, `registration_number` (the reference number), `year` and the ruling date (`from_date`/`to_date`). Each result carries the original document, kept by Croma, and links to the record and the document 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":["El Salvador","Corte Suprema de Justicia de El Salvador"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/csj"},"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 reference number, the court, the decision, the facts, the headnotes and the full text."},"court_type":{"type":"string","enum":["","corte_plena","sala","camara","tribunal_de_sentencia","juzgado"],"default":"","description":"Optional level of the court: `corte_plena`, `sala` (the Salas of the Corte Suprema), `camara` (the second-instance Cámaras), `tribunal_de_sentencia` or `juzgado`."},"court":{"type":"string","maxLength":160,"default":"","description":"Optional court as `court` names it, e.g. `Sala de lo Constitucional`, matched from the start of the name. Case and accents are ignored."},"subject":{"type":"string","maxLength":120,"default":"","description":"Optional area of law as `subject` names it, e.g. `Penal`, `Familia`, `Civil y Mercantil`, `Constitucional`, `Laboral`, matched from the start. Case and accents are ignored."},"proceeding_type":{"type":"string","maxLength":160,"default":"","description":"Optional kind of proceeding as `proceeding_type` names it, e.g. `Amparo`, `Hábeas corpus`, `Inconstitucionalidad`, matched from the start. Case and accents are ignored."},"type":{"type":"string","maxLength":120,"default":"","description":"Optional kind of resolution as `type` names it, e.g. `Sentencias definitivas`, `Interlocutorias`, `Improcedencias`, matched from the start. Case and accents are ignored."},"crime":{"type":"string","maxLength":200,"default":"","description":"Optional crime as it appears in `crimes`, e.g. `Homicidio agravado`, matched in full. Case and accents are ignored."},"registration_number":{"type":"string","maxLength":80,"default":"","description":"Optional reference number (N°) as the court prints it, e.g. `49COMP2026` or `86-CAC-2026`. Returns every resolution of that reference. Case, spaces and punctuation are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the resolution. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"debido proceso","court_type":"sala","subject":"constitucional"}}}},"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/CsjSvRulingsSearchResponse"}}}},"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"}}}}}}},"/sv/csj-sv/ruling/v1":{"post":{"operationId":"csj_sv_ruling","summary":"Corte Suprema de Justicia de El Salvador Ruling","description":"Retrieve one resolution from the jurisprudencia of El Salvador's Corte Suprema de Justicia by its `id` from a search result (e.g. `1138697`) or its `official_url`: its full text, the reference number, the court, the area of law, the kind of proceeding and of resolution, the decision, the headnotes, the original document as the court published it, and the links to the record and the document 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":["El Salvador","Corte Suprema de Justicia de El Salvador"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/csj"},"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":600,"description":"The resolution's `id` from a search result, e.g. `1138697`. Its `official_url` works too."},"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":"1138697"}}}},"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/CsjSvRulingResponse"}}}},"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"}}}}}}},"/sv/csj-sv/laws-search/v1":{"post":{"operationId":"csj_sv_laws_search","summary":"Corte Suprema de Justicia de El Salvador Laws Search","description":"Search El Salvador's legislation as the Corte Suprema de Justicia's documentation center keeps it: more than 10,000 legal texts published in the Diario Oficial since 1821, from the codes and laws to executive decrees, regulations, agreements and municipal ordinances. Free text matches the name, the documentation center's summary and the consolidated text. Filter by `type`, `status` (`vigente`, `caducada`, `derogada`), `subject`, `number`, `municipality`, `department`, `year` and the publication date (`from_date`/`to_date`). Each result carries Croma's copy of the original document and links to the record and the document 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":["El Salvador","Corte Suprema de Justicia de El Salvador"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/csj"},"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 act's name, the documentation center's summary and the full text."},"type":{"type":"string","maxLength":80,"default":"","description":"Optional kind of document as `type` names it: `Decretos Legislativos`, `Decretos Ejecutivos`, `Decretos Institucionales`, `Acuerdos`, `Reglamentos`, `Ordenanzas Municipales` or `Documentos Generales`, matched from the start. Case and accents are ignored."},"status":{"type":"string","enum":["","vigente","caducada","derogada"],"default":"","description":"Optional status: `vigente` (in force), `caducada` (expired) or `derogada` (repealed)."},"subject":{"type":"string","maxLength":80,"default":"","description":"Optional area of law as `subject` names it, e.g. `Penal`, `Tributaria`, `Laboral`, matched from the start. Case and accents are ignored."},"number":{"type":"string","maxLength":40,"default":"","description":"Optional decree or agreement number, e.g. `1030`. Case, spaces and punctuation are ignored."},"municipality":{"type":"string","maxLength":120,"default":"","description":"Optional municipality of an ordinance, e.g. `San Salvador Centro`, matched from the start. Case and accents are ignored."},"department":{"type":"string","maxLength":80,"default":"","description":"Optional department of an ordinance, e.g. `La Libertad`, matched from the start. Case and accents are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of publication in the Diario Oficial. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"código penal","status":"vigente"}}}},"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/CsjSvLawsSearchResponse"}}}},"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"}}}}}}},"/sv/csj-sv/law/v1":{"post":{"operationId":"csj_sv_law","summary":"Corte Suprema de Justicia de El Salvador Law","description":"Retrieve one legal text of El Salvador by its `id` from a search result (e.g. `558819`, the Código Penal) or its `official_url`: its consolidated text, status, every amendment with its act and Croma's copy of its own text, the rulings related to it, and every version of its document Croma has kept. 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":["El Salvador","Corte Suprema de Justicia de El Salvador"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/csj"},"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":600,"description":"The act's `id` from a search result, e.g. `558819`. Its `official_url` works too."},"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":"558819"}}}},"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/CsjSvLawResponse"}}}},"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"}}}}}}},"/sv/asamblea-sv/decrees-search/v1":{"post":{"operationId":"asamblea_sv_decrees_search","summary":"Asamblea Legislativa de El Salvador Decrees Search","description":"Search every decree of El Salvador's Asamblea Legislativa. Its register holds the laws, codes and regulations and every other legislative decree, from loan authorizations and tax exemptions to elections of officials and honorary distinctions. Free text matches the title, the Asamblea's summary and the full text. Filter by `type` (`Decreto`, `Ley`, `Código`, `Reglamento`), `subject`, `subtopic`, `area_of_law`, `number`, `year` and the date the decree was issued (`from_date`/`to_date`). Each result carries Croma's copy of the decree's document and links to the record and the document on the Asamblea'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":["El Salvador","Asamblea Legislativa de El Salvador"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/asamblea"},"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 decree's title, the Asamblea's summary and the full text."},"type":{"type":"string","maxLength":40,"default":"","description":"Optional kind of act as `type` names it: `Decreto`, `Ley`, `Código` or `Reglamento`. Case and accents are ignored."},"subject":{"type":"string","maxLength":120,"default":"","description":"Optional subject as `subject` names it, e.g. `Hacienda y Presupuesto`, `Asamblea Legislativa`, `Seguridad Pública`, matched from the start. Case and accents are ignored."},"subtopic":{"type":"string","maxLength":160,"default":"","description":"Optional subtopic as `subtopic` names it, e.g. `Autorizaciones para Préstamos`, `Exenciones (Franquicias)`, `Distinciones Honoríficas`, matched from the start. Case and accents are ignored."},"area_of_law":{"type":"string","maxLength":120,"default":"","description":"Optional area of law as `area_of_law` names it, e.g. `Derecho Administrativo`, `Derecho Penal`, `Derecho Tributario o Fiscal`, matched from the start. Case and accents are ignored."},"number":{"type":"string","maxLength":20,"default":"","description":"Optional decree number, e.g. `632`. Numbers restart with each legislature, so combine it with `year` or dates."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the Asamblea issued the decree. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"préstamo","subject":"Hacienda y Presupuesto","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/AsambleaSvDecreesSearchResponse"}}}},"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"}}}}}}},"/sv/asamblea-sv/decree/v1":{"post":{"operationId":"asamblea_sv_decree","summary":"Asamblea Legislativa de El Salvador Decree","description":"Retrieve one decree from the register of El Salvador's Asamblea Legislativa by its `id` from a search result (e.g. `7000`) or its `official_url`: its full text, number, kind, dates of issue and publication, Diario Oficial issue, subject, subtopic, area of law, the Asamblea's summary, Croma's copy of its document and the links to the record and the document on the Asamblea'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":["El Salvador","Asamblea Legislativa de El Salvador"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/asamblea"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["decree_id"],"properties":{"decree_id":{"type":"string","minLength":1,"maxLength":300,"description":"The decree's `id` from a search result, e.g. `7000`. Its `official_url` works too."},"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":{"decree_id":"7000"}}}},"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/AsambleaSvDecreeResponse"}}}},"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"}}}}}}},"/sv/mitur-sv/places-search/v1":{"post":{"operationId":"mitur_sv_places_search","summary":"El Salvador Tourism Places Search","description":"Search El Salvador's official tourism directory, kept by the Ministerio de Turismo: destinations, public and private tourist sites, restaurants, lodging, transport, recreation, tourist information, surf schools and certified tour guides. Free text matches the name, description, address, town and region. Filter by `kind`, `theme` (`surf_city`, `bitcoin`, `nature_adventure`, `archaeology`, `towns`, `wellness`, `regional`), `department`, `municipality`, the `language` a guide works in, and `registered_only` for businesses in the national tourism registry. Businesses carry the contact details the directory publishes; guides carry their languages and area, not personal contacts. 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":["El Salvador","Ministerio de Turismo de El Salvador"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/turismo"},"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 name, the description, the address, the town and the region."},"kind":{"type":"string","enum":["","destination","attraction","restaurant","lodging","transport","recreation","tourist_info","surf_school","guide"],"default":"","description":"Optional kind of place: `destination`, `attraction` (a tourist site, public or private), `restaurant`, `lodging`, `transport`, `recreation`, `tourist_info`, `surf_school` or `guide` (a certified tour guide)."},"theme":{"type":"string","enum":["","surf_city","bitcoin","nature_adventure","archaeology","towns","wellness","regional"],"default":"","description":"Optional theme the Ministerio de Turismo files a destination under: `surf_city`, `bitcoin` (its Bitcoin destinations), `nature_adventure`, `archaeology`, `towns`, `wellness` or `regional` (destinations in neighbouring countries)."},"department":{"type":"string","enum":["","Ahuachapán","Cabañas","Chalatenango","Cuscatlán","La Libertad","La Paz","La Unión","Morazán","San Miguel","San Salvador","San Vicente","Santa Ana","Sonsonate","Usulután"],"default":"","description":"Optional department of El Salvador, e.g. `La Libertad`, `Santa Ana`, `Usulután`."},"municipality":{"type":"string","maxLength":80,"default":"","description":"Optional town or municipality, e.g. `Suchitoto`, `Tamanique`, `Concepción de Ataco`, matched from the start. Case and accents are ignored."},"language":{"type":"string","enum":["","es","en","fr","it","de","pt","nah"],"default":"","description":"Optional language a tour guide works in, as an ISO 639 code: `es`, `en`, `fr`, `it`, `de`, `pt` or `nah` (Náhuat)."},"registered_only":{"type":"boolean","default":false,"description":"When true, only businesses inscribed in the national tourism registry (Registro Nacional de Turismo)."},"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":"El Tunco","kind":"lodging","department":"La Libertad"}}}},"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/MiturSvPlacesSearchResponse"}}}},"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"}}}}}}},"/sv/mitur-sv/place/v1":{"post":{"operationId":"mitur_sv_place","summary":"El Salvador Tourism Place","description":"Retrieve one place from El Salvador's official tourism directory by its `id` from a search result (e.g. `2905`), its `slug` or its `official_url`: everything the search returns plus a destination's description and its photos, each with Croma's copy of the photo and the link to it on the official site.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["El Salvador","Ministerio de Turismo de El Salvador"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/turismo"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["place_id"],"properties":{"place_id":{"type":"string","minLength":1,"maxLength":300,"description":"The place's `id` from a search result, e.g. `2905`. Its `slug` or `official_url` work too."}},"additionalProperties":false},"example":{"place_id":"2905"}}}},"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/MiturSvPlaceResponse"}}}},"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"}}}}}}},"/sv/mitur-sv/events-search/v1":{"post":{"operationId":"mitur_sv_events_search","summary":"El Salvador Tourism Events Search","description":"Search the official agenda of El Salvador's Ministerio de Turismo: festivals, fairs, concerts, sports and cultural events across the country, each with its dates, venue, department and links for more information. Without `from_date` it returns events that have not ended yet. Filter by date range (`from_date`/`to_date`, matched against the days the event runs), `department` and free text over the name and venue. 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":["El Salvador","Ministerio de Turismo de El Salvador"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/turismo"},"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 event's name and venue."},"department":{"type":"string","enum":["","Ahuachapán","Cabañas","Chalatenango","Cuscatlán","La Libertad","La Paz","La Unión","Morazán","San Miguel","San Salvador","San Vicente","Santa Ana","Sonsonate","Usulután"],"default":"","description":"Optional department of El Salvador, e.g. `La Libertad`, `Santa Ana`, `Usulután`."},"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":{"department":"San Salvador"}}}},"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/MiturSvEventsSearchResponse"}}}},"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"}}}}}}},"/sv/comprasal-sv/suppliers-search/v1":{"post":{"operationId":"comprasal_sv_suppliers_search","summary":"El Salvador COMPRASAL Suppliers Search","description":"Search COMPRASAL's supplier register, the suppliers registered to sell to El Salvador's public sector, by name or trade name. Matched by spelling: typos, accents and the legal form do not get in the way, best match first, each with a `score`. Filter to suppliers flagged as sanctioned with `sanctioned_only`. Use a result's `id` with the supplier profile, the awards search and the tender match. 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":["El Salvador","COMPRASAL (DINAC)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/compras-publicas"},"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 supplier name or trade name, e.g. `Textiles Varios`. Matched by spelling, so typos, accents and the legal form do not get in the way; best match first."},"sanctioned_only":{"type":"boolean","default":false,"description":"When true, only suppliers COMPRASAL flags as sanctioned."},"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":"Textiles Varios"}}}},"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/ComprasalSvSuppliersSearchResponse"}}}},"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"}}}}}}},"/sv/comprasal-sv/supplier/v1":{"post":{"operationId":"comprasal_sv_supplier","summary":"El Salvador COMPRASAL Supplier","description":"One supplier's profile in El Salvador's public procurement, by its `id` from the suppliers search: its register entry, every sanctions list entry whose name matches its name or trade name (with whether it is in force today), and its contract history across every contracting entity: how many awards, the total amount, the first and last award dates, the entities it sold to and its latest awards. 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":["El Salvador","COMPRASAL (DINAC)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/compras-publicas"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["supplier_id"],"properties":{"supplier_id":{"type":"integer","minimum":1,"maximum":100000000,"description":"The supplier's `id` from the suppliers search, e.g. `392`."}},"additionalProperties":false},"example":{"supplier_id":392}}}},"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/ComprasalSvSupplierResponse"}}}},"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"}}}}}}},"/sv/comprasal-sv/awards-search/v1":{"post":{"operationId":"comprasal_sv_awards_search","summary":"El Salvador COMPRASAL Awards Search","description":"Search every contract award published on COMPRASAL, El Salvador's public procurement system, since December 2024. Free text matches what was bought, the process code, the supplier and the contracting entity. Filter by `supplier_id` (every award to one supplier, across every entity), `entity_id`, `process_code` and award date range. Newest first, best match first with `query`. 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":["El Salvador","COMPRASAL (DINAC)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/compras-publicas"},"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 words matched against what was bought, the process code, the supplier and the contracting entity, e.g. `uniformes`."},"supplier_id":{"type":"integer","minimum":0,"maximum":100000000,"default":0,"description":"Optional supplier `id` from the suppliers search, e.g. `392`: only that supplier's awards."},"entity_id":{"type":"integer","minimum":0,"maximum":100000000,"default":0,"description":"Optional contracting entity `entity_id`, as awards carry it, e.g. `438`."},"process_code":{"type":"string","maxLength":60,"default":"","description":"Optional process code, e.g. `1000009-2026-P0003`: only the awards of that process."},"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":"uniformes","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/ComprasalSvAwardsSearchResponse"}}}},"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"}}}}}}},"/sv/comprasal-sv/award/v1":{"post":{"operationId":"comprasal_sv_award","summary":"El Salvador COMPRASAL Award Report","description":"One award's report on COMPRASAL by its `id` from an awards search: the contract name, contracting method, term in days, planned and certified amounts, when the process was published, opened and closed, its stage, when the contract was signed, the budget codes that fund it, every bidder, and how many contract modifications and payments it records. Read from COMPRASAL on the first ask and kept: later asks within three days are answered from Croma's copy (`served_from`, `checked_at`).\n\n**Lookup endpoint**: answers from Croma's copy when it holds a recent answer for the key, otherwise reads the source and keeps the answer; carries `checked_at` and `served_from`.","x-served-from":"lookup","tags":["El Salvador","COMPRASAL (DINAC)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/compras-publicas"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["award_id"],"properties":{"award_id":{"type":"integer","minimum":1,"maximum":1000000000,"description":"The award's `id` from an awards search, e.g. `587047`."}},"additionalProperties":false},"example":{"award_id":587047}}}},"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/ComprasalSvAwardResponse"}}}},"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"}}}}}}},"/sv/comprasal-sv/tenders-search/v1":{"post":{"operationId":"comprasal_sv_tenders_search","summary":"El Salvador COMPRASAL Open Tenders Search","description":"Search the procurement processes open on COMPRASAL, El Salvador's public procurement system: what each entity is buying, how, its calendar of stages, when offers close and the economic activities it is open to. By default only processes whose offers are still due, soonest deadline first. Filter by `activity_code` and free text over the name, the code and the entity. Refreshed every three hours (`as_of`).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["El Salvador","COMPRASAL (DINAC)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/compras-publicas"},"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 words matched against what is being bought, the process code and the contracting entity, e.g. `uniformes`."},"activity_code":{"type":"string","maxLength":10,"pattern":"^\\d*$","default":"","description":"Optional economic activity code the process is open to, e.g. `46592`."},"open_only":{"type":"boolean","default":true,"description":"When true (the default), only processes whose offers are still due."},"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":"uniformes"}}}},"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/ComprasalSvTendersSearchResponse"}}}},"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"}}}}}}},"/sv/comprasal-sv/tenders-for-supplier/v1":{"post":{"operationId":"comprasal_sv_tenders_for_supplier","summary":"El Salvador COMPRASAL Tenders for a Supplier","description":"The open COMPRASAL processes a supplier could bid on, by its `id` from the suppliers search: open tenders whose offers are still due, ranked by how much they share with what the supplier has been awarded before (rare words count more than common ones), each with its `score`, the `matched_terms` and the past awards that read most like it. Served by Croma from its copy of the open tenders and the supplier's awards (`as_of`).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["El Salvador","COMPRASAL (DINAC)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/compras-publicas"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["supplier_id"],"properties":{"supplier_id":{"type":"integer","minimum":1,"maximum":100000000,"description":"The supplier's `id` from the suppliers search, e.g. `392`."},"limit":{"type":"integer","minimum":1,"maximum":50,"default":10,"description":"How many matched tenders to return (1-50)."}},"additionalProperties":false},"example":{"supplier_id":392}}}},"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/ComprasalSvTendersForSupplierResponse"}}}},"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"}}}}}}},"/sv/hacienda-sv/dte/v1":{"post":{"operationId":"hacienda_sv_dte","summary":"El Salvador Hacienda DTE Verification","description":"Verify an electronic tax document (DTE) issued in El Salvador against the Ministerio de Hacienda by its código de generación, or the link printed in its QR code: whether Hacienda holds it, its status (`received`, `received_with_notes`, `adjusted`, `rejected`, `invalidated`), the sello de recepción, the número de control, its type, issue date and time, when Hacienda processed it, the totals and taxes, and every line. Read live from Hacienda on each call. The receptor's identity is never returned.","tags":["El Salvador","Ministerio de Hacienda de El Salvador"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/facturacion-electronica"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["generation_code"],"properties":{"generation_code":{"type":"string","minLength":36,"maxLength":500,"description":"The document's código de generación, a UUID such as `3F2504E0-4F89-41D3-9A0C-0305E82C3301`, or the link printed in its QR code."},"environment":{"type":"string","enum":["production","test"],"default":"production","description":"`production` (the default) for real documents, `test` for documents issued in Hacienda's test environment."}},"additionalProperties":false},"example":{"generation_code":"3F2504E0-4F89-41D3-9A0C-0305E82C3301"}}}},"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/HaciendaSvDteResponse"}}}},"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"}}}}}}},"/sv/cnr-sv/filings-search/v1":{"post":{"operationId":"cnr_sv_filings_search","summary":"El Salvador Company Filings Search","description":"Search the company filings El Salvador's Registro de Comercio (Centro Nacional de Registros) publishes in its bimonthly bulletin: commercial registrations (matrículas), transfers and cancellations, deposited balance sheets, incorporations, amendments, liquidations, dissolutions, transformations and mergers, from January 2024 on. `query` matches the legal name, abbreviation and trade name by spelling. Filter by `filing_type`, `department` and the inscription date (`from_date`/`to_date`). Each filing carries what its extract says (entries, address, activities, assets, capital, the balance's amount) and Croma's copy of the extract. Companies only. 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":["El Salvador","Centro Nacional de Registros (CNR)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/cnr"},"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 company name, matched by spelling against the legal name, the abbreviation and the trade name, so a typo or a missing accent still finds it."},"filing_type":{"type":"string","enum":["","matricula_registration","matricula_transfer","matricula_cancellation","opening_balance","balance","liquidation_balance","incorporation","amendment","liquidation","dissolution","transformation","merger"],"default":"","description":"Optional kind of filing: `matricula_registration`, `matricula_transfer`, `matricula_cancellation` (a company's commercial registration, its transfer and its cancellation), `opening_balance`, `balance`, `liquidation_balance` (deposited balance sheets), `incorporation`, `amendment`, `liquidation`, `dissolution`, `transformation` or `merger`."},"department":{"type":"string","enum":["","Ahuachapán","Cabañas","Chalatenango","Cuscatlán","La Libertad","La Paz","La Unión","Morazán","San Miguel","San Salvador","San Vicente","Santa Ana","Sonsonate","Usulután"],"default":"","description":"Optional department of El Salvador, e.g. `La Libertad`, `Santa Ana`, `Usulután`."},"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":"Zonte","filing_type":"matricula_registration"}}}},"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/CnrSvFilingsSearchResponse"}}}},"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"}}}}}}},"/sv/cnr-sv/company/v1":{"post":{"operationId":"cnr_sv_company","summary":"El Salvador Company Filings by File Number","description":"Retrieve every filing of one company at El Salvador's Registro de Comercio by its file number (N° de expediente, e.g. `2026136080`, as `file_number` in a search result): its commercial registration and any transfer or cancellation, plus the balance sheets and corporate acts the bulletin publishes under its legal name, newest first, with `cancelled` saying whether the registration was cancelled.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["El Salvador","Centro Nacional de Registros (CNR)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/el-salvador/cnr"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_number"],"properties":{"file_number":{"type":"string","minLength":1,"maxLength":20,"description":"The company's registration file number (N° de expediente) at the Registro de Comercio, e.g. `2026136080`, as `file_number` in a search result."}},"additionalProperties":false},"example":{"file_number":"2026136080"}}}},"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/CnrSvCompanyResponse"}}}},"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"}}}}}}},"/bo/tcp-bo/rulings-search/v1":{"post":{"operationId":"tcp_bo_rulings_search","summary":"Tribunal Constitucional Plurinacional de Bolivia Rulings Search","description":"Search the jurisprudencia of Bolivia's Tribunal Constitucional Plurinacional and its predecessor: every sentencia, auto, declaración and vote since 1999. Free text matches the resolution number, the case numbers, the chamber, the action and the full text. Filter by `type`, `chamber`, `proceeding_type` (the constitutional action), `reporting_judge`, `department`, `registration_number` (the resolution number), `case_number`, `year` and the ruling date (`from_date`/`to_date`). Each result carries the original document, kept by Croma, and a link to the resolution's page 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":["Bolivia","Tribunal Constitucional Plurinacional de Bolivia"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/bolivia/tcp"},"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 resolution number, the case number, the chamber, the action and the full text."},"type":{"type":"string","enum":["","sentencia","auto","declaracion","voto_disidente","voto_aclaratorio","decreto"],"default":"","description":"Optional kind of resolution: `sentencia` (SC, SCP), `auto` (AC, ACP, RCA, ECA...), `declaracion` (DCP), `voto_disidente`, `voto_aclaratorio` or `decreto`."},"chamber":{"type":"string","maxLength":120,"default":"","description":"Optional chamber as `chamber` names it, e.g. `Sala Primera`, `Sala Plena` or `Comisión de Admisión`, matched from the start. Case and accents are ignored."},"proceeding_type":{"type":"string","maxLength":160,"default":"","description":"Optional constitutional action as `proceeding_type` names it, e.g. `Acción de amparo constitucional`, `Acción de libertad`, `Acción de inconstitucionalidad concreta`, matched from the start. Case and accents are ignored."},"registration_number":{"type":"string","maxLength":80,"default":"","description":"Optional resolution number as the court prints it, e.g. `0050/2024-S2` or `0437/2013`. Returns every resolution of that number, including the votes attached to it. Case, spaces and punctuation are ignored."},"case_number":{"type":"string","maxLength":80,"default":"","description":"Optional case file number (expediente) as the court prints it, e.g. `60836-2024-122-AL`. Case, spaces and punctuation are ignored."},"reporting_judge":{"type":"string","maxLength":160,"default":"","description":"Optional reporting justice (magistrado relator) as `reporting_judge` names them, matched from the start of the name. Case and accents are ignored."},"department":{"type":"string","maxLength":60,"default":"","description":"Optional department the case came from, e.g. `La Paz`, `Santa Cruz`, `Cochabamba`, matched from the start. Case and accents are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the resolution. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"debido proceso","type":"sentencia","proceeding_type":"Acción de amparo"}}}},"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/TcpBoRulingsSearchResponse"}}}},"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"}}}}}}},"/bo/tcp-bo/ruling/v1":{"post":{"operationId":"tcp_bo_ruling","summary":"Tribunal Constitucional Plurinacional de Bolivia Ruling","description":"Retrieve one resolution of Bolivia's Tribunal Constitucional Plurinacional by its `id` from a search result (e.g. `202697`) or its `official_url`: its full text, the resolution number, the chamber, the reporting justice, the constitutional action, the department, the case files, the original document as the court published it, and the link to its page at the court. 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":["Bolivia","Tribunal Constitucional Plurinacional de Bolivia"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/bolivia/tcp"},"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":600,"description":"The resolution's `id` from a search result. Its `official_url` works too."},"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":"202697"}}}},"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/TcpBoRulingResponse"}}}},"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"}}}}}}},"/bo/tsj-bo/rulings-search/v1":{"post":{"operationId":"tsj_bo_rulings_search","summary":"Tribunal Supremo de Justicia de Bolivia Rulings Search","description":"Search the jurisprudencia of Bolivia's Tribunal Supremo de Justicia: every auto supremo, sentencia and resolución its chambers have published since 2001. Free text matches the resolution and case numbers, the chamber, the area of law, the outcome, the court's jurisprudence notes and the full text. Filter by `chamber`, `type`, `subject`, `outcome`, `registration_number`, `case_number`, `reporting_judge`, `department`, `year` and the ruling date (`from_date`/`to_date`). Each result carries the document, kept by Croma, and a link to the resolution 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":["Bolivia","Tribunal Supremo de Justicia de Bolivia"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/bolivia/tsj"},"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 resolution number, the case number, the chamber, the jurisprudence notes (descriptor, restrictor, ratio decidendi) and the full text."},"chamber":{"type":"string","maxLength":120,"default":"","description":"Optional chamber as `chamber` names it, e.g. `Sala Civil`, `Sala Penal`, `Sala Plena` or `Sala Contenciosa`, matched from the start. Case and accents are ignored."},"type":{"type":"string","enum":["","auto_supremo","sentencia","resolucion"],"default":"","description":"Optional kind of resolution: `auto_supremo`, `sentencia` or `resolucion`."},"subject":{"type":"string","maxLength":120,"default":"","description":"Optional area of law as `subject` names it, e.g. `Civil`, `Penal`, `Familia`, `Social`, `Agrario`, matched from the start. Case and accents are ignored."},"outcome":{"type":"string","maxLength":120,"default":"","description":"Optional outcome as `outcome` names it, e.g. `Infundado`, `Casa`, `Improcedente`, `Anula`, matched from the start. Case and accents are ignored."},"registration_number":{"type":"string","maxLength":80,"default":"","description":"Optional resolution number as the court prints it, e.g. `AS/0001/2013` or `SE/0001/2023`. Each chamber numbers its own resolutions, so a number can return several; add `chamber` to narrow it. Case, spaces and punctuation are ignored."},"case_number":{"type":"string","maxLength":80,"default":"","description":"Optional case file number (expediente) as the court prints it. Case, spaces and punctuation are ignored."},"reporting_judge":{"type":"string","maxLength":160,"default":"","description":"Optional reporting justice (magistrado relator) as `reporting_judge` names them, matched from the start of the name. Case and accents are ignored."},"department":{"type":"string","maxLength":60,"default":"","description":"Optional department the case came from, e.g. `La Paz`, `Santa Cruz`, `Chuquisaca`, matched from the start. Case and accents are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the resolution. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"nulidad de contrato","chamber":"Sala Civil","type":"auto_supremo"}}}},"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/TsjBoRulingsSearchResponse"}}}},"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"}}}}}}},"/bo/tsj-bo/ruling/v1":{"post":{"operationId":"tsj_bo_ruling","summary":"Tribunal Supremo de Justicia de Bolivia Ruling","description":"Retrieve one resolution of Bolivia's Tribunal Supremo de Justicia by its `id` from a search result (e.g. `11378`) or its `official_url`: its full text, the resolution and case numbers, the chamber, the kind of resolution and how it was resolved, the area of law, the reporting justice, the court's jurisprudence notes, the document as the court published it, and a link to the resolution 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":["Bolivia","Tribunal Supremo de Justicia de Bolivia"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/bolivia/tsj"},"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":600,"description":"The resolution's `id` from a search result. Its `official_url` works too."},"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":"11378"}}}},"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/TsjBoRulingResponse"}}}},"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"}}}}}}},"/jp/nta/companies-search/v1":{"post":{"operationId":"nta_companies_search","summary":"National Tax Agency Companies Search","description":"Search Japan's corporate number register (法人番号), about six million companies and other legal entities, by any part of the name in kanji, kana or English, narrowed by `prefecture` (name or JIS code), `city`, `entity_type` (the legal form), `status` (`active` or `closed`), `change_type` (the last change the register recorded) and the date of that change (`from_date`/`to_date`). Each result carries the corporate number, the names, the legal form, the head office, the registration status with any closure, and the last change. Served by Croma from its copy of the register (`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":["Japan","National Tax Agency of Japan"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/japan/nta"},"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 company name, or any part of it, as the register spells it: in Japanese (`トヨタ自動車`, `トヨタ`), in its reading (`トヨタジドウシャ`) or in English where the company registered one (`Toyota`). Two or more characters; every word must appear."},"prefecture":{"type":"string","maxLength":40,"default":"","description":"Optional prefecture of the head office, as the register prints it (`東京都`, `大阪府`, `北海道`, `沖縄県`) or as its two-digit JIS code (`13` for Tokyo)."},"city":{"type":"string","maxLength":60,"default":"","description":"Optional city, ward, town or village of the head office as the register prints it, e.g. `千代田区`, `横浜市西区`, `豊田市`, matched from the start."},"entity_type":{"type":"string","enum":["","national_government","local_government","kabushiki_kaisha","yugen_kaisha","gomei_kaisha","goshi_kaisha","godo_kaisha","other_registered","foreign_company","other"],"default":"","description":"Optional legal form: `kabushiki_kaisha` (株式会社), `yugen_kaisha` (有限会社), `gomei_kaisha` (合名会社), `goshi_kaisha` (合資会社), `godo_kaisha` (合同会社), `other_registered` (other registered entities such as 一般社団法人, 医療法人, 学校法人), `foreign_company` (外国会社), `national_government`, `local_government` or `other`."},"status":{"type":"string","enum":["","active","closed"],"default":"","description":"Optional registration status: `active` (the register record is open) or `closed` (closed after liquidation, a merger or by the registrar)."},"change_type":{"type":"string","enum":["","new","name_change","address_change","foreign_address_change","closed","revived","merger","merger_annulled","trade_name_erased","deleted"],"default":"","description":"Optional kind of the last change the register recorded for the company: `new` (number assigned), `name_change`, `address_change`, `foreign_address_change`, `closed`, `revived`, `merger` (absorbed into another company), `merger_annulled`, `trade_name_erased` or `deleted`. With `from_date` and `to_date`, this finds for example every company registered in a period."},"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":"トヨタ自動車","prefecture":"愛知県"}}}},"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/NtaCompaniesSearchResponse"}}}},"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"}}}}}}},"/jp/nta/company/v1":{"post":{"operationId":"nta_company","summary":"National Tax Agency Company","description":"Retrieve one Japanese company or other legal entity by its 13-digit corporate number (法人番号), e.g. `1180301018771`: the registered name with its reading and English form, the legal form, the head office, the registration status with any closure and successor, and the last change the register recorded. Served by Croma from its copy of the register (`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":["Japan","National Tax Agency of Japan"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/japan/nta"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["corporate_number"],"properties":{"corporate_number":{"type":"string","minLength":13,"maxLength":20,"pattern":"^\\d{13}$","description":"The company's 13-digit corporate number (法人番号), e.g. `1180301018771`. The first digit checks the other twelve."}},"additionalProperties":false},"example":{"corporate_number":"1180301018771"}}}},"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/NtaCompanyResponse"}}}},"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"}}}}}}},"/jp/courts-jp/rulings-search/v1":{"post":{"operationId":"courts_jp_rulings_search","summary":"Courts of Japan Rulings Search","description":"Search the case law the courts of Japan publish: about 68,000 rulings of the Supreme Court, the high courts and the lower courts since 1947, across the administrative, labour and intellectual property collections too. Free text in Japanese matches the case name, the court's summary, the statutes cited and the full text. Filter by `collection`, `court` (matched from the start of its name), `case_number`, `year` and the ruling date (`from_date`/`to_date`). Each result carries the court's document, kept by Croma, and a link to the ruling's page at the courts. 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":["Japan","Courts of Japan"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/japan/courts"},"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, in Japanese, matched against the case name, the court's summary (判示事項, 裁判要旨), the statutes cited and the text of the ruling: `解雇権濫用`, `過払金 返還`. Two or more characters; every word must appear."},"collection":{"type":"string","enum":["","supreme","high","lower","administrative","labor","ip","ip_high"],"default":"","description":"Optional collection: `supreme` (最高裁判所判例集), `high` (高等裁判所判例集), `lower` (下級裁判所裁判例速報), `administrative` (行政事件裁判例集), `labor` (労働事件裁判例集), `ip` (知的財産裁判例集) or `ip_high` (知的財産高等裁判所). A ruling can sit in more than one."},"court":{"type":"string","maxLength":80,"default":"","description":"Optional court as `court` names it, e.g. `最高裁判所第一小法廷`, `東京高等裁判所`, `大阪地方裁判所`, matched from the start, so `最高裁判所` finds every bench of the Supreme Court."},"case_number":{"type":"string","maxLength":60,"default":"","description":"Optional case number as the court prints it, e.g. `平成21(オ)257` or `令和7(あ)868`. Spaces and the width of the characters are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the ruling was handed down (Gregorian). 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"解雇権濫用","collection":"supreme"}}}},"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/CourtsJpRulingsSearchResponse"}}}},"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"}}}}}}},"/jp/courts-jp/ruling/v1":{"post":{"operationId":"courts_jp_ruling","summary":"Courts of Japan Ruling","description":"Retrieve one ruling of the courts of Japan by its `id` from a search result (e.g. `93117`) or its `official_url`: its full text, the case number and name, the court, the date, the outcome, the court's summary and the statutes cited, the court's document as published, and the link to its page at the courts. 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":["Japan","Courts of Japan"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/japan/courts"},"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":600,"description":"The ruling's `id` from a search result, e.g. `93117`. Its `official_url` or `source_document_url` works too."},"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":"93117"}}}},"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/CourtsJpRulingResponse"}}}},"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"}}}}}}},"/cl/sii/oficios-search/v1":{"post":{"operationId":"sii_oficios_search","summary":"SII Oficios Search","description":"Search the oficios (administrative rulings, jurisprudencia administrativa) of Chile's Servicio de Impuestos Internos from 1994 on: the answers SII gives to taxpayers' questions on income tax (`renta`), VAT (`iva`) and every other norm (`otras`). Free text matches the norms cited, SII's summary and the full text. Filter by `subject`, `number`, `year` and the oficio's date (`from_date`/`to_date`). Each result carries Croma's copy of the oficio's documents and the links to them on SII'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":["Chile","Servicio de Impuestos Internos (SII)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/sii"},"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 summary, the cited norms and the full text."},"subject":{"type":"string","enum":["any","renta","iva","otras"],"default":"any","description":"The tax the oficio answers about: `renta` (income tax), `iva` (VAT, ventas y servicios), `otras` (every other norm), or `any`."},"number":{"type":"string","maxLength":20,"default":"","description":"Optional document number, e.g. `2815`. Dots and leading zeros are ignored. Numbers restart every year, so combine it with `year`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the document belongs to. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"incobrables","subject":"renta","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/SiiOficiosSearchResponse"}}}},"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"}}}}}}},"/cl/sii/oficio/v1":{"post":{"operationId":"sii_oficio","summary":"SII Oficio","description":"Retrieve one oficio of Chile's Servicio de Impuestos Internos by its `id` from a search result (e.g. `3109`): its full text, number, date, tax, the norms it interprets, SII's summary, Croma's copy of its documents and the links to them on SII'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":["Chile","Servicio de Impuestos Internos (SII)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/sii"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["oficio_id"],"properties":{"oficio_id":{"type":"string","minLength":1,"maxLength":120,"description":"The oficio's `id` from a search result, e.g. `3109` or `renta-2015-ja3298`."},"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":{"oficio_id":"3109"}}}},"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/SiiOficioResponse"}}}},"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"}}}}}}},"/cl/sii/circulars-search/v1":{"post":{"operationId":"sii_circulars_search","summary":"SII Circulars Search","description":"Search the circulares of Chile's Servicio de Impuestos Internos from 1975 on: its instructions on how the tax laws apply, from the monthly tables of readjustments and the Unidad de Fomento to the rules implementing each tax reform. Free text matches the title, SII's summary and the full text. Filter by `number`, `year` and the circular's date (`from_date`/`to_date`). Each result carries Croma's copy of the circular's documents. 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":["Chile","Servicio de Impuestos Internos (SII)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/sii"},"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 summary, the cited norms and the full text."},"number":{"type":"string","maxLength":20,"default":"","description":"Optional document number, e.g. `2815`. Dots and leading zeros are ignored. Numbers restart every year, so combine it with `year`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the document belongs to. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"unidad de fomento","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/SiiCircularsSearchResponse"}}}},"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"}}}}}}},"/cl/sii/circular/v1":{"post":{"operationId":"sii_circular","summary":"SII Circular","description":"Retrieve one circular of Chile's Servicio de Impuestos Internos by its `id` (its year and number, e.g. `2026-41`): its full text, title, date, SII's summary, the issuing office, Croma's copy of its documents and the links to them on SII's own site. The text comes back a character range at a time (`offset`, `limit`).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Chile","Servicio de Impuestos Internos (SII)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/sii"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["circular_id"],"properties":{"circular_id":{"type":"string","minLength":1,"maxLength":40,"description":"The circular's `id` from a search result: its year and number, e.g. `2026-41`."},"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":{"circular_id":"2026-41"}}}},"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/SiiCircularResponse"}}}},"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"}}}}}}},"/cl/sii/resolutions-search/v1":{"post":{"operationId":"sii_resolutions_search","summary":"SII Resolutions Search","description":"Search the resoluciones of Chile's Servicio de Impuestos Internos from 1975 on, mostly resoluciones exentas that set procedures, forms, deadlines and electronic-invoicing rules. Free text matches the title, SII's summary and the full text. Filter by `number`, `year` and the resolution's date (`from_date`/`to_date`). Each result carries Croma's copy of the resolution's documents. 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":["Chile","Servicio de Impuestos Internos (SII)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/sii"},"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 summary, the cited norms and the full text."},"number":{"type":"string","maxLength":20,"default":"","description":"Optional document number, e.g. `2815`. Dots and leading zeros are ignored. Numbers restart every year, so combine it with `year`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the document belongs to. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"factura electrónica","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/SiiResolutionsSearchResponse"}}}},"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"}}}}}}},"/cl/sii/resolution/v1":{"post":{"operationId":"sii_resolution","summary":"SII Resolution","description":"Retrieve one resolución of Chile's Servicio de Impuestos Internos by its `id` (its year and number, e.g. `2026-148`): its full text, title, date, SII's summary, the issuing office, Croma's copy of its documents and the links to them on SII's own site. The text comes back a character range at a time (`offset`, `limit`).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Chile","Servicio de Impuestos Internos (SII)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/sii"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resolution_id"],"properties":{"resolution_id":{"type":"string","minLength":1,"maxLength":40,"description":"The resolution's `id` from a search result: its year and number, e.g. `2026-148`."},"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":{"resolution_id":"2026-148"}}}},"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/SiiResolutionResponse"}}}},"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"}}}}}}},"/cl/sii/rulings-search/v1":{"post":{"operationId":"sii_rulings_search","summary":"SII Court Rulings Search","description":"Search SII's compilation of court rulings on tax matters, about 3,600 since 2008: the Corte Suprema, the Cortes de Apelaciones, the Tribunales Tributarios y Aduaneros, the Tribunal Constitucional and others. Free text matches the case number, the parties, SII's headnote and extract and the ruling's text. Filter by `court`, `registration_number` (rol or RIT), `year` and the ruling's 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":["Chile","Servicio de Impuestos Internos (SII)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/sii"},"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 summary, the cited norms and the full text."},"court":{"type":"string","maxLength":160,"default":"","description":"Optional court as `court` names it, e.g. `Corte Suprema`, `Corte de Apelaciones de Santiago`, `Primer Tribunal Tributario y Aduanero`, matched from the start. Case and accents are ignored."},"registration_number":{"type":"string","maxLength":60,"default":"","description":"Optional case number (ROL or RIT) as the court gives it, e.g. `5501-12` or `GR-15-00002-2017`. Spaces and punctuation are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the document belongs to. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"prescripción","court":"Corte Suprema"}}}},"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/SiiRulingsSearchResponse"}}}},"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"}}}}}}},"/cl/sii/ruling/v1":{"post":{"operationId":"sii_ruling","summary":"SII Court Ruling","description":"Retrieve one court ruling from SII's compilation by its `id` from a search result (e.g. `3638`): the ruling's text as SII publishes it, the court, case number, date, parties, SII's headnote and extract, the norms and articles it applies, and Croma's copy of the text. The text comes back a character range at a time (`offset`, `limit`).\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Chile","Servicio de Impuestos Internos (SII)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/sii"},"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":"^\\d{1,10}$","description":"The ruling's `id` from a search result, e.g. `3638`."},"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":"3638"}}}},"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/SiiRulingResponse"}}}},"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"}}}}}}},"/cl/sii-mapas/property/v1":{"post":{"operationId":"sii_mapas_property","summary":"SII Property by Rol","description":"Retrieve one Chilean property's public record from SII's property map by its rol (`comuna`, `block` = manzana, `lot` = predio): the avalúo fiscal for the current half-year (total, afecto and exento, in pesos), address, destino, land and built surface, latitude and longitude, the valuation period and process, and the homogeneous area the land is valued in. `comuna` is SII's own code (Santiago `13101`, Providencia `15103`, not INE's) or the comuna's name. The first ask of a rol reads SII; later asks within 30 days answer from Croma's stored answer (`served_from`). An unknown rol returns `found: false`.\n\n**Lookup endpoint**: answers from Croma's copy when it holds a recent answer for the key, otherwise reads the source and keeps the answer; carries `checked_at` and `served_from`.","x-served-from":"lookup","tags":["Chile","SII Mapas"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/sii-mapas"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["comuna","block","lot"],"properties":{"comuna":{"type":"string","minLength":2,"maxLength":60,"description":"The comuna, as SII's own comuna code (e.g. `13101` Santiago, `15103` Providencia; not INE's code) or its name (`Providencia`). Case and accents are ignored in a name."},"block":{"type":"integer","minimum":1,"maximum":99999,"description":"The rol's first number, the manzana (block), e.g. `18` in rol `18-1`."},"lot":{"type":"integer","minimum":1,"maximum":99999,"description":"The rol's second number, the predio (lot), e.g. `1` in rol `18-1`."}},"additionalProperties":false},"example":{"comuna":"13101","block":18,"lot":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/SiiMapasPropertyResponse"}}}},"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"}}}}}}},"/cl/contraloria-cl/dictamenes-search/v1":{"post":{"operationId":"contraloria_cl_dictamenes_search","summary":"Contraloría Chile Dictámenes Search","description":"Search the dictámenes of Chile's Contraloría General de la República: about 158,000 administrative-law opinions since 1949. Free text matches the number, subject, descriptors, legal sources and full text. Filter by `number`, `year`, the issue date (`from_date`/`to_date`), `criterion` (sets or applies jurisprudence), `status` (e.g. `reconsidered`) and `references` (the dictámenes that act on a given one). Each result carries its status flags, the earlier dictámenes it acts on and links to its page and PDF at the Contraloría. 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":["Chile","Contraloría General de la República (Chile)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/contraloria"},"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 matched against the dictamen's number, subject, descriptors, legal sources and full text, e.g. `pensión de retiro` or `ley 18.834 feriado`. Every word must appear; plural and singular match each other."},"number":{"type":"string","maxLength":20,"default":"","description":"Optional dictamen number, with its letter prefix when it has one, e.g. `428`, `E152884`, `OF197180`. Leading zeros, spaces and dots are ignored. Numbers restart every year: add `year` to name one dictamen."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the dictamen. 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."},"criterion":{"type":"string","enum":["","generates","applies"],"default":"","description":"Optional criterion: `generates` for dictámenes that set new jurisprudence (Genera Jurisprudencia), `applies` for those that apply existing jurisprudence (Aplica Jurisprudencia)."},"status":{"type":"string","enum":["","new","applied","reconsidered","partially_reconsidered","clarified","altered","confirmed","complemented","reactivated"],"default":"","description":"Optional status flag the dictamen carries today: `new`, `applied`, `reconsidered`, `partially_reconsidered`, `clarified`, `altered`, `confirmed`, `complemented` or `reactivated`. `reconsidered` finds dictámenes whose criterion a later one set aside."},"references":{"type":"string","maxLength":300,"default":"","description":"Optional dictamen `id`, e.g. `022127N09`: only the dictámenes that act on it (apply, reconsider, clarify, complement...)."},"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":"pensión de retiro","criterion":"generates"}}}},"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/ContraloriaClDictamenesSearchResponse"}}}},"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"}}}}}}},"/cl/contraloria-cl/dictamen/v1":{"post":{"operationId":"contraloria_cl_dictamen","summary":"Contraloría Chile Dictamen","description":"Retrieve one dictamen of Chile's Contraloría General de la República by its `id` from a search result (e.g. `E152884N21`), its `official_url`, or its number and year (`E152884/2021`): its full text, subject, descriptors, legal sources, criterion, status flags, the earlier dictámenes it acts on and the later ones that act on it. 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":["Chile","Contraloría General de la República (Chile)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/contraloria"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dictamen_id"],"properties":{"dictamen_id":{"type":"string","minLength":1,"maxLength":300,"description":"The dictamen's `id` from a search result, e.g. `E152884N21`. Its `official_url`, or its number and year as the Contraloría cites it (`E152884/2021`), work too."},"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":{"dictamen_id":"E152884N21"}}}},"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/ContraloriaClDictamenResponse"}}}},"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"}}}}}}},"/cl/cmf/regulations-search/v1":{"post":{"operationId":"cmf_regulations_search","summary":"CMF Regulations Search","description":"Search Chile's financial regulation: the CMF's Normas de Carácter General, Circulares and Oficios Circulares since 1979 for every market, and the SBIF's banking circulars from 1956 to 2019. Free text in Spanish matches the title, the SBIF's label and the issuing resolution. Filter by `collection`, `type`, `number`, `year`, `market`, the issue date (`from_date`/`to_date`) and `related_to` (every norm that amends or repeals a given one, or that it amends or repeals). Each result carries its original documents. 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":["Chile","CMF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/cmf"},"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 in Spanish, matched against the title, the description and the resolution of each record, e.g. `deuda consolidada` or `liquidez`. Every word must appear; accents and plurals are folded."},"collection":{"type":"string","enum":["","cmf","sbif"],"default":"","description":"Optional collection: `cmf` for the general regulation the CMF (and before it the SVS) issues for every market, `sbif` for the banking regulation the former Superintendencia de Bancos e Instituciones Financieras issued up to 2019."},"type":{"type":"string","maxLength":40,"default":"","description":"Optional kind of norm as `type` names it: `NCG` (Norma de Carácter General), `CIR` (Circular) or `OFC` (Oficio Circular) for the CMF; `Circular` or `Carta Circular` for the SBIF. Case and accents are ignored."},"number":{"type":"string","maxLength":20,"default":"","description":"Optional number of the norm, e.g. `577` or `3644`. Numbers repeat across years and kinds, so combine it with `type` and `year`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the record was issued. 0 searches every year."},"market":{"type":"string","enum":["","banking","securities","insurance","other"],"default":"","description":"Optional market the norm applies to: `banking`, `securities`, `insurance` or `other`. A norm can apply to several."},"related_to":{"type":"string","maxLength":40,"default":"","description":"Optional `id` of a norm, e.g. `ncg-30-1989`: returns every norm that amends or repeals it, or that it amends or repeals."},"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":"deuda consolidada","type":"NCG"}}}},"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/CmfRegulationsSearchResponse"}}}},"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"}}}}}}},"/cl/cmf/regulation/v1":{"post":{"operationId":"cmf_regulation","summary":"CMF Regulation","description":"Retrieve one Chilean financial norm by its `id` from a search result (e.g. `ncg-577-2026`, `sbif-17825`): its title, kind, number and date, the markets it applies to, its resolution, the norms it amends or repeals and those that amend or repeal it, its attachments and its original document.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Chile","CMF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/cmf"},"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":1,"maxLength":60,"description":"The norm's `id` from a search result: `<type>-<number>-<year>` for the CMF, e.g. `ncg-577-2026`, or `sbif-<number>` for the SBIF archive, e.g. `sbif-17825`. `NCG 577 2026` works too."}},"additionalProperties":false},"example":{"regulation_id":"ncg-556-2025"}}}},"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/CmfRegulationResponse"}}}},"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"}}}}}}},"/cl/cmf/opinions-search/v1":{"post":{"operationId":"cmf_opinions_search","summary":"CMF Rulings Search","description":"Search the rulings (dictámenes) Chile's Comisión para el Mercado Financiero has issued since 2011 in answer to consultations. Free text in Spanish matches the CMF's summary of the question and the answer. Filter by `effects` (`particulares` or `generales`), `letter_number`, `year` and the issue date (`from_date`/`to_date`). Each result carries the letter 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":["Chile","CMF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/cmf"},"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 in Spanish, matched against the title, the description and the resolution of each record, e.g. `deuda consolidada` or `liquidez`. Every word must appear; accents and plurals are folded."},"effects":{"type":"string","enum":["","particulares","generales"],"default":"","description":"Optional effects as the CMF classifies the ruling: `particulares` (it answers one party's consultation) or `generales` (it binds everyone)."},"letter_number":{"type":"string","maxLength":20,"default":"","description":"Optional number of the official letter (oficio ordinario) that carries the ruling, e.g. `248490`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the record was issued. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"fintec","year":2025}}}},"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/CmfOpinionsSearchResponse"}}}},"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"}}}}}}},"/cl/cmf/opinion/v1":{"post":{"operationId":"cmf_opinion","summary":"CMF Ruling","description":"Retrieve one ruling (dictamen) of Chile's Comisión para el Mercado Financiero by its `id` (its document number, e.g. `2025120910460`): the letter's number and dates, its effects, the CMF's summary and the letter itself.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Chile","CMF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/cmf"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["opinion_id"],"properties":{"opinion_id":{"type":"string","pattern":"^\\d{10,16}$","description":"The ruling's `id` from a search result: its 13-digit document number, e.g. `2025120910460`."}},"additionalProperties":false},"example":{"opinion_id":"2025120910460"}}}},"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/CmfOpinionResponse"}}}},"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"}}}}}}},"/cl/cmf/sanctions-search/v1":{"post":{"operationId":"cmf_sanctions_search","summary":"CMF Sanctions Search","description":"Search the sanction resolutions Chile's Comisión para el Mercado Financiero (and the Superintendencia de Valores y Seguros before it) has published since 2002. Free text in Spanish matches what the resolution does and the party it names, so a company's or a person's name finds its sanctions. Filter by `kind` (`sanction`, `appeal`, `other`), `resolution_number`, `year` and the issue date (`from_date`/`to_date`). Each result carries the resolution 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":["Chile","CMF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/cmf"},"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 in Spanish, matched against the title, the description and the resolution of each record, e.g. `deuda consolidada` or `liquidez`. Every word must appear; accents and plurals are folded."},"kind":{"type":"string","enum":["","sanction","appeal","other"],"default":"","description":"Optional kind of resolution: `sanction` (it imposes a sanction), `appeal` (it decides an appeal against one) or `other`."},"resolution_number":{"type":"string","maxLength":20,"default":"","description":"Optional number of the resolution, e.g. `11220`. Numbering restarts every year, so combine it with `year`."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the record was issued. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"corredores de bolsa","kind":"sanction"}}}},"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/CmfSanctionsSearchResponse"}}}},"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"}}}}}}},"/cl/cmf/sanction/v1":{"post":{"operationId":"cmf_sanction","summary":"CMF Sanction","description":"Retrieve one sanction resolution of Chile's Comisión para el Mercado Financiero by its `id` (its document number, e.g. `2026090593551`): its number and date, what it does and the party it names, and the resolution itself.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Chile","CMF"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/cmf"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sanction_id"],"properties":{"sanction_id":{"type":"string","pattern":"^\\d{10,16}$","description":"The resolution's `id` from a search result: its 13-digit document number, e.g. `2026090593551`."}},"additionalProperties":false},"example":{"sanction_id":"2026090593551"}}}},"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/CmfSanctionResponse"}}}},"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"}}}}}}},"/cl/pjud/supreme-court-rulings-search/v1":{"post":{"operationId":"pjud_supreme_court_rulings_search","summary":"Poder Judicial Corte Suprema Rulings Search","description":"Search the rulings of Chile's Corte Suprema: about 310,000 since 2005. Free text matches the case number, case title, matters, descriptors and full text. Filter by `chamber`, `case_number` (rol), `year`, `matter` 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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 matched against the ruling's case number, case title, matters, descriptors and full text, e.g. `prescripción adquisitiva` or `despido injustificado`. Every word must appear; plural and singular match each other."},"case_number":{"type":"string","maxLength":30,"default":"","description":"Optional case number (rol) with its year, as the court writes it, e.g. `13194-2026`, or with its letter prefix in a first-instance court, e.g. `C-4513-2026`. Dots and spaces are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the case (the year in its rol, which can be earlier than the ruling). 0 searches every year."},"matter":{"type":"string","maxLength":200,"default":"","description":"Optional matter, exactly as it appears in a result's `matters`, e.g. `PATERNIDAD, RECONOCIMIENTO DE` or `HURTO SIMPLE POR UN VALOR DE MEDIA A MENOS DE 4 UTM.`."},"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)."},"chamber":{"type":"string","maxLength":80,"default":"","description":"Optional chamber (sala) of the Corte Suprema, as the court names it, e.g. `PRIMERA, CIVIL`, `SEGUNDA, PENAL`, `TERCERA, CONSTITUCIONAL`, `CUARTA, LABORAL`."}},"additionalProperties":false},"example":{"query":"propiedad industrial","from_date":"2026-09-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/PjudSupremeCourtRulingsSearchResponse"}}}},"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"}}}}}}},"/cl/pjud/supreme-court-ruling/v1":{"post":{"operationId":"pjud_supreme_court_ruling","summary":"Poder Judicial Corte Suprema Ruling","description":"Retrieve one ruling of the Corte Suprema by its `id` from a search result: its full text (anonymized where the court anonymizes it), case number, court, parties line, matters, judges, outcome, descriptors and cited provisions, and Croma's copy of its anonymized PDF where there is one. 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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":"^\\d{1,12}$","description":"The ruling's `id` from a search result, e.g. `8283326`."},"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":"8283326"}}}},"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/PjudSupremeCourtRulingResponse"}}}},"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"}}}}}}},"/cl/pjud/appeals-court-rulings-search/v1":{"post":{"operationId":"pjud_appeals_court_rulings_search","summary":"Poder Judicial Cortes de Apelaciones Rulings Search","description":"Search the rulings of Chile's 17 Cortes de Apelaciones: about 2 million since 2000, filterable by court. Free text matches the case number, case title, matters, descriptors and full text. Filter by `court`, `chamber`, `case_number` (rol), `year`, `matter` 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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 matched against the ruling's case number, case title, matters, descriptors and full text, e.g. `prescripción adquisitiva` or `despido injustificado`. Every word must appear; plural and singular match each other."},"case_number":{"type":"string","maxLength":30,"default":"","description":"Optional case number (rol) with its year, as the court writes it, e.g. `13194-2026`, or with its letter prefix in a first-instance court, e.g. `C-4513-2026`. Dots and spaces are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the case (the year in its rol, which can be earlier than the ruling). 0 searches every year."},"matter":{"type":"string","maxLength":200,"default":"","description":"Optional matter, exactly as it appears in a result's `matters`, e.g. `PATERNIDAD, RECONOCIMIENTO DE` or `HURTO SIMPLE POR UN VALOR DE MEDIA A MENOS DE 4 UTM.`."},"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)."},"court":{"type":"string","maxLength":80,"default":"","description":"Optional Corte de Apelaciones, by its name, e.g. `C.A. de Valdivia` or just `Valdivia`; `Santiago`, `San Miguel`, `Concepción`, `Rancagua` and the other 13 work the same way."},"chamber":{"type":"string","maxLength":80,"default":"","description":"Optional chamber (sala) of the Corte Suprema, as the court names it, e.g. `PRIMERA, CIVIL`, `SEGUNDA, PENAL`, `TERCERA, CONSTITUCIONAL`, `CUARTA, LABORAL`."}},"additionalProperties":false},"example":{"court":"Valdivia","from_date":"2026-09-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/PjudAppealsCourtRulingsSearchResponse"}}}},"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"}}}}}}},"/cl/pjud/appeals-court-ruling/v1":{"post":{"operationId":"pjud_appeals_court_ruling","summary":"Poder Judicial Cortes de Apelaciones Ruling","description":"Retrieve one ruling of the Cortes de Apelaciones by its `id` from a search result: its full text (anonymized where the court anonymizes it), case number, court, parties line, matters, judges, outcome, descriptors and cited provisions, and Croma's copy of its anonymized PDF where there is one. 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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":"^\\d{1,12}$","description":"The ruling's `id` from a search result, e.g. `8283326`."},"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":"62274427"}}}},"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/PjudAppealsCourtRulingResponse"}}}},"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"}}}}}}},"/cl/pjud/civil-court-rulings-search/v1":{"post":{"operationId":"pjud_civil_court_rulings_search","summary":"Poder Judicial Civil Courts Rulings Search","description":"Search the rulings of Chile's first-instance civil courts: about 856,000. Free text matches the case number, case title, matters, descriptors and full text. Filter by `court`, `case_number` (rol), `year`, `matter` 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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 matched against the ruling's case number, case title, matters, descriptors and full text, e.g. `prescripción adquisitiva` or `despido injustificado`. Every word must appear; plural and singular match each other."},"case_number":{"type":"string","maxLength":30,"default":"","description":"Optional case number (rol) with its year, as the court writes it, e.g. `13194-2026`, or with its letter prefix in a first-instance court, e.g. `C-4513-2026`. Dots and spaces are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the case (the year in its rol, which can be earlier than the ruling). 0 searches every year."},"matter":{"type":"string","maxLength":200,"default":"","description":"Optional matter, exactly as it appears in a result's `matters`, e.g. `PATERNIDAD, RECONOCIMIENTO DE` or `HURTO SIMPLE POR UN VALOR DE MEDIA A MENOS DE 4 UTM.`."},"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)."},"court":{"type":"string","maxLength":120,"default":"","description":"Optional court, by its exact name as it appears in a result's `court`, e.g. `27º Juzgado Civil de Santiago`, `Juzgado de Garantía de Curicó`, `Juzgado de Letras del Trabajo de Rancagua`."}},"additionalProperties":false},"example":{"query":"arrendamiento","year":2025}}}},"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/PjudCivilCourtRulingsSearchResponse"}}}},"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"}}}}}}},"/cl/pjud/civil-court-ruling/v1":{"post":{"operationId":"pjud_civil_court_ruling","summary":"Poder Judicial Civil Courts Ruling","description":"Retrieve one ruling of Chile's civil courts by its `id` from a search result: its full text (anonymized where the court anonymizes it), case number, court, parties line, matters, judges, outcome, descriptors and cited provisions, and Croma's copy of its anonymized PDF where there is one. 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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":"^\\d{1,12}$","description":"The ruling's `id` from a search result, e.g. `8283326`."},"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":"201410080"}}}},"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/PjudCivilCourtRulingResponse"}}}},"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"}}}}}}},"/cl/pjud/criminal-court-rulings-search/v1":{"post":{"operationId":"pjud_criminal_court_rulings_search","summary":"Poder Judicial Criminal Courts Rulings Search","description":"Search the rulings of Chile's first-instance criminal courts (juzgados de garantía and tribunales de juicio oral en lo penal): about 840,000. Free text matches the case number, case title, matters, descriptors and full text. Filter by `court`, `case_number` (rol), `year`, `matter` 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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 matched against the ruling's case number, case title, matters, descriptors and full text, e.g. `prescripción adquisitiva` or `despido injustificado`. Every word must appear; plural and singular match each other."},"case_number":{"type":"string","maxLength":30,"default":"","description":"Optional case number (rol) with its year, as the court writes it, e.g. `13194-2026`, or with its letter prefix in a first-instance court, e.g. `C-4513-2026`. Dots and spaces are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the case (the year in its rol, which can be earlier than the ruling). 0 searches every year."},"matter":{"type":"string","maxLength":200,"default":"","description":"Optional matter, exactly as it appears in a result's `matters`, e.g. `PATERNIDAD, RECONOCIMIENTO DE` or `HURTO SIMPLE POR UN VALOR DE MEDIA A MENOS DE 4 UTM.`."},"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)."},"court":{"type":"string","maxLength":120,"default":"","description":"Optional court, by its exact name as it appears in a result's `court`, e.g. `27º Juzgado Civil de Santiago`, `Juzgado de Garantía de Curicó`, `Juzgado de Letras del Trabajo de Rancagua`."}},"additionalProperties":false},"example":{"query":"receptación","year":2025}}}},"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/PjudCriminalCourtRulingsSearchResponse"}}}},"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"}}}}}}},"/cl/pjud/criminal-court-ruling/v1":{"post":{"operationId":"pjud_criminal_court_ruling","summary":"Poder Judicial Criminal Courts Ruling","description":"Retrieve one ruling of Chile's criminal courts by its `id` from a search result: its full text (anonymized where the court anonymizes it), case number, court, parties line, matters, judges, outcome, descriptors and cited provisions, and Croma's copy of its anonymized PDF where there is one. 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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":"^\\d{1,12}$","description":"The ruling's `id` from a search result, e.g. `8283326`."},"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":"141941478"}}}},"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/PjudCriminalCourtRulingResponse"}}}},"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"}}}}}}},"/cl/pjud/family-court-rulings-search/v1":{"post":{"operationId":"pjud_family_court_rulings_search","summary":"Poder Judicial Family Courts Rulings Search","description":"Search the rulings of Chile's family courts: about 373,000, most of them from 2022 to 2025 and most anonymized. Free text matches the case number, case title, matters, descriptors and full text. Filter by `court`, `case_number` (rol), `year`, `matter` 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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 matched against the ruling's case number, case title, matters, descriptors and full text, e.g. `prescripción adquisitiva` or `despido injustificado`. Every word must appear; plural and singular match each other."},"case_number":{"type":"string","maxLength":30,"default":"","description":"Optional case number (rol) with its year, as the court writes it, e.g. `13194-2026`, or with its letter prefix in a first-instance court, e.g. `C-4513-2026`. Dots and spaces are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the case (the year in its rol, which can be earlier than the ruling). 0 searches every year."},"matter":{"type":"string","maxLength":200,"default":"","description":"Optional matter, exactly as it appears in a result's `matters`, e.g. `PATERNIDAD, RECONOCIMIENTO DE` or `HURTO SIMPLE POR UN VALOR DE MEDIA A MENOS DE 4 UTM.`."},"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)."},"court":{"type":"string","maxLength":120,"default":"","description":"Optional court, by its exact name as it appears in a result's `court`, e.g. `27º Juzgado Civil de Santiago`, `Juzgado de Garantía de Curicó`, `Juzgado de Letras del Trabajo de Rancagua`."}},"additionalProperties":false},"example":{"query":"divorcio","year":2024}}}},"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/PjudFamilyCourtRulingsSearchResponse"}}}},"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"}}}}}}},"/cl/pjud/family-court-ruling/v1":{"post":{"operationId":"pjud_family_court_ruling","summary":"Poder Judicial Family Courts Ruling","description":"Retrieve one ruling of Chile's family courts by its `id` from a search result: its full text (anonymized where the court anonymizes it), case number, court, parties line, matters, judges, outcome, descriptors and cited provisions, and Croma's copy of its anonymized PDF where there is one. 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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":"^\\d{1,12}$","description":"The ruling's `id` from a search result, e.g. `8283326`."},"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":"222163881"}}}},"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/PjudFamilyCourtRulingResponse"}}}},"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"}}}}}}},"/cl/pjud/labor-court-rulings-search/v1":{"post":{"operationId":"pjud_labor_court_rulings_search","summary":"Poder Judicial Labor Courts Rulings Search","description":"Search the rulings of Chile's first-instance labor courts: about 236,000. Free text matches the case number, case title, matters, descriptors and full text. Filter by `court`, `case_number` (rol), `year`, `matter` 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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 matched against the ruling's case number, case title, matters, descriptors and full text, e.g. `prescripción adquisitiva` or `despido injustificado`. Every word must appear; plural and singular match each other."},"case_number":{"type":"string","maxLength":30,"default":"","description":"Optional case number (rol) with its year, as the court writes it, e.g. `13194-2026`, or with its letter prefix in a first-instance court, e.g. `C-4513-2026`. Dots and spaces are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the case (the year in its rol, which can be earlier than the ruling). 0 searches every year."},"matter":{"type":"string","maxLength":200,"default":"","description":"Optional matter, exactly as it appears in a result's `matters`, e.g. `PATERNIDAD, RECONOCIMIENTO DE` or `HURTO SIMPLE POR UN VALOR DE MEDIA A MENOS DE 4 UTM.`."},"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)."},"court":{"type":"string","maxLength":120,"default":"","description":"Optional court, by its exact name as it appears in a result's `court`, e.g. `27º Juzgado Civil de Santiago`, `Juzgado de Garantía de Curicó`, `Juzgado de Letras del Trabajo de Rancagua`."}},"additionalProperties":false},"example":{"query":"despido injustificado","year":2025}}}},"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/PjudLaborCourtRulingsSearchResponse"}}}},"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"}}}}}}},"/cl/pjud/labor-court-ruling/v1":{"post":{"operationId":"pjud_labor_court_ruling","summary":"Poder Judicial Labor Courts Ruling","description":"Retrieve one ruling of Chile's labor courts by its `id` from a search result: its full text (anonymized where the court anonymizes it), case number, court, parties line, matters, judges, outcome, descriptors and cited provisions, and Croma's copy of its anonymized PDF where there is one. 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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":"^\\d{1,12}$","description":"The ruling's `id` from a search result, e.g. `8283326`."},"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":"21936194"}}}},"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/PjudLaborCourtRulingResponse"}}}},"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"}}}}}}},"/cl/pjud/labor-collection-court-rulings-search/v1":{"post":{"operationId":"pjud_labor_collection_court_rulings_search","summary":"Poder Judicial Labor Collection Courts Rulings Search","description":"Search the rulings of Chile's labor and social-security collection courts (juzgados de cobranza laboral y previsional): about 26,000. Free text matches the case number, case title, matters, descriptors and full text. Filter by `court`, `case_number` (rol), `year`, `matter` 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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 matched against the ruling's case number, case title, matters, descriptors and full text, e.g. `prescripción adquisitiva` or `despido injustificado`. Every word must appear; plural and singular match each other."},"case_number":{"type":"string","maxLength":30,"default":"","description":"Optional case number (rol) with its year, as the court writes it, e.g. `13194-2026`, or with its letter prefix in a first-instance court, e.g. `C-4513-2026`. Dots and spaces are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the case (the year in its rol, which can be earlier than the ruling). 0 searches every year."},"matter":{"type":"string","maxLength":200,"default":"","description":"Optional matter, exactly as it appears in a result's `matters`, e.g. `PATERNIDAD, RECONOCIMIENTO DE` or `HURTO SIMPLE POR UN VALOR DE MEDIA A MENOS DE 4 UTM.`."},"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)."},"court":{"type":"string","maxLength":120,"default":"","description":"Optional court, by its exact name as it appears in a result's `court`, e.g. `27º Juzgado Civil de Santiago`, `Juzgado de Garantía de Curicó`, `Juzgado de Letras del Trabajo de Rancagua`."}},"additionalProperties":false},"example":{"query":"cotizaciones","year":2025}}}},"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/PjudLaborCollectionCourtRulingsSearchResponse"}}}},"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"}}}}}}},"/cl/pjud/labor-collection-court-ruling/v1":{"post":{"operationId":"pjud_labor_collection_court_ruling","summary":"Poder Judicial Labor Collection Courts Ruling","description":"Retrieve one ruling of Chile's labor collection courts by its `id` from a search result: its full text (anonymized where the court anonymizes it), case number, court, parties line, matters, judges, outcome, descriptors and cited provisions, and Croma's copy of its anonymized PDF where there is one. 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":["Chile","Poder Judicial de Chile"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/pjud"},"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":"^\\d{1,12}$","description":"The ruling's `id` from a search result, e.g. `8283326`."},"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":"75417002"}}}},"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/PjudLaborCollectionCourtRulingResponse"}}}},"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"}}}}}}},"/cl/leychile/norms-search/v1":{"post":{"operationId":"leychile_norms_search","summary":"Ley Chile Norms Search","description":"Search Chile's laws, codes, DFL, DL, autos acordados, treaties and supreme decrees from Ley Chile (Biblioteca del Congreso Nacional). Free text matches the name, number, title, common names, subjects and summary. Filter by `type`, `number`, `year`, the publication date (`from_date`/`to_date`), `status` (in force or repealed) and `modified_by` (the norms a given norm modified). 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":["Chile","Ley Chile (Biblioteca del Congreso Nacional)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/leychile"},"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 in Spanish matched against the norm's name, number, title, common names, subjects and summary, e.g. `protección de datos personales` or `código del trabajo`. Every word must appear; accents and plurals are folded. To search inside the text of the articles, use the articles search."},"type":{"type":"string","enum":["","ley","codigo","dfl","dl","auto_acordado","tratado","decreto"],"default":"","description":"Optional kind of norm: `ley`, `codigo`, `dfl` (decreto con fuerza de ley), `dl` (decreto ley), `auto_acordado`, `tratado` or `decreto` (decretos supremos)."},"number":{"type":"string","maxLength":30,"default":"","description":"Optional number of the norm as BCN lists it, e.g. `21450` for Ley 21.450. Dots and spaces are ignored. Add `type` to name one norm."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year the norm was published (or promulgated, for the few norms without a publication date). 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."},"status":{"type":"string","enum":["","in_force","repealed"],"default":"","description":"Optional status: `in_force` for norms not repealed, `repealed` for repealed (derogadas) ones."},"modified_by":{"type":"string","maxLength":20,"default":"","description":"Optional `norm_id` of a modifying norm, e.g. `1219906`: only the norms whose version history lists it among the norms that modified them."},"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":"protección de datos personales","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/LeychileNormsSearchResponse"}}}},"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"}}}}}}},"/cl/leychile/norm/v1":{"post":{"operationId":"leychile_norm","summary":"Ley Chile Norm","description":"Retrieve one Chilean norm from Ley Chile by its `norm_id` (e.g. `1176603`), its `official_url`, or its kind and number (`Ley 21450`, `DFL 1`): its identity, dates, status, summary, every version of its text with the norms that modified it, the norms it modified, Croma's copies of its PDF and XML, and its current text part by part (`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":["Chile","Ley Chile (Biblioteca del Congreso Nacional)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/leychile"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["norm_id"],"properties":{"norm_id":{"type":"string","minLength":1,"maxLength":300,"description":"The norm's `norm_id` from a search result, e.g. `1176603`. Its `official_url`, or its kind and number (`Ley 21450`, `DFL 1`, `Decreto 100`), work too; a kind and number shared by several norms answers the most recent."},"offset":{"type":"integer","minimum":0,"maximum":100000,"default":0,"description":"Position of the first part of the text to return (0 is the heading). Pass the previous response's `next_offset` to read on."},"limit":{"type":"integer","minimum":1,"maximum":500,"default":100,"description":"How many parts of the text (headings, articles, transitory provisions) to return (1-500)."}},"additionalProperties":false},"example":{"norm_id":"Ley 21450"}}}},"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/LeychileNormResponse"}}}},"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"}}}}}}},"/cl/leychile/articles-search/v1":{"post":{"operationId":"leychile_articles_search","summary":"Ley Chile Articles Search","description":"Search inside the current text of every Chilean norm Croma keeps from Ley Chile, article by article: free text over each part's text and heading, optionally within one norm (`norm_id`). Each result is one part (an article, a chapter, a transitory provision, an annex) with its norm, position and status.\n\n**Dataset endpoint**: answers from the whole source in milliseconds and carries `as_of`.","x-served-from":"dataset","tags":["Chile","Ley Chile (Biblioteca del Congreso Nacional)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/leychile"},"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 in Spanish matched against the text and heading of every article, e.g. `indemnización por años de servicio`. Every word must appear; accents and plurals are folded."},"norm_id":{"type":"string","maxLength":20,"default":"","description":"Optional `norm_id`, e.g. `207436`: only the articles of that norm."},"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":"indemnización por años de servicio"}}}},"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/LeychileArticlesSearchResponse"}}}},"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"}}}}}}},"/cl/tc-cl/rulings-search/v1":{"post":{"operationId":"tc_cl_rulings_search","summary":"Tribunal Constitucional Chile Rulings Search","description":"Search the sentencias of Chile's Tribunal Constitucional: about 13,000 cases since 1981, one result per case (rol). Free text matches the rol, caption, requesters, pending proceeding, challenged laws, constitutional articles, keywords, justices, doctrine and the sentence's text. Filter by `rol`, `procedure` (e.g. `INA`, `CPR`), `outcome` (e.g. `Acoge`, `Rechaza`) and the sentence date (`from_date`/`to_date`). Each result carries the challenged provisions, the votes and their authors, every ficha with all its fields, and every document with Croma's copy of its PDF. 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":["Chile","Tribunal Constitucional (Chile)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/tribunal-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 words matched against the rol, the case caption, the requesters, the pending proceeding, the challenged laws, the constitutional articles, the keywords, the justices, the doctrine and the sentence's text, e.g. `debido proceso` or `Código del Trabajo 472`. Every word must appear."},"rol":{"type":"string","maxLength":30,"default":"","description":"Optional rol of the case, e.g. `16770`, `16.770-25` or `16770-2025-INA`: only its number counts."},"procedure":{"type":"string","maxLength":10,"default":"","description":"Optional procedure code, e.g. `INA` (inaplicabilidad, art. 93 N° 6), `INC` (inconstitucionalidad), `CPR` (control preventivo), `CAA` (auto acordado), `CPT`, `CDS`. Case-insensitive."},"outcome":{"type":"string","maxLength":60,"default":"","description":"Optional outcome as the Tribunal records it, e.g. `Acoge`, `Rechaza`, `Acoge parcialmente`, `Empate`, `Inadmisible`. Accents and case 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":"debido proceso","procedure":"INA"}}}},"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/TcClRulingsSearchResponse"}}}},"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"}}}}}}},"/cl/tc-cl/ruling/v1":{"post":{"operationId":"tc_cl_ruling","summary":"Tribunal Constitucional Chile Ruling","description":"Retrieve one case of Chile's Tribunal Constitucional by its `rol` (e.g. `16770`, or `16.770-25-INA`): its procedure, sentence date, outcome, requesters, challenged provisions, constitutional articles, the justices of each vote with their authors, doctrine, every ficha with all its fields, every document with Croma's copy of its PDF, and the sentence's text. 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":["Chile","Tribunal Constitucional (Chile)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/tribunal-constitucional"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["rol"],"properties":{"rol":{"type":"string","minLength":1,"maxLength":30,"description":"The case's `rol` from a search result, e.g. `16770`. `16.770-25` or `16770-2025-INA` work too: only the number counts."},"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":{"rol":"16770"}}}},"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/TcClRulingResponse"}}}},"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"}}}}}}},"/cl/dt-cl/pronouncements-search/v1":{"post":{"operationId":"dt_cl_pronouncements_search","summary":"Dirección del Trabajo Chile Pronouncements Search","description":"Search the administrative labour-law doctrine of Chile's Dirección del Trabajo: about 5,000 dictámenes since 1990, 7,900 ordinarios, and its circulares, órdenes de servicio and resoluciones. Free text in Spanish matches the title, the materias, the summary, the descriptors and the full text. Filter by `type`, `number` (e.g. `388/32`, or `388` for every pronouncement with that number), `year` and the issue date (`from_date`/`to_date`). Each result carries its labelled parts (legal sources, concordances), the DT's index of concordances and legal references, and Croma's copy of every published file. 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":["Chile","Dirección del Trabajo (Chile)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/direccion-del-trabajo"},"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 in Spanish matched against the title, the materias, the summary, the descriptors and the full text, e.g. `registro de asistencia` or `fatiga somnolencia`. Every word must appear."},"type":{"type":"string","enum":["","dictamen","ordinario","circular","orden_de_servicio","resolucion"],"default":"","description":"Optional kind: `dictamen` (sets doctrine), `ordinario` (answers a consultation), `circular`, `orden_de_servicio` or `resolucion`."},"number":{"type":"string","maxLength":30,"default":"","description":"Optional number, e.g. `388/32` (a dictamen with its correlative) or `388` (every pronouncement numbered 388). Numbers repeat across years and kinds."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year it was issued. 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":50,"default":20,"description":"Results per page (1-50)."}},"additionalProperties":false},"example":{"query":"registro de asistencia","type":"dictamen"}}}},"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/DtClPronouncementsSearchResponse"}}}},"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"}}}}}}},"/cl/dt-cl/pronouncement/v1":{"post":{"operationId":"dt_cl_pronouncement","summary":"Dirección del Trabajo Chile Pronouncement","description":"Retrieve one pronouncement of Chile's Dirección del Trabajo (a dictamen, ordinario, circular, orden de servicio or resolución) by its `id` from a search result (e.g. `129643`): its number and date, materias, summary, the labelled parts of its text, the DT's index of concordances and legal references, Croma's copy of every published file, and the full text. 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":["Chile","Dirección del Trabajo (Chile)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/direccion-del-trabajo"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["pronouncement_id"],"properties":{"pronouncement_id":{"type":"string","pattern":"^\\d{1,9}$","description":"The pronouncement's `id` from a search result, e.g. `129643`."},"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":{"pronouncement_id":"129643"}}}},"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/DtClPronouncementResponse"}}}},"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"}}}}}}},"/cl/suseso/dictamenes-search/v1":{"post":{"operationId":"suseso_dictamenes_search","summary":"SUSESO Dictámenes Search","description":"Search the dictámenes of Chile's Superintendencia de Seguridad Social (SUSESO): about 16,100 social security rulings since 1971 on medical leave, work accidents (Ley 16.744), family allowance, compensation funds and welfare services. Free text matches the number, recipient, summary, topics, descriptors, legal sources and full text. Filter by `number`, `year`, the issue date (`from_date`/`to_date`), `topic` and `related_to` (the dictámenes SUSESO relates to a given one). Each result carries its topics, related dictámenes and circulars, attached files and links to its page at SUSESO and Croma's copy of it. 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":["Chile","Superintendencia de Seguridad Social (Chile)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/suseso"},"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 matched against the dictamen's number, recipient, summary, topics, descriptors, legal sources and full text, e.g. `licencia médica rechazo` or `crédito social`. Every word must appear; plural and singular match each other."},"number":{"type":"string","maxLength":40,"default":"","description":"Optional dictamen number as SUSESO publishes it, with its year, e.g. `150250-2026` or `O-01-S-04558-2026`. Case and spaces are ignored."},"year":{"type":"integer","minimum":0,"maximum":2100,"default":0,"description":"Optional year of the dictamen. 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."},"topic":{"type":"string","maxLength":200,"default":"","description":"Optional topic, exactly as it appears in a result's `topics`, e.g. `Licencias médicas`, `Seguro laboral (Ley 16.744)`, `Asignación familiar`, `Créditos sociales`."},"related_to":{"type":"string","maxLength":20,"default":"","description":"Optional dictamen `id`, e.g. `758965`: only the dictámenes SUSESO lists as related to it."},"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":"licencia médica","topic":"Licencias médicas"}}}},"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/SusesoDictamenesSearchResponse"}}}},"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"}}}}}}},"/cl/suseso/dictamen/v1":{"post":{"operationId":"suseso_dictamen","summary":"SUSESO Dictamen","description":"Retrieve one dictamen of Chile's Superintendencia de Seguridad Social (SUSESO) by its `id` from a search result (e.g. `758965`), its `official_url`, or its number (`O-01-S-00582-2025`): its full text, recipient, summary, topics, descriptors, legal sources, related dictámenes and circulars, attached files and Croma's copy of its page. 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":["Chile","Superintendencia de Seguridad Social (Chile)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/suseso"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dictamen_id"],"properties":{"dictamen_id":{"type":"string","minLength":1,"maxLength":300,"description":"The dictamen's `id` from a search result, e.g. `758965`. Its `official_url`, or its number as SUSESO publishes it (`O-01-S-00582-2025`, `150250-2026`), work too."},"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":{"dictamen_id":"758965"}}}},"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/SusesoDictamenResponse"}}}},"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"}}}}}}},"/cl/tta/rulings-search/v1":{"post":{"operationId":"tta_rulings_search","summary":"TTA Rulings Search","description":"Search the sentencias of Chile's Tribunales Tributarios y Aduaneros: about 15,000 first-instance final judgments since 2010 in tax (SII) and customs (SNA) cases. Free text matches the caption, the case's RUC and RIT, the court, the procedure, the subject, the court's extract and the sentencia's text. Filter by `case_ruc`, `registration_number` (the RIT), `court_id`, `agency` (`sii` or `sna`), `jurisprudence_only` and the sentence date (`from_date`/`to_date`). Each result carries Croma's copy of the signed PDF. 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":["Chile","Tribunales Tributarios y Aduaneros (Chile)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/tta"},"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 matched against the caption, the case's RUC and RIT, the court, the procedure, the subject, the court's extract and the sentencia's text, e.g. `crédito fiscal IVA` or `avalúo`. Every word must appear."},"case_ruc":{"type":"string","maxLength":30,"default":"","description":"Optional RUC of the case (rol único de causa), e.g. `13-9-0000546-0`. Case and spaces are ignored."},"registration_number":{"type":"string","maxLength":30,"default":"","description":"Optional RIT of the case (rol interno del tribunal), e.g. `GR-14-00071-2013`. Case and spaces are ignored."},"court_id":{"type":"integer","minimum":0,"maximum":99,"default":0,"description":"Optional court, by its number: 1 Arica y Parinacota, 2 Tarapacá, 3 Antofagasta, 4 Atacama, 6 Coquimbo, 14 Valparaíso, 15 to 18 the first to fourth of the Región Metropolitana, 19 O'Higgins, 7 Maule, 10 Ñuble y Biobío, 8 Araucanía, 11 Los Ríos, 12 Los Lagos, 13 Aysén, 9 Magallanes. 0 searches every court."},"agency":{"type":"string","enum":["","sii","sna"],"default":"","description":"Optional office whose act is challenged: `sii` (Servicio de Impuestos Internos, tax cases) or `sna` (Servicio Nacional de Aduanas, customs cases)."},"jurisprudence_only":{"type":"boolean","default":false,"description":"When true, only the sentencias the TTA publishes in its jurisprudence collection (about three in four)."},"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":"crédito fiscal","agency":"sii"}}}},"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/TtaRulingsSearchResponse"}}}},"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"}}}}}}},"/cl/tta/ruling/v1":{"post":{"operationId":"tta_ruling","summary":"TTA Ruling","description":"Retrieve one sentencia of Chile's Tribunales Tributarios y Aduaneros by its `id` from a search result: the case's RUC and RIT, caption, court, office, procedure, subject, dates, the court's extract, whether it is published as jurisprudence, Croma's copy of the signed PDF, and the sentencia's text. 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":["Chile","Tribunales Tributarios y Aduaneros (Chile)"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/chile/tta"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"The sentencia's `id` from a search result, 32 hexadecimal characters, e.g. `ff8080813ecc6f1d013ed1f2633c13b7`."},"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":{"id":"ff8080813ecc6f1d013ed1f2633c13b7"}}}},"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/TtaRulingResponse"}}}},"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"}}}}}}},"/ve/seniat/rif/v1":{"post":{"operationId":"seniat_rif","summary":"SENIAT RIF","description":"Look up a Venezuelan taxpayer by RIF in SENIAT's Registro de Información Fiscal. Returns the registered name and trade name, the economic activity, the VAT condition (ordinary or special taxpayer, withholding agent) and the VAT withholding rate (75% or 100%). `found: false` when no taxpayer has that RIF.","tags":["Venezuela","SENIAT"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/venezuela/seniat"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["rif"],"properties":{"rif":{"type":"string","pattern":"^[VEJPGCvejpgc][-\\s]?\\d{8}[-\\s]?\\d$","description":"RIF: the type letter (V, E, J, P, G or C) followed by nine digits, the last one the check digit. Dashes and spaces are accepted."}},"additionalProperties":false},"example":{"rif":"J001241345"}}}},"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/SeniatRifResponse"}}}},"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/bancolombia/accounts/v1":{"post":{"operationId":"bancolombia_accounts","summary":"Bancolombia Accounts","description":"Read the accounts the connected Bancolombia customer holds, with their type, currency and available balance. Runs as your organization's own Bancolombia connection.\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","Bancolombia"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/bancolombia"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"connection_id":{"type":"string","default":"","description":"Optional. Run as this connection (`conn_…`). Empty lets Croma pick among your organization's connections, moving to the next one when one reaches its daily allowance."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"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/BancolombiaAccountsResponse"}}}},"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/bancolombia/transactions/v1":{"post":{"operationId":"bancolombia_transactions","summary":"Bancolombia Transactions","description":"Read the movements of one of the connected customer's Bancolombia accounts over a date window: date, description, amount, the movement type and a reference. Runs as your organization's own Bancolombia connection.\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","Bancolombia"],"externalDocs":{"description":"Interactive documentation and examples","url":"https://docs.usecroma.com/guides/colombia/bancolombia"},"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Prefer"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_number","date_from","date_to"],"properties":{"account_number":{"type":"string","pattern":"^\\d{6,20}$","description":"The account number to read movements for, digits only, as it appears in the accounts list."},"date_from":{"type":"string","format":"date","description":"The first day of the movements window, inclusive, `yyyy-mm-dd`."},"date_to":{"type":"string","format":"date","description":"The last day of the movements window, inclusive, `yyyy-mm-dd`."},"connection_id":{"type":"string","default":"","description":"Optional. Run as this connection (`conn_…`). Empty lets Croma pick among your organization's connections, moving to the next one when one reaches its daily allowance."},"callback_url":{"type":"string","format":"uri","description":"POST the job result here when it finishes."}},"additionalProperties":false},"example":{"account_number":"12345678901","date_from":"2026-01-01","date_to":"2026-03-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/BancolombiaTransactionsResponse"}}}},"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"}}}}}}},"/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"}}}}}}},"/monitors":{"post":{"operationId":"create_monitor","summary":"Create Monitor","description":"Watch any data endpoint on a schedule and email up to three addresses what is new. The monitor runs once right away to record what already matches (the baseline) and sends a welcome email; from then on every run reports only what appeared since the last one: on a search, its new results; on a lookup of one record, the values that changed (each with what it was before) and any new item in its lists, such as a new action on a case. With `schedule.cadence: \"source\"` (the default) each run starts after the endpoint's own refresh has completed, so a daily source is checked once a day, right after new data lands; an endpoint served live has no refresh to follow and runs `daily` or `weekly` instead. Each run spends the same credits as one request to the endpoint. An organization may have up to 20 monitors.","tags":["Monitors"],"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorCreateRequest"},"example":{"name":"Contrato AD9-111","endpoint":"/co/anm/notices-search/v1","query":{"title_number":"AD9-111"},"schedule":{"cadence":"source"},"recipients":["legal@example.com"],"notify":"always","language":"es"}}}},"responses":{"201":{"description":"The monitor, with its compiled schedule and next run.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorResponse"}}}},"400":{"description":"Invalid body: unknown endpoint, endpoint not monitorable, invalid query for that endpoint, schedule faster than the source, or too many recipients","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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"}}}},"403":{"description":"Monitor limit reached for the organization (`monitor_limit_reached`), or monitors are not enabled for it yet (`monitors_not_enabled`)","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"A monitor with the same endpoint, query and schedule already exists (`details.existing_id`)","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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"}}}},"503":{"description":"The schedule could not be created; retry","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"get":{"operationId":"list_monitors","summary":"List Monitors","description":"The organization's monitors, newest first, each with its last run.","tags":["Monitors"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}}],"responses":{"200":{"description":"Monitors and pagination.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorListResponse"}}}},"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"}}}},"403":{"description":"Monitors are in private beta and not enabled for the organization yet (`monitors_not_enabled`)","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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"}}}}}}},"/monitors/{id}":{"get":{"operationId":"get_monitor","summary":"Get Monitor","tags":["Monitors"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Monitor id, as returned on creation (`mon_…`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The monitor.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorResponse"}}}},"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"}}}},"403":{"description":"Monitors are in private beta and not enabled for the organization yet (`monitors_not_enabled`)","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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":"Monitor 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"}}}}}},"patch":{"operationId":"update_monitor","summary":"Update Monitor","description":"Change any field but the endpoint. `status: \"paused\"` stops the schedule and `\"active\"` resumes it; a new schedule takes effect on the next run.","tags":["Monitors"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Monitor id, as returned on creation (`mon_…`).","schema":{"type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorUpdateRequest"},"example":{"status":"paused"}}}},"responses":{"200":{"description":"The updated monitor.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorResponse"}}}},"400":{"description":"Invalid 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"}}}},"403":{"description":"Monitors are in private beta and not enabled for the organization yet (`monitors_not_enabled`)","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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":"Monitor 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"}}}}}},"delete":{"operationId":"delete_monitor","summary":"Delete Monitor","description":"Removes the monitor, its schedule, its runs and its matches.","tags":["Monitors"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Monitor id, as returned on creation (`mon_…`).","schema":{"type":"string"}}],"responses":{"204":{"description":"Deleted.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}}},"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"}}}},"403":{"description":"Monitors are in private beta and not enabled for the organization yet (`monitors_not_enabled`)","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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":"Monitor 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"}}}}}}},"/monitors/{id}/run":{"post":{"operationId":"run_monitor","summary":"Run Monitor Now","description":"Queues an immediate run, outside the schedule. Spends the same credits as a scheduled run.","tags":["Monitors"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Monitor id, as returned on creation (`mon_…`).","schema":{"type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"202":{"description":"The run was queued.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorRunAccepted"}}}},"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"}}}},"403":{"description":"Monitors are in private beta and not enabled for the organization yet (`monitors_not_enabled`)","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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":"Monitor 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"}}}}}}},"/monitors/{id}/runs":{"get":{"operationId":"list_monitor_runs","summary":"List Monitor Runs","description":"Every run of the monitor, newest first.","tags":["Monitors"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Monitor id, as returned on creation (`mon_…`).","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}}],"responses":{"200":{"description":"Runs and pagination.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorRunListResponse"}}}},"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"}}}},"403":{"description":"Monitors are in private beta and not enabled for the organization yet (`monitors_not_enabled`)","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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":"Monitor 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"}}}}}}},"/monitors/{id}/matches":{"get":{"operationId":"list_monitor_matches","summary":"List Monitor Matches","description":"Every row the monitor has reported, newest first, with the relevance filter's verdict when the monitor has one.","tags":["Monitors"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Monitor id, as returned on creation (`mon_…`).","schema":{"type":"string"}},{"name":"relevant","in":"query","required":false,"schema":{"type":"boolean"},"description":"Only rows the relevance filter kept (`true`) or discarded (`false`)."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}}],"responses":{"200":{"description":"Matches and pagination.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorMatchListResponse"}}}},"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"}}}},"403":{"description":"Monitors are in private beta and not enabled for the organization yet (`monitors_not_enabled`)","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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":"Monitor 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"}}}}}}},"/co/dian-muisca/connections/v1":{"post":{"operationId":"dian_muisca_connections_create","summary":"Connect a DIAN account","description":"DIAN answers only to a signed-in person: their DIAN account's document type, number and password. Signed in on their own behalf (`sign_in_as: self`, the default) the connection reads the person's own records; signed in on behalf of a third party they represent at DIAN (`sign_in_as: third_party`, with its NIT in `on_behalf_of_nit`) it reads that company's or person's records. The person and each third party are separate connections. Each query runs as your organization's own connection, so register one before your first query. Register the account once; Croma keeps the session open and reuses it across queries.\n\nCroma checks the account with the source before saving it.\n\nCredentials are encrypted as soon as they reach Croma, bound to your organization, and can only be opened by the isolated service that signs in to the source on your behalf. They are never returned by the API.","tags":["Colombia","DIAN"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number","password","authorized"],"properties":{"sign_in_as":{"type":"string","enum":["self","third_party"],"default":"self","description":"How the account signs in: `self` reads the person's own records (a nombre propio); `third_party` reads the records of the person or company whose NIT goes in `on_behalf_of_nit`, which the person represents at DIAN (a nombre de un tercero). Defaults to `self`."},"on_behalf_of_nit":{"type":"string","pattern":"^(\\d{5,10})?$","default":"","description":"The NIT of the third party, without the verification digit, dots or dashes. Required when `sign_in_as` is `third_party`; leave empty for `self`."},"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","pattern":"^[A-Za-z0-9-]{3,30}$","description":"The document number of the person whose DIAN account this is (the representative's, when signing in for a third party), without dots or commas."},"password":{"type":"string","minLength":1,"maxLength":100,"format":"password","description":"The password of that DIAN account."},"authorized":{"type":"boolean","const":true,"description":"Confirms you are the account's owner or have the owner's authorization to use it."}},"additionalProperties":false},"example":{"document_type":"CC","document_number":"1234567890","password":"your-dian-password","authorized":true}}}},"responses":{"201":{"description":"Connected","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The connection's id, `conn_…`."},"source":{"type":"string"},"status":{"type":"string","enum":["active","exhausted","invalid"],"description":"`exhausted` until its daily allowance resets; `invalid` when the source no longer accepts it."},"display_name":{"type":["string","null"],"description":"The account's name as the source shows it, masked."},"usage":{"type":["object","null"],"properties":{"sign_ins_today":{"type":"integer"},"daily_limit":{"type":["integer","null"]},"resets_at":{"type":"string","format":"date-time"}}},"available_again_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"last_used_at":{"type":["string","null"],"format":"date-time"}}}}}}}},"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"}}}},"409":{"description":"`connection_exists`: the account is already connected","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"`connection_rejected`: the source did not accept the account, or `connection_limit_reached`","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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":"`connections_exhausted`: the account has no sign-ins left today","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"`connection_unverified`: the source could not check it right now","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"get":{"operationId":"dian_muisca_connections_list","summary":"List DIAN connections","description":"Your organization's connections for this source, with each one's status and allowance. Credentials are never returned.","tags":["Colombia","DIAN"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Connections","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The connection's id, `conn_…`."},"source":{"type":"string"},"status":{"type":"string","enum":["active","exhausted","invalid"],"description":"`exhausted` until its daily allowance resets; `invalid` when the source no longer accepts it."},"display_name":{"type":["string","null"],"description":"The account's name as the source shows it, masked."},"usage":{"type":["object","null"],"properties":{"sign_ins_today":{"type":"integer"},"daily_limit":{"type":["integer","null"]},"resets_at":{"type":"string","format":"date-time"}}},"available_again_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"last_used_at":{"type":["string","null"],"format":"date-time"}}}}}}}}},"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"}}}}}}},"/co/dian-muisca/connections/v1/{id}":{"delete":{"operationId":"dian_muisca_connections_delete","summary":"Delete a DIAN connection","description":"Deletes the connection and destroys its encrypted credentials permanently.","tags":["Colombia","DIAN"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The connection's id, `conn_…`."}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"}}}}}}}},"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":"`connection_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"}}}}}}},"/co/dian-facturacion/connections/v1":{"post":{"operationId":"dian_facturacion_connections_create","summary":"Connect a DIAN account","description":"DIAN's electronic-invoicing system has no password: access is a link DIAN emails to the address registered in the RUT of the person who asks for it (for a company, its legal representative). Ask for it with the access requests endpoint below, or in DIAN's electronic-invoicing system, then register the link here within the 60 minutes DIAN accepts it. DIAN keeps that access open for about an hour, so register the link when you are about to query and run what you need in that window. After it, queries answer `422 connection_rejected`: ask for a new link and register it again, and the same connection is renewed, keeping its id.\n\nCroma checks the account with the source before saving it.\n\nCredentials are encrypted as soon as they reach Croma, bound to your organization, and can only be opened by the isolated service that signs in to the source on your behalf. They are never returned by the API.","tags":["Colombia","DIAN"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["access_link","authorized"],"properties":{"access_link":{"type":"string","format":"password","maxLength":1000,"description":"The access link DIAN emails to the address registered in the RUT when access to its electronic-invoicing system is requested, copied whole. DIAN accepts it for 60 minutes, and the access it opens lasts about an hour."},"authorized":{"type":"boolean","const":true,"description":"Confirms you are the account's owner or have the owner's authorization to use it."}},"additionalProperties":false},"example":{"access_link":"<access link from the DIAN email>","authorized":true}}}},"responses":{"201":{"description":"Connected","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The connection's id, `conn_…`."},"source":{"type":"string"},"status":{"type":"string","enum":["active","exhausted","invalid"],"description":"`exhausted` until its daily allowance resets; `invalid` when the source no longer accepts it."},"display_name":{"type":["string","null"],"description":"The account's name as the source shows it, masked."},"usage":{"type":["object","null"],"properties":{"sign_ins_today":{"type":"integer"},"daily_limit":{"type":["integer","null"]},"resets_at":{"type":"string","format":"date-time"}}},"available_again_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"last_used_at":{"type":["string","null"],"format":"date-time"}}}}}}}},"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"}}}},"409":{"description":"`connection_exists`: the account is already connected","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"`connection_rejected`: the source did not accept the account, or `connection_limit_reached`","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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":"`connections_exhausted`: the account has no sign-ins left today","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"`connection_unverified`: the source could not check it right now","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"get":{"operationId":"dian_facturacion_connections_list","summary":"List DIAN connections","description":"Your organization's connections for this source, with each one's status and allowance. Credentials are never returned.","tags":["Colombia","DIAN"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Connections","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The connection's id, `conn_…`."},"source":{"type":"string"},"status":{"type":"string","enum":["active","exhausted","invalid"],"description":"`exhausted` until its daily allowance resets; `invalid` when the source no longer accepts it."},"display_name":{"type":["string","null"],"description":"The account's name as the source shows it, masked."},"usage":{"type":["object","null"],"properties":{"sign_ins_today":{"type":"integer"},"daily_limit":{"type":["integer","null"]},"resets_at":{"type":"string","format":"date-time"}}},"available_again_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"last_used_at":{"type":["string","null"],"format":"date-time"}}}}}}}}},"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"}}}}}}},"/co/dian-facturacion/connections/v1/{id}":{"delete":{"operationId":"dian_facturacion_connections_delete","summary":"Delete a DIAN connection","description":"Deletes the connection and destroys its encrypted credentials permanently.","tags":["Colombia","DIAN"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The connection's id, `conn_…`."}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"}}}}}}}},"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":"`connection_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"}}}}}}},"/pe/sunarp/connections/v1":{"post":{"operationId":"sunarp_connections_create","summary":"Connect a SUNARP account","description":"SUNARP answers only to a signed-in person: a Peruvian DNI, with the verification digit and issue date printed on the card. Each query runs as your organization's own connection, so register one before your first query. SUNARP allows each DNI five sign-ins a day; Croma keeps every session open as long as SUNARP allows, so five sign-ins cover many queries.\n\nCroma checks the account with the source before saving it. Each account allows 5 sign-ins a day; queries rotate across your connections.\n\nCredentials are encrypted as soon as they reach Croma, bound to your organization, and can only be opened by the isolated service that signs in to the source on your behalf. They are never returned by the API.","tags":["Peru","SUNARP"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_number","check_digit","issue_date","authorized"],"properties":{"document_number":{"type":"string","pattern":"^\\d{8}$","description":"The DNI of the person whose account this is: eight digits."},"check_digit":{"type":"string","pattern":"^[0-9A-Za-z]$","description":"The verification digit printed after the DNI number on the card."},"issue_date":{"type":"string","format":"date","description":"The issue date printed on the DNI card, `yyyy-mm-dd`."},"authorized":{"type":"boolean","const":true,"description":"Confirms you are the account's owner or have the owner's authorization to use it."}},"additionalProperties":false},"example":{"document_number":"12345678","check_digit":"1","issue_date":"2020-01-01","authorized":true}}}},"responses":{"201":{"description":"Connected","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The connection's id, `conn_…`."},"source":{"type":"string"},"status":{"type":"string","enum":["active","exhausted","invalid"],"description":"`exhausted` until its daily allowance resets; `invalid` when the source no longer accepts it."},"display_name":{"type":["string","null"],"description":"The account's name as the source shows it, masked."},"usage":{"type":["object","null"],"properties":{"sign_ins_today":{"type":"integer"},"daily_limit":{"type":["integer","null"]},"resets_at":{"type":"string","format":"date-time"}}},"available_again_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"last_used_at":{"type":["string","null"],"format":"date-time"}}}}}}}},"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"}}}},"409":{"description":"`connection_exists`: the account is already connected","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"`connection_rejected`: the source did not accept the account, or `connection_limit_reached`","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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":"`connections_exhausted`: the account has no sign-ins left today","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"`connection_unverified`: the source could not check it right now","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"get":{"operationId":"sunarp_connections_list","summary":"List SUNARP connections","description":"Your organization's connections for this source, with each one's status and allowance. Credentials are never returned.","tags":["Peru","SUNARP"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Connections","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The connection's id, `conn_…`."},"source":{"type":"string"},"status":{"type":"string","enum":["active","exhausted","invalid"],"description":"`exhausted` until its daily allowance resets; `invalid` when the source no longer accepts it."},"display_name":{"type":["string","null"],"description":"The account's name as the source shows it, masked."},"usage":{"type":["object","null"],"properties":{"sign_ins_today":{"type":"integer"},"daily_limit":{"type":["integer","null"]},"resets_at":{"type":"string","format":"date-time"}}},"available_again_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"last_used_at":{"type":["string","null"],"format":"date-time"}}}}}}}}},"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"}}}}}}},"/pe/sunarp/connections/v1/{id}":{"delete":{"operationId":"sunarp_connections_delete","summary":"Delete a SUNARP connection","description":"Deletes the connection and destroys its encrypted credentials permanently.","tags":["Peru","SUNARP"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The connection's id, `conn_…`."}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"}}}}}}}},"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":"`connection_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"}}}}}}},"/co/bancolombia/connections/v1":{"post":{"operationId":"bancolombia_connections_create","summary":"Connect a Bancolombia account","description":"Bancolombia answers only to a signed-in customer: their Sucursal Virtual Personas username and password. Each query runs as your organization's own connection, so register one before your first query. Register the account once; Croma signs in for each query and never stores the credentials in the clear.\n\nCroma checks the account with the source before saving it.\n\nCredentials are encrypted as soon as they reach Croma, bound to your organization, and can only be opened by the isolated service that signs in to the source on your behalf. They are never returned by the API.","tags":["Colombia","Bancolombia"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","password","authorized"],"properties":{"username":{"type":"string","minLength":1,"maxLength":60,"description":"The username (usuario) of that Bancolombia Sucursal Virtual Personas account."},"password":{"type":"string","minLength":1,"maxLength":100,"format":"password","description":"The password (clave) of that Bancolombia account."},"authorized":{"type":"boolean","const":true,"description":"Confirms you are the account's owner or have the owner's authorization to use it."}},"additionalProperties":false},"example":{"username":"your-username","password":"your-password","authorized":true}}}},"responses":{"201":{"description":"Connected","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The connection's id, `conn_…`."},"source":{"type":"string"},"status":{"type":"string","enum":["active","exhausted","invalid"],"description":"`exhausted` until its daily allowance resets; `invalid` when the source no longer accepts it."},"display_name":{"type":["string","null"],"description":"The account's name as the source shows it, masked."},"usage":{"type":["object","null"],"properties":{"sign_ins_today":{"type":"integer"},"daily_limit":{"type":["integer","null"]},"resets_at":{"type":"string","format":"date-time"}}},"available_again_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"last_used_at":{"type":["string","null"],"format":"date-time"}}}}}}}},"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"}}}},"409":{"description":"`connection_exists`: the account is already connected","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"`connection_rejected`: the source did not accept the account, or `connection_limit_reached`","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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":"`connections_exhausted`: the account has no sign-ins left today","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"`connection_unverified`: the source could not check it right now","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"get":{"operationId":"bancolombia_connections_list","summary":"List Bancolombia connections","description":"Your organization's connections for this source, with each one's status and allowance. Credentials are never returned.","tags":["Colombia","Bancolombia"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Connections","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The connection's id, `conn_…`."},"source":{"type":"string"},"status":{"type":"string","enum":["active","exhausted","invalid"],"description":"`exhausted` until its daily allowance resets; `invalid` when the source no longer accepts it."},"display_name":{"type":["string","null"],"description":"The account's name as the source shows it, masked."},"usage":{"type":["object","null"],"properties":{"sign_ins_today":{"type":"integer"},"daily_limit":{"type":["integer","null"]},"resets_at":{"type":"string","format":"date-time"}}},"available_again_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"last_used_at":{"type":["string","null"],"format":"date-time"}}}}}}}}},"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"}}}}}}},"/co/bancolombia/connections/v1/{id}":{"delete":{"operationId":"bancolombia_connections_delete","summary":"Delete a Bancolombia connection","description":"Deletes the connection and destroys its encrypted credentials permanently.","tags":["Colombia","Bancolombia"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The connection's id, `conn_…`."}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"}}}}}}}},"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":"`connection_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"}}}}}}},"/feedback":{"post":{"operationId":"submit_feedback","summary":"Submit Feedback","description":"Tell Croma something is wrong, unclear or missing: an error or empty result, an unclear answer, a source or field that does not exist. Send the `X-Request-Id` of the call when you have it. A report that repeats an earlier one from your organization on the same UTC day, ignoring case, accents and punctuation (and numbers, links and emails in longer reports), returns the original id with `already_received`. Submissions are reviewed by Croma and cannot be listed or retrieved. Feedback never spends credits and is limited to 20 reports per hour per organization.","tags":["Feedback"],"security":[{"bearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["issue","question","request"],"description":"`issue`: something is wrong. `question`: something is unclear. `request`: something should exist or change."},"content":{"type":"string","minLength":1,"maxLength":20000,"description":"What happened or what is needed, in plain text with enough context to act on. Leave out credentials, personal data and payment details."},"request_id":{"description":"The `X-Request-Id` of the REST call the feedback is about, when you have it.","type":"string","pattern":"^(req|mcp)_[A-Za-z0-9-]{8,64}$"}},"required":["type","content"],"additionalProperties":false},"example":{"type":"request","content":"Property liens for Bogota are not covered by any endpoint."}}}},"responses":{"202":{"description":"Received","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","required":["id","created_at","status"],"properties":{"id":{"type":"string","description":"The receipt, `fbk_…`."},"created_at":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["received","already_received"]}}}}}}}},"400":{"description":"Invalid 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: 20 reports per hour per organization, separate from credits","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-Key":{"$ref":"#/components/headers/Idempotency-Key"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Feedback is temporarily unavailable (`feedback_not_configured`); retry later","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Idempotency-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":{"anyOf":[{"type":"string"},{"type":"null"}]},"parties_text":{"anyOf":[{"type":"string"},{"type":"null"}]},"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":{"anyOf":[{"type":"string"},{"type":"null"}]},"parties_text":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"}}}}},"RamaJudicialEmailsSearchData":{"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","page","per_page","total_pages","count","results"]},"RamaJudicialEmailsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RamaJudicialEmailsSearchData"}}},"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"}}},"RethusHealthProfessionalData":{"type":"object","properties":{"found":{"type":"boolean","description":"false when the document is not in the register."},"document_type":{"type":"string","enum":["CC","CE","TI","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":"Names and surnames on the register, null when not found."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"second_last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"identity_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Status of the identity document as the register reports it, e.g. \"Vigente\" or \"Fallecido\"."},"titles":{"type":"array","items":{"type":"object","properties":{"program_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Programme type code as the register prints it, e.g. \"UNV\" (university) or \"AUX\" (auxiliary)."},"title_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the title was obtained, e.g. \"Local\" (in Colombia)."},"profession":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Profession or occupation the title authorizes."},"practice_start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the administrative act authorizes practice from (yyyy-mm-dd)."},"administrative_act":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the administrative act that authorizes practice."},"reporting_entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Entity that reported the title to the register, e.g. a departmental health secretariat or a professional college."}},"required":["program_type","title_origin","profession","practice_start_date","administrative_act","reporting_entity"]},"description":"Titles on record; empty when not found."},"social_service":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":"One row, keyed by the register's column heading (as printed), with null for an empty cell."},"description":"Mandatory social service (servicio social obligatorio) records; empty when there are none."},"sanctions":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":"One row, keyed by the register's column heading (as printed), with null for an empty cell."},"description":"Sanctions on record; empty when there are none."},"checked_at":{"type":"string","description":"When this answer was read, as an ISO timestamp."}},"required":["found","document_type","document_type_label","document_number","full_name","first_name","middle_name","first_last_name","second_last_name","identity_status","titles","social_service","sanctions","checked_at"]},"RethusHealthProfessionalResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RethusHealthProfessionalData"}}},"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"}}},"PoliciaRnmcData":{"type":"object","properties":{"found":{"type":"boolean","description":"false when the register refused the check because `issue_date` does not match the cédula; true when it answered with a verdict."},"document_type":{"type":"string","enum":["CC","CE","PA","DPO","NIT"]},"document_type_label":{"type":"string"},"document_number":{"type":"string"},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name the register prints for a cédula, or null (other document types, or a number it does not know)."},"has_pending_measures":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"false → \"NO TIENE MEDIDAS CORRECTIVAS PENDIENTES POR CUMPLIR\". true → pending corrective measures on record. null when found is false."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's verdict sentence, verbatim."},"pending_measures":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":"One pending measure, keyed by the register's column heading (as printed), with null for an empty cell."},"description":"The pending measures listed with the verdict; empty when there are none."},"validation_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registro interno de validación: the number the register stamps on this check."},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the register answered (ISO 8601, Colombia time), as it prints it."},"message":{"type":"string","description":"The register's full answer in plain text, for audit or display."}},"required":["found","document_type","document_type_label","document_number","full_name","has_pending_measures","status","pending_measures","validation_number","checked_at","message"]},"PoliciaRnmcResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PoliciaRnmcData"}}},"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"},"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"}}}}},"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"},"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"}}}}},"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"}}},"FiscaliaCaseData":{"type":"object","properties":{"found":{"type":"boolean","description":"true when the Fiscalía has a case with this number."},"registration_number":{"type":"string","description":"The queried number, echoed back."},"case_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The Fiscalía's internal id for the case."},"restricted":{"type":"boolean","description":"true for a case under Ley 1098 de 2006 (children and adolescents): the Fiscalía does not publish its details, so every field but `law` and `law_code` is null or empty."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ACTIVO` or `INACTIVO`, as the Fiscalía prints it."},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The Fiscalía's numeric code for `status`, e.g. `1` for `ACTIVO`."},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why the case is inactive, e.g. `Archivo por conducta atipica art.79 c.p.p`; null when none is given."},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedural stage, e.g. `INDAGACIÓN`, `INVESTIGACIÓN`."},"stage_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The Fiscalía's numeric code for `stage`, e.g. `2` for `INDAGACIÓN`."},"law":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedural law that applies, e.g. `Ley 906`."},"law_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The Fiscalía's numeric code for `law`, e.g. `1` for `Ley 906`."},"reserved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The Fiscalía's own reserved marker on the case."},"incident_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the facts took place: ISO 8601, Colombian time."},"incident_department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the facts took place."},"incident_municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"assigned_office":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The prosecutor's office (despacho) the case is assigned to, e.g. `FISCALIA 99 SECCIONAL`."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit the office belongs to."},"directorate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Fiscalía's regional directorate (Dirección Seccional)."},"assigned_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the case was assigned to this office, `YYYY-MM-DD`."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the office sits."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As published."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office's mailbox, as published."}},"required":["name","unit","directorate","assigned_date","department","municipality","address","phone","email"]},{"type":"null"}],"description":"The prosecutor's office handling the case."},"crimes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The offence as the Fiscalía records it, with its article, e.g. `FALSEDAD EN DOCUMENTO PRIVADO. ART. 289 C.P.`."},"article":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Código Penal article read from `name`, e.g. `289`."},"grade":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grade the Fiscalía records, e.g. `AGRAVADO`; null when it records none."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The offence's status in the case as the Fiscalía records it, e.g. `ACTIVO`."},"flag":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A `SI` / `NO` marker the Fiscalía records on each offence, published as is; the Fiscalía does not document its meaning."}},"required":["name","article","grade","status","flag"]},"description":"The offences under investigation."},"actions":{"type":"array","items":{"type":"object","properties":{"action_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`YYYY-MM-DD`."},"action_type":{"type":"string","description":"The action, e.g. `FORMULACIÓN DE LA IMPUTACIÓN`."}},"required":["action_date","action_type"]},"description":"The case's non-reserved actions, newest first."},"actions_truncated":{"type":"boolean","description":"true when the Fiscalía published only part of a long history: the oldest actions are missing."},"last_action":{"anyOf":[{"type":"object","properties":{"action_type":{"type":"string"},"action_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The Fiscalía's numeric code for the action type."},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When it took place: ISO 8601, Colombian time."},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When it was recorded: ISO 8601, Colombian time."}},"required":["action_type","action_code","occurred_at","recorded_at"]},{"type":"null"}],"description":"The latest action, with its time of day."},"joined":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"true when the case was joined to another (conexidad)."},"joined_to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the case it was joined to."},"joined_to_case_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The Fiscalía's internal id for the case it was joined to."}},"required":["found","registration_number","case_id","restricted","status","status_code","status_reason","stage","stage_code","law","law_code","reserved","incident_at","incident_department","incident_municipality","assigned_office","crimes","actions","actions_truncated","last_action","joined","joined_to","joined_to_case_id"]},"FiscaliaCaseResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FiscaliaCaseData"}}},"AnmNoticesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"title_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"office":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The notice's permanent identifier: the name of its document as the ANM publishes it, e.g. \"GGDN-2026-P-0378.pdf\"."},"notice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number the ANM gives the notice, e.g. \"GGDN-2026-EST-165\" or \"EST-PARB-0123\". Formats vary by office."},"type":{"anyOf":[{"type":"string","enum":["estado","aviso","edicto","caracter_general"]},{"type":"null"}],"description":"The kind of notice: `estado`, `aviso`, `edicto` or `caracter_general`. Null when the ANM records none."},"office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ANM regional office that published the notice, as it names it, e.g. \"Bogotá\" or \"Cúcuta\"."},"office_key":{"anyOf":[{"type":"string","enum":["bogota","bucaramanga","cali","cartagena","cucuta","ibague","manizales","medellin","nobsa","pasto","quibdo","valledupar"]},{"type":"null"}],"description":"The same office as the slug the `office` filter takes, e.g. `cucuta`. Null when the ANM names an office this connector does not know."},"publication_date":{"type":"string","description":"`yyyy-mm-dd` the ANM published the notice."},"year":{"type":"number","description":"The year of publication."},"title_numbers":{"type":"array","items":{"type":"string"},"column":"string[]","description":"Every mining title or application number (placa) the notice covers, upper-case and without spaces, e.g. [\"ABC-12345\", \"DEF-678\"], which is what the `title_number` filter matches."},"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."},"document_url":{"type":"string","description":"The notice's document, as the ANM publishes it."},"official_url":{"type":"string","description":"The ANM's own page listing what it published that day."}},"required":["id","notice_number","type","office","office_key","publication_date","year","title_numbers","text_status","document_url","official_url"]}}},"required":["as_of","query","title_number","office","type","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"AnmNoticesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AnmNoticesSearchData"}}},"AnmNoticeData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"notice_id":{"type":"string"},"notice":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The notice's permanent identifier: the name of its document as the ANM publishes it, e.g. \"GGDN-2026-P-0378.pdf\"."},"notice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number the ANM gives the notice, e.g. \"GGDN-2026-EST-165\" or \"EST-PARB-0123\". Formats vary by office."},"type":{"anyOf":[{"type":"string","enum":["estado","aviso","edicto","caracter_general"]},{"type":"null"}],"description":"The kind of notice: `estado`, `aviso`, `edicto` or `caracter_general`. Null when the ANM records none."},"office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ANM regional office that published the notice, as it names it, e.g. \"Bogotá\" or \"Cúcuta\"."},"office_key":{"anyOf":[{"type":"string","enum":["bogota","bucaramanga","cali","cartagena","cucuta","ibague","manizales","medellin","nobsa","pasto","quibdo","valledupar"]},{"type":"null"}],"description":"The same office as the slug the `office` filter takes, e.g. `cucuta`. Null when the ANM names an office this connector does not know."},"publication_date":{"type":"string","description":"`yyyy-mm-dd` the ANM published the notice."},"year":{"type":"number","description":"The year of publication."},"title_numbers":{"type":"array","items":{"type":"string"},"column":"string[]","description":"Every mining title or application number (placa) the notice covers, upper-case and without spaces, e.g. [\"ABC-12345\", \"DEF-678\"], which is what the `title_number` filter matches."},"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."},"document_url":{"type":"string","description":"The notice's document, as the ANM publishes it."},"official_url":{"type":"string","description":"The ANM's own page listing what it published that day."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the notice'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 notice's text, or null when `text_status` is not `extracted`."}},"required":["id","notice_number","type","office","office_key","publication_date","year","title_numbers","text_status","document_url","official_url","content"]},{"type":"null"}]}},"required":["as_of","found","notice_id","notice"]},"AnmNoticeResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AnmNoticeData"}}},"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."},"records":{"type":"array","items":{"type":"object","properties":{"ruling_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ruling number (No. Fallo)."},"ruling_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ruling date (YYYY-MM-DD)."},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Amount of the ruling (Cuantía), in COP."},"affected_entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public entity that suffered the damage."},"reported_by":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Contraloría that reported the ruling."},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"responsibility_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Type of responsibility, e.g. \"DEUDA SOLIDARIA\"."}},"required":["ruling_number","ruling_date","amount","affected_entity","reported_by","department","municipality","responsibility_type"]},"description":"One entry per process the person is reported in; empty when not reported."},"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","records","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"}],"description":"In COP, as the registry publishes it: whole pesos, with centavos rounded by the source. The exact amount is on the official PDF (`include_pdf`)."},"taxes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"In COP, as the registry publishes it: whole pesos, with centavos rounded by the source. The exact amount is on the official PDF (`include_pdf`)."}},"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 PDF representation of the document. It may be password-protected by the issuer: try the issuer's NIT without check digit (`issuer.nit`), then the recipient's document number without check digit (`recipient.nit`), then the recipient's NIT with its check digit. 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":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registry's event code, e.g. `030` (acuse de recibo), `032` (recibo del bien o servicio), `033` (aceptación expresa)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The event's name as the registry prints it."},"date":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer":{"type":"object","properties":{"nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["nit","name"],"description":"Who issued the event, as the registry lists it: the event's emisor, which is not always the invoice's."},"recipient":{"type":"object","properties":{"nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["nit","name"],"description":"Who the event is addressed to: the event's receptor."},"cude":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The event's own document key (CUDE) in the registry."},"description":{"type":"string","description":"Every column of the row joined with ` · `. Prefer the structured fields."}},"required":["code","name","date","issuer","recipient","cude","description"]}}},"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"}}},"DianMuiscaElectronicInvoicesData":{"type":"object","properties":{"year":{"type":"number","description":"Echoes the tax year."},"cutoff_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date DIAN's figures were cut, `yyyy-mm-dd`."},"taxpayer":{"type":"object","properties":{"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The account holder's document type, as DIAN prints it, e.g. \"C. C.\"."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The account holder's document number, as DIAN prints it."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The account holder's name, as DIAN prints it."}},"required":["document_type","document_number","name"]},"count":{"type":"number","description":"Number of invoices returned."},"totals":{"type":"object","properties":{"invoiced_amount":{"type":"number"},"credit_notes_amount":{"type":"number"},"debit_notes_amount":{"type":"number"},"net_amount":{"type":"number"},"deductible_amount":{"type":"number"}},"required":["invoiced_amount","credit_notes_amount","debit_notes_amount","net_amount","deductible_amount"],"description":"Sums over the invoices returned, in COP."},"invoices":{"type":"array","items":{"type":"object","properties":{"issuer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or document of who issued the invoice."},"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of who issued the invoice."},"issued_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issue date, `yyyy-mm-dd`."},"invoiced_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Amount invoiced, in COP."},"credit_notes_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Credit notes applied to the invoice, in COP."},"debit_notes_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Debit notes applied to the invoice, in COP."},"net_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The invoice after credit and debit notes, in COP."},"deductible_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The part DIAN considers eligible for the tax benefit, in COP."},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Payment method as DIAN names it, e.g. \"Efectivo\" or \"Electrónicos\"."},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The invoice number."},"cufe":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The invoice's CUFE (código único de factura electrónica): the key."}},"required":["issuer_id","issuer_name","issued_on","invoiced_amount","credit_notes_amount","debit_notes_amount","net_amount","deductible_amount","payment_method","invoice_number","cufe"]}},"checked_at":{"type":"string","description":"When DIAN was read (ISO 8601)."}},"required":["year","cutoff_date","taxpayer","count","totals","invoices","checked_at"]},"DianMuiscaElectronicInvoicesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianMuiscaElectronicInvoicesData"}}},"DianMuiscaThirdPartyReportsData":{"type":"object","properties":{"year":{"type":"number","description":"Echoes the tax year."},"cutoff_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date DIAN's figures were cut, `yyyy-mm-dd`."},"generated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When DIAN generated the report, ISO 8601 in Bogotá time (`-05:00`)."},"taxpayer":{"type":"object","properties":{"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The account holder's document type, as DIAN prints it, e.g. \"C. C.\"."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The account holder's document number, as DIAN prints it."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The account holder's name, as DIAN prints it."}},"required":["document_type","document_number","name"]},"thresholds":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The threshold as DIAN names it, e.g. \"Tope 1 - Ingresos\"."},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its value, in COP."}},"required":["name","amount"]},"description":"DIAN's summary against the filing thresholds (topes); empty in years before 2023."},"count":{"type":"number","description":"Number of reports returned."},"reports":{"type":"array","items":{"type":"object","properties":{"reporter_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of the third party that reported."},"reporter_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the third party that reported."},"reported_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document the third party reported it under; null in years before 2023."},"reported_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name the third party reported it under."},"concept":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What was reported, e.g. \"Certificado - Pagos por salarios\" or \"Saldo cuentas bancarias\"."},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The amount reported, in COP."},"suggested_use":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where DIAN suggests it goes in the tax return; null in years before 2023."},"additional_info":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Extra detail DIAN attaches, e.g. an account number or ownership share; null in years before 2023."}},"required":["reporter_id","reporter_name","reported_id","reported_name","concept","amount","suggested_use","additional_info"]}},"checked_at":{"type":"string","description":"When DIAN was read (ISO 8601)."}},"required":["year","cutoff_date","generated_at","taxpayer","thresholds","count","reports","checked_at"]},"DianMuiscaThirdPartyReportsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianMuiscaThirdPartyReportsData"}}},"DianFacturacionAccessRequestData":{"type":"object","properties":{"sent":{"type":"boolean","description":"Whether DIAN accepted the request and sent the link."},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DIAN's own answer, in Spanish."},"expires_in_minutes":{"type":"number","description":"How long DIAN accepts the link once sent."},"requested_at":{"type":"string","description":"When the request was made (ISO 8601)."}},"required":["sent","message","expires_in_minutes","requested_at"]},"DianFacturacionAccessRequestResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianFacturacionAccessRequestData"}}},"DianFacturacionDocumentsData":{"type":"object","properties":{"from_date":{"type":"string","description":"Echoes the range's first day."},"to_date":{"type":"string","description":"Echoes the range's last day."},"taxpayer":{"type":"object","properties":{"nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The account's NIT (a company) or document number (a person)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The account's name, as DIAN shows it."}},"required":["nit","name"]},"count":{"type":"number","description":"Number of documents returned."},"by_type":{"type":"array","items":{"type":"object","properties":{"document_type":{"type":"string","description":"The document type as DIAN names it."},"count":{"type":"number"},"total":{"type":"number","description":"Sum of their totals."}},"required":["document_type","count","total"]},"description":"Counts and totals per document type."},"documents":{"type":"array","items":{"type":"object","properties":{"cufe":{"type":"string","description":"The document's CUFE or CUDE: the key."},"document_type_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DIAN's document type code, e.g. `01` invoice, `91` credit note, `92` debit note, `05` support document, `102` payroll, `96` event."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document type as DIAN names it, e.g. \"Factura electrónica\"."},"series":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The prefix (serie)."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The folio."},"issued_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issue date, `yyyy-mm-dd`."},"received_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When DIAN received it, ISO 8601 in Bogotá time (`-05:00`)."},"issuer":{"type":"object","properties":{"nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or document number."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["nit","name"],"description":"Who issued it."},"recipient":{"type":"object","properties":{"nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or document number."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["nit","name"],"description":"Who it is addressed to."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 4217 currency, e.g. `COP`."},"payment_form":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`1` cash (contado) or `2` credit (crédito), as DIAN codes it."},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DIAN's payment method code, e.g. `10` cash, `42` bank deposit, `47` transfer, `48` card."},"taxes":{"type":"object","properties":{"iva":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IVA, in the document's currency."},"ica":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ICA."},"ic":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Impuesto al consumo (IC)."},"inc":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Impuesto nacional al consumo (INC)."},"timbre":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Impuesto de timbre."},"inc_bolsas":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"INC on plastic bags."},"in_carbono":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Impuesto nacional al carbono."},"in_combustibles":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Impuesto nacional a los combustibles."},"ic_datos":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Impuesto al consumo de datos."},"icl":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Impuesto al consumo de licores (ICL)."},"inpp":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Impuesto nacional a productos plásticos (INPP)."},"ibua":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Impuesto a bebidas ultraprocesadas azucaradas (IBUA)."},"icui":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Impuesto a comestibles ultraprocesados (ICUI)."}},"required":["iva","ica","ic","inc","timbre","inc_bolsas","in_carbono","in_combustibles","ic_datos","icl","inpp","ibua","icui"],"description":"Taxes on the document, as DIAN totals them."},"withholdings":{"type":"object","properties":{"rete_iva":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IVA withheld (ReteIVA)."},"rete_renta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Income tax withheld (ReteRenta)."},"rete_ica":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ICA withheld (ReteICA)."}},"required":["rete_iva","rete_renta","rete_ica"],"description":"Withholdings on the document."},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The document's total."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DIAN's validation result, e.g. \"Aprobado\" or \"Aprobado con notificación\"."},"radian_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its state as a título valor (RADIAN), e.g. \"Factura Electrónica\", \"Titulo valor\", \"Endosada\", \"Pagada\"; \"No Aplica\" when it cannot be one."}},"required":["cufe","document_type_code","document_type","series","number","issued_on","received_at","issuer","recipient","currency","payment_form","payment_method","taxes","withholdings","total","status","radian_status"]}},"checked_at":{"type":"string","description":"When DIAN was read (ISO 8601)."}},"required":["from_date","to_date","taxpayer","count","by_type","documents","checked_at"]},"DianFacturacionDocumentsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianFacturacionDocumentsData"}}},"DianFacturacionDocumentData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the account has the document on that date; `false` leaves the rest empty."},"cufe":{"type":"string","description":"Echoes the CUFE or CUDE."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document type as DIAN names it."},"series":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issue date, `yyyy-mm-dd`."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issue date and time as the document states them (ISO 8601), when it carries them."},"due_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Payment due date, `yyyy-mm-dd`, when the document has one."},"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"]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"payment_form":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`1` cash or `2` credit, as DIAN codes it."},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DIAN's payment method code."},"notes":{"type":"array","items":{"type":"string"},"description":"Free-text notes on the document."},"lines":{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The line's number on the document."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The seller's item code, when given."},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit of measure code (UN/ECE), e.g. `94` unit."},"unit_price":{"anyOf":[{"type":"number"},{"type":"null"}]},"line_total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The line's amount before taxes."},"taxes":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The tax as the document names it, e.g. \"IVA\"."},"percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","percent","amount"]}}},"required":["number","code","description","quantity","unit","unit_price","line_total","taxes"]},"description":"The document's lines, from the document itself; empty when it carries none."},"totals":{"type":"object","properties":{"lines":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Sum of the lines before taxes."},"tax_exclusive":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The taxable base."},"tax_inclusive":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total with taxes."},"allowances":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Discounts at document level."},"charges":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Charges at document level."},"prepaid":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Advance payments."},"payable":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The amount payable."}},"required":["lines","tax_exclusive","tax_inclusive","allowances","charges","prepaid","payable"],"description":"The document's own monetary totals."},"taxes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","value"]},"description":"Taxes as DIAN's registry totals them."},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The total as DIAN's registry shows it."},"legitimate_holder":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The current legitimate holder (legítimo tenedor), for an invoice that is a título valor."},"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"]},"description":"DIAN's validations of the document."},"events":{"type":"array","items":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registry's event code, e.g. `030` (acuse de recibo), `032` (recibo del bien o servicio), `033` (aceptación expresa)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The event's name as the registry prints it."},"date":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer":{"type":"object","properties":{"nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["nit","name"],"description":"Who issued the event, as the registry lists it: the event's emisor, which is not always the invoice's."},"recipient":{"type":"object","properties":{"nit":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["nit","name"],"description":"Who the event is addressed to: the event's receptor."},"cude":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The event's own document key (CUDE) in the registry."},"description":{"type":"string","description":"Every column of the row joined with ` · `. Prefer the structured fields."}},"required":["code","name","date","issuer","recipient","cude","description"]},"description":"The document's events (acuse de recibo, recibo del bien, aceptación, endoso...)."},"xml":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's XML (UBL 2.1), as DIAN keeps it; null for a type DIAN does not hand out this way."},"pdf_base64":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's graphic representation (PDF), base64; null when DIAN gives none."},"checked_at":{"type":"string","description":"When DIAN was read (ISO 8601)."}},"required":["found","cufe","document_type","series","number","issued_on","issued_at","due_on","issuer","recipient","currency","payment_form","payment_method","notes","lines","totals","taxes","total","legitimate_holder","validations","events","xml","pdf_base64","checked_at"]},"DianFacturacionDocumentResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianFacturacionDocumentData"}}},"DianFacturacionMonthlyReportData":{"type":"object","properties":{"year":{"type":"number"},"month":{"type":"number"},"available":{"type":"boolean","description":"Whether DIAN has issued a report for the month."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DIAN's reference for the report, e.g. \"100153157-EF12-02696152\"."},"dated_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date DIAN dated the report, `yyyy-mm-dd`."},"cutoff_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date its figures were cut, `yyyy-mm-dd`."},"replaces_previous":{"type":"boolean","description":"Whether DIAN issued it to replace an earlier report for the same month."},"documents":{"type":"array","items":{"type":"object","properties":{"document_type":{"type":"string"},"issued":{"type":"object","properties":{"month_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"month_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"year_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Accumulated in the year up to the month."},"year_amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["month_count","month_amount","year_count","year_amount"]},"received":{"type":"object","properties":{"month_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"month_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"year_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Accumulated in the year up to the month."},"year_amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["month_count","month_amount","year_count","year_amount"]}},"required":["document_type","issued","received"]},"description":"Documents registered in the month and in the year so far, per type, issued and received."},"indicators":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string","description":"`yyyy-mm`."},"issued":{"type":"object","properties":{"count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Documents in the month."},"daily_average_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Documents per day (30-day months)."},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value of the operations: invoices and equivalents, plus debit notes, minus credit notes."},"daily_average_amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","daily_average_count","amount","daily_average_amount"]},"received":{"type":"object","properties":{"count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Documents in the month."},"daily_average_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Documents per day (30-day months)."},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value of the operations: invoices and equivalents, plus debit notes, minus credit notes."},"daily_average_amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","daily_average_count","amount","daily_average_amount"]}},"required":["month","issued","received"]},"description":"DIAN's indicators for the month and the two before it."},"checked_at":{"type":"string","description":"When DIAN was read (ISO 8601)."}},"required":["year","month","available","reference","dated_on","cutoff_date","replaces_previous","documents","indicators","checked_at"]},"DianFacturacionMonthlyReportResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianFacturacionMonthlyReportData"}}},"DianFacturacionProfileData":{"type":"object","properties":{"nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The account's NIT or document number."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The email DIAN has for the account."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its standing in DIAN's electronic-invoicing system, e.g. \"Habilitado\"."},"reception_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The email where the account receives electronic invoices."},"legal_representatives":{"type":"array","items":{"type":"object","properties":{"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["document_number","name","email"]}},"operation_modes":{"type":"array","items":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"software":{"anyOf":[{"type":"string"},{"type":"null"}]},"software_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["mode","registered_on","software","software_id"]},"description":"How the account issues: its own software, a technology provider's, or DIAN's free one."},"numbering_ranges":{"type":"array","items":{"type":"object","properties":{"provider":{"anyOf":[{"type":"string"},{"type":"null"}]},"software":{"anyOf":[{"type":"string"},{"type":"null"}]},"software_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"anyOf":[{"type":"string"},{"type":"null"}]},"resolution":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The DIAN numbering resolution."},"from_number":{"anyOf":[{"type":"number"},{"type":"null"}]},"to_number":{"anyOf":[{"type":"number"},{"type":"null"}]},"associated_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`."}},"required":["provider","software","software_id","document_type","prefix","resolution","from_number","to_number","associated_on","expires_on"]},"description":"The numbering ranges associated with the account's software."},"checked_at":{"type":"string","description":"When DIAN was read (ISO 8601)."}},"required":["nit","name","business_name","email","status","reception_email","legal_representatives","operation_modes","numbering_ranges","checked_at"]},"DianFacturacionProfileResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianFacturacionProfileData"}}},"DianTradeDirectorySearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"flow":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"tariff_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number","description":"Results on this page."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier: flow, year and NIT, e.g. `import-2025-899999068`. A natural person, whom DIAN publishes without a NIT, is identified by its rank instead: `import-2025-pn-34409`."},"flow":{"type":"string","enum":["import","export"],"description":"`import` (the directorio de importadores) or `export` (the directorio de exportadores)."},"year":{"type":"integer","description":"Year the directory covers, 2017 or later."},"through_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Last month the figures accumulate to (1-12). `12` for a closed year; the current year's directory is cumulative and republished as months close. Null when the directory does not state it."},"rank":{"type":"integer","description":"Position in that year's directory (Consecutivo), 1 for the largest value."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's NIT, numeric, no verification digit. Null for a natural person, whose identification DIAN does not publish."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as DIAN prints it that year. `PERSONA NATURAL` for a natural person."},"natural_person":{"type":"boolean","description":"True when DIAN recategorized the row as a natural person and published neither the identification nor the name."},"value_usd":{"type":"number","description":"Total value in US dollars for the year to `through_month`: CIF for imports, FOB for exports."},"value_basis":{"type":"string","enum":["CIF","FOB"],"description":"How `value_usd` is valued: `CIF` for imports, `FOB` for exports."},"net_weight_kg":{"type":"number","description":"Total net weight in kilograms."},"declarations":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Imports only: number of import declarations filed. Null on exports."},"declaration_items":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Exports only: number of registros, the series or items listed across the export declarations (not the number of declarations). Null on imports."},"top_tariff_codes":{"type":"array","items":{"type":"string"},"description":"The main subpartidas arancelarias imported or exported, up to five, in DIAN's order (Primera to Quinta), as 10-digit codes."},"top_tariff_headings":{"type":"array","items":{"type":"string"},"description":"The 4-digit headings (partidas) of `top_tariff_codes`, in order, without repeats."},"top_tariff_subheadings":{"type":"array","items":{"type":"string"},"description":"The 6-digit HS subheadings of `top_tariff_codes`, in order, without repeats."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` DIAN last updated that year's directory, as the directory states it. Null when it does not."}},"required":["id","flow","year","through_month","rank","document_number","name","natural_person","value_usd","value_basis","net_weight_kg","declarations","declaration_items","top_tariff_codes","top_tariff_headings","top_tariff_subheadings","updated_at"]},"description":"Newest year first, then by value, largest first."}},"required":["as_of","query","flow","year","tariff_code","total","total_is_exact","page","per_page","total_pages","count","results"]},"DianTradeDirectorySearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianTradeDirectorySearchData"}}},"DianTradeProfileData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"False when the NIT appears in no importers or exporters directory since 2017."},"document_number":{"type":"string","description":"Echoes the request's `document_number`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name in the most recent directory the company appears in."},"years":{"type":"array","items":{"type":"number"},"description":"Every year the company appears in either directory, newest first."},"imports":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier: flow, year and NIT, e.g. `import-2025-899999068`. A natural person, whom DIAN publishes without a NIT, is identified by its rank instead: `import-2025-pn-34409`."},"flow":{"type":"string","enum":["import","export"],"description":"`import` (the directorio de importadores) or `export` (the directorio de exportadores)."},"year":{"type":"integer","description":"Year the directory covers, 2017 or later."},"through_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Last month the figures accumulate to (1-12). `12` for a closed year; the current year's directory is cumulative and republished as months close. Null when the directory does not state it."},"rank":{"type":"integer","description":"Position in that year's directory (Consecutivo), 1 for the largest value."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's NIT, numeric, no verification digit. Null for a natural person, whose identification DIAN does not publish."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as DIAN prints it that year. `PERSONA NATURAL` for a natural person."},"natural_person":{"type":"boolean","description":"True when DIAN recategorized the row as a natural person and published neither the identification nor the name."},"value_usd":{"type":"number","description":"Total value in US dollars for the year to `through_month`: CIF for imports, FOB for exports."},"value_basis":{"type":"string","enum":["CIF","FOB"],"description":"How `value_usd` is valued: `CIF` for imports, `FOB` for exports."},"net_weight_kg":{"type":"number","description":"Total net weight in kilograms."},"declarations":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Imports only: number of import declarations filed. Null on exports."},"declaration_items":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Exports only: number of registros, the series or items listed across the export declarations (not the number of declarations). Null on imports."},"top_tariff_codes":{"type":"array","items":{"type":"string"},"description":"The main subpartidas arancelarias imported or exported, up to five, in DIAN's order (Primera to Quinta), as 10-digit codes."},"top_tariff_headings":{"type":"array","items":{"type":"string"},"description":"The 4-digit headings (partidas) of `top_tariff_codes`, in order, without repeats."},"top_tariff_subheadings":{"type":"array","items":{"type":"string"},"description":"The 6-digit HS subheadings of `top_tariff_codes`, in order, without repeats."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` DIAN last updated that year's directory, as the directory states it. Null when it does not."}},"required":["id","flow","year","through_month","rank","document_number","name","natural_person","value_usd","value_basis","net_weight_kg","declarations","declaration_items","top_tariff_codes","top_tariff_headings","top_tariff_subheadings","updated_at"]},"description":"The company's row in each year's importers directory, newest first."},"exports":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier: flow, year and NIT, e.g. `import-2025-899999068`. A natural person, whom DIAN publishes without a NIT, is identified by its rank instead: `import-2025-pn-34409`."},"flow":{"type":"string","enum":["import","export"],"description":"`import` (the directorio de importadores) or `export` (the directorio de exportadores)."},"year":{"type":"integer","description":"Year the directory covers, 2017 or later."},"through_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Last month the figures accumulate to (1-12). `12` for a closed year; the current year's directory is cumulative and republished as months close. Null when the directory does not state it."},"rank":{"type":"integer","description":"Position in that year's directory (Consecutivo), 1 for the largest value."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's NIT, numeric, no verification digit. Null for a natural person, whose identification DIAN does not publish."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as DIAN prints it that year. `PERSONA NATURAL` for a natural person."},"natural_person":{"type":"boolean","description":"True when DIAN recategorized the row as a natural person and published neither the identification nor the name."},"value_usd":{"type":"number","description":"Total value in US dollars for the year to `through_month`: CIF for imports, FOB for exports."},"value_basis":{"type":"string","enum":["CIF","FOB"],"description":"How `value_usd` is valued: `CIF` for imports, `FOB` for exports."},"net_weight_kg":{"type":"number","description":"Total net weight in kilograms."},"declarations":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Imports only: number of import declarations filed. Null on exports."},"declaration_items":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Exports only: number of registros, the series or items listed across the export declarations (not the number of declarations). Null on imports."},"top_tariff_codes":{"type":"array","items":{"type":"string"},"description":"The main subpartidas arancelarias imported or exported, up to five, in DIAN's order (Primera to Quinta), as 10-digit codes."},"top_tariff_headings":{"type":"array","items":{"type":"string"},"description":"The 4-digit headings (partidas) of `top_tariff_codes`, in order, without repeats."},"top_tariff_subheadings":{"type":"array","items":{"type":"string"},"description":"The 6-digit HS subheadings of `top_tariff_codes`, in order, without repeats."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` DIAN last updated that year's directory, as the directory states it. Null when it does not."}},"required":["id","flow","year","through_month","rank","document_number","name","natural_person","value_usd","value_basis","net_weight_kg","declarations","declaration_items","top_tariff_codes","top_tariff_headings","top_tariff_subheadings","updated_at"]},"description":"The company's row in each year's exporters directory, newest first."}},"required":["as_of","found","document_number","name","years","imports","exports"]},"DianTradeProfileResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianTradeProfileData"}}},"VuceTariffData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when VUCE holds no subpartida under that code."},"tariff_code":{"type":"string","description":"The subpartida asked for, digits only."},"checked_at":{"type":"string","description":"When VUCE was last asked for this subpartida."},"served_from":{"type":"string","enum":["copy","upstream","stale"],"description":"`copy`: answered from Croma's stored answer; `upstream`: VUCE was read for this call; `stale`: VUCE could not be read and the stored answer stood in."},"tariff":{"anyOf":[{"type":"object","properties":{"tariff_code":{"type":"string","description":"The 10-digit subpartida arancelaria."},"chapter":{"type":"string","description":"The chapter of the tariff: the subpartida's first two digits."},"heading":{"type":"string","description":"The partida: the subpartida's first four digits, e.g. `6101`."},"hs_code":{"type":"string","description":"The 6-digit Harmonized System subheading the subpartida falls under, e.g. `610190`. The same worldwide."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subpartida's description in the latest tariff decree."},"import_regime":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The import regime, e.g. \"LIBRE\" (free import) or \"PREVIA\" (prior license)."},"requires_import_license":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the regime is `PREVIA`: importing needs a prior import license from MinCIT. False when it is `LIBRE`. Null for any other regime."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the subpartida is in force, e.g. \"Activo\", as VUCE prints it."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The decree that sets the tariff, e.g. \"Decreto 1881 DE 2021-12-30\"."},"license_validity_months":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How many months an import license or registration for this subpartida is valid."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A note on the subpartida, such as the trade agreements and quotas that apply to it."},"approvals_regulation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The regulation in force for the vistos buenos, e.g. \"CIRCULAR 004 DE 08 MARZO DE 2024\"."},"requires_approvals":{"type":"boolean","description":"True when at least one entity must approve (visto bueno) the import."},"authorities":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The entity as VUCE names it, e.g. \"INVIMA\", \"GRUPOICA\", \"MJD\"."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's full name, e.g. \"Instituto Colombiano Agropecuario (ICA)\". Null for a code Croma does not recognize yet."}},"required":["code","name"]},"description":"The distinct entities that must approve the import, in the order VUCE lists them."},"approvals":{"type":"array","items":{"type":"object","properties":{"authority":{"type":"string","description":"The entity that issues the visto bueno, as VUCE names it, e.g. \"INVIMA\", \"ICA\", \"FNE\", \"GRUPOICA\"."},"authority_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's full name. Null for a code Croma does not recognize yet."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which goods under the subpartida the requirement covers, in the entity's words."},"control":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of control, e.g. \"VB\" (visto bueno)."},"prior_requirement":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What must be obtained before importing, e.g. \"Registro Sanitario (RS)\" or \"DZI\" (documento zoosanitario de importación)."},"prior_requirement_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the prior requirement is met."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norms the requirement rests on."},"marginal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the requirement applies (notas marginales)."},"observation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Further remarks from the entity."},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The group the entity files the requirement under, e.g. \"Pecuaria\"."}},"required":["authority","authority_name","description","control","prior_requirement","prior_requirement_description","legal_basis","marginal_notes","observation","group"]},"description":"Every entity that must approve (visto bueno) an import under this subpartida, with what it requires. Empty when none does."},"minimum_descriptions":{"type":"array","items":{"type":"object","properties":{"authority":{"type":"string","description":"The entity that sets the minimum description, e.g. \"MinCIT/DIAN\"."},"control":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The control code, e.g. \"DM\" (descripción mínima)."},"control_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the control is, e.g. \"Cumplimiento DM\"."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm that sets it."}},"required":["authority","control","control_description","legal_basis"]},"description":"The minimum-description controls that apply to the goods in the import declaration."},"minimum_description_sections":{"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The goods the section applies to, e.g. \"IX. Confecciones A. Prendas de vestir de los Capítulos 61 y 62\". Null for a section with no title."},"fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"What the declaration must state, e.g. \"Composición porcentual\"."},"guidance":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How to state it, as the regulation words it, e.g. \"Ejemplo: 70% algodón y 30% poliéster\"."}},"required":["label","guidance"]},"description":"What the declaration must state about those goods, in the regulation's order."}},"required":["title","fields"]},"description":"`minimum_description_text` split into its sections and the fields each one requires."},"minimum_description_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the import declaration must describe about the goods (descripción mínima), verbatim as the regulation lists it for the subpartida's chapter."},"additional_information":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"General guidance VUCE shows with every subpartida, such as the rules on describing goods and on special validity periods."},"checked_at":{"type":"string"}},"required":["tariff_code","chapter","heading","hs_code","description","import_regime","requires_import_license","status","legal_basis","license_validity_months","note","approvals_regulation","requires_approvals","authorities","approvals","minimum_descriptions","minimum_description_sections","minimum_description_text","additional_information","checked_at"]},{"type":"null"}]}},"required":["found","tariff_code","checked_at","served_from","tariff"]},"VuceTariffResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/VuceTariffData"}}},"DianArancelTariffData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when DIAN holds no subpartida under that code, or the subpartida was not in force on the date asked."},"tariff_code":{"type":"string","description":"The subpartida asked for, digits only."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date asked for, `YYYY-MM-DD`. Null when no date was given: the rates in force today."},"checked_at":{"type":"string","description":"When DIAN was last asked for this subpartida."},"served_from":{"type":"string","enum":["copy","upstream","stale"],"description":"`copy`: answered from Croma's stored answer; `upstream`: DIAN was read for this call; `stale`: DIAN could not be read and the stored answer stood in."},"tariff":{"anyOf":[{"type":"object","properties":{"tariff_code":{"type":"string","description":"The 10-digit subpartida arancelaria."},"as_of":{"type":"string","description":"The day the rates are those in force on, `YYYY-MM-DD`: the date asked, or the day DIAN was read when no date was given."},"chapter":{"type":"string","description":"The chapter of the tariff: the subpartida's first two digits."},"heading":{"type":"string","description":"The partida: the subpartida's first four digits, e.g. `6101`."},"hs_code":{"type":"string","description":"The 6-digit Harmonized System subheading the subpartida falls under, e.g. `610190`. The same worldwide."},"nomenclature":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The nomenclature the code belongs to, e.g. \"ARIAN\" (the Colombian customs tariff)."},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The first day it applies, as `YYYY-MM-DD`."},"valid_to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The last day it applies, as `YYYY-MM-DD`. Null while it has no end date."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm it rests on, as DIAN cites it, e.g. \"DECRETO 2598 DEL 23-DIC-2022, MINISTERIO DE COMERCIO INDUSTRIA Y TURISMO. DIARIO OFICIAL NO. 52257 PÁG. 1\". Null when DIAN cites none."},"official_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subpartida's official text (texto oficial), from the chapter down to the subpartida, one level per line."},"official_text_levels":{"type":"array","items":{"type":"string"},"description":"`official_text` split into its levels: the chapter, the heading, then each dashed sub-level down to the subpartida."},"official_text_valid_from":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The first day it applies, as `YYYY-MM-DD`."},"official_text_valid_to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The last day it applies, as `YYYY-MM-DD`. Null while it has no end date."},"official_text_legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm it rests on, as DIAN cites it, e.g. \"DECRETO 2598 DEL 23-DIC-2022, MINISTERIO DE COMERCIO INDUSTRIA Y TURISMO. DIARIO OFICIAL NO. 52257 PÁG. 1\". Null when DIAN cites none."},"physical_unit":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","description":"The unit's code, e.g. \"u\" or \"kg\"."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit's name, e.g. \"Unidades o artículos\" or \"Kilogramo\"."},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The first day it applies, as `YYYY-MM-DD`."},"valid_to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The last day it applies, as `YYYY-MM-DD`. Null while it has no end date."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm it rests on, as DIAN cites it, e.g. \"DECRETO 2598 DEL 23-DIC-2022, MINISTERIO DE COMERCIO INDUSTRIA Y TURISMO. DIARIO OFICIAL NO. 52257 PÁG. 1\". Null when DIAN cites none."}},"required":["code","name","valid_from","valid_to","legal_basis"]},{"type":"null"}],"description":"The physical unit (unidad física) quantities under the subpartida are declared in."},"import_duties":{"type":"array","items":{"type":"object","properties":{"concept":{"type":"string","description":"What the rate is, e.g. \"GRAVAMEN ARANCELARIO\"."},"rate":{"type":"string","description":"The rate or formula verbatim, e.g. \"40 %\"."},"rate_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The rate as a number of percent, e.g. `40`. Null when the rate is not a plain percentage."},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The first day it applies, as `YYYY-MM-DD`."},"valid_to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The last day it applies, as `YYYY-MM-DD`. Null while it has no end date."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm it rests on, as DIAN cites it, e.g. \"DECRETO 2598 DEL 23-DIC-2022, MINISTERIO DE COMERCIO INDUSTRIA Y TURISMO. DIARIO OFICIAL NO. 52257 PÁG. 1\". Null when DIAN cites none."}},"required":["concept","rate","rate_percent","valid_from","valid_to","legal_basis"]},"description":"The general import duty (gravamen arancelario) in force, with its validity and the decree behind it."},"import_duty_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The general import duty in force today, as a number of percent. Null when DIAN lists none or it is not a plain percentage."},"vat_rates":{"type":"array","items":{"type":"object","properties":{"applies_to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The goods under the subpartida the rate covers, when DIAN splits the subpartida into several rates. Null when one rate covers it all."},"rate":{"type":"string","description":"The rate verbatim, e.g. \"19%\" or \"0 % - EXCLUIDO\"."},"rate_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The rate as a number of percent, e.g. `19` or `0`. Null when the rate is not a plain percentage."},"treatment":{"anyOf":[{"type":"string","enum":["EXENTO","EXCLUIDO"]},{"type":"null"}],"description":"`EXENTO` (exempt, taxed at 0 %) or `EXCLUIDO` (excluded from VAT), when the rate says so. Null for a taxed rate."},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The first day it applies, as `YYYY-MM-DD`."},"valid_to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The last day it applies, as `YYYY-MM-DD`. Null while it has no end date."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm it rests on, as DIAN cites it, e.g. \"DECRETO 2598 DEL 23-DIC-2022, MINISTERIO DE COMERCIO INDUSTRIA Y TURISMO. DIARIO OFICIAL NO. 52257 PÁG. 1\". Null when DIAN cites none."}},"required":["applies_to","rate","rate_percent","treatment","valid_from","valid_to","legal_basis"]},"description":"The VAT (IVA) on imports in force, with its validity and the law behind it. More than one when DIAN splits the subpartida by product."},"agreement_duties":{"type":"array","items":{"type":"object","properties":{"agreement_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DIAN's code for the trade agreement, e.g. \"096\"."},"agreement":{"type":"string","description":"The trade agreement, e.g. \"TLC. con EEUU - cód acuerdo 096- general\"."},"country":{"type":"string","description":"The country of origin the preferential rate applies to, e.g. \"ESTADOS UNIDOS\"."},"concept":{"type":"string","description":"What the rate is, e.g. \"GRAVAMEN ARANCELARIO\"."},"rate":{"type":"string","description":"The preferential rate verbatim, e.g. \"0.00 %\"."},"rate_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The preferential rate as a number of percent. Null when the rate is not a plain percentage."},"preference_index":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The preference index (índice) verbatim, e.g. \"77.00 %\". Null when DIAN lists none."},"preference_index_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The preference index as a number of percent."},"pid_rate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The PID rate (tasa PID) verbatim. Null when DIAN lists none."},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The first day it applies, as `YYYY-MM-DD`."},"valid_to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The last day it applies, as `YYYY-MM-DD`. Null while it has no end date."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm it rests on, as DIAN cites it, e.g. \"DECRETO 2598 DEL 23-DIC-2022, MINISTERIO DE COMERCIO INDUSTRIA Y TURISMO. DIARIO OFICIAL NO. 52257 PÁG. 1\". Null when DIAN cites none."}},"required":["agreement_code","agreement","country","concept","rate","rate_percent","preference_index","preference_index_percent","pid_rate","valid_from","valid_to","legal_basis"]},"description":"The preferential import duty under each trade agreement, one entry per agreement and country of origin, with its validity."},"trade_regimes":{"type":"array","items":{"type":"object","properties":{"regime":{"type":"string","description":"The trade regime for imports, e.g. \"LIBRE IMPORTACIÓN\"."},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The first day it applies, as `YYYY-MM-DD`."},"valid_to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The last day it applies, as `YYYY-MM-DD`. Null while it has no end date."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm it rests on, as DIAN cites it, e.g. \"DECRETO 2598 DEL 23-DIC-2022, MINISTERIO DE COMERCIO INDUSTRIA Y TURISMO. DIARIO OFICIAL NO. 52257 PÁG. 1\". Null when DIAN cites none."}},"required":["regime","valid_from","valid_to","legal_basis"]},"description":"The trade regime for imports (régimen de comercio) in force, with its validity and the norm behind it."},"checked_at":{"type":"string"}},"required":["tariff_code","as_of","chapter","heading","hs_code","nomenclature","valid_from","valid_to","legal_basis","official_text","official_text_levels","official_text_valid_from","official_text_valid_to","official_text_legal_basis","physical_unit","import_duties","import_duty_percent","vat_rates","agreement_duties","trade_regimes","checked_at"]},{"type":"null"}]}},"required":["found","tariff_code","date","checked_at","served_from","tariff"]},"DianArancelTariffResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DianArancelTariffData"}}},"DaneLabourMarketData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"territory_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"territory_level":{"anyOf":[{"type":"string"},{"type":"null"}]},"indicator_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"period_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"domain":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"series_id":{"type":"string","description":"The observation: period type, territory, domain, indicator and period, e.g. \"monthly:nacional:total:unemployment_rate:2026-08\"."},"territory_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DIVIPOLA code: 2 digits for a department, 5 for a municipality. A metropolitan area carries its core municipality's code. Null for the national total, regions and groups of cities."},"territory_name":{"type":"string","description":"The territory as DANE names it, e.g. \"Bogotá D.C.\", \"Medellín A.M.\", \"La Guajira\", \"Caribe\"."},"territory_level":{"type":"string","enum":["national","region","department","metropolitan_area","city","city_aggregate"],"description":"`national`, `region`, `department`, `metropolitan_area`, `city` or `city_aggregate`."},"domain":{"type":"string","enum":["total","urban","rural"],"description":"`total`, `urban` (cabeceras) or `rural` (centros poblados y rural disperso)."},"indicator_code":{"type":"string","description":"The indicator, e.g. `unemployment_rate` (TD), `employment_rate` (TO), `participation_rate` (TGP), `population`."},"indicator":{"type":"string","description":"The indicator as DANE names it, e.g. \"Tasa de Desocupación (TD)\"."},"unit":{"type":"string","enum":["percent","thousands_of_people"],"description":"`percent` for rates and shares, `thousands_of_people` for populations."},"period_type":{"type":"string","enum":["monthly","rolling_quarter","rolling_year"],"description":"`monthly`, `rolling_quarter` (the three months ending in `period`) or `rolling_year` (the twelve months ending in `period`)."},"period":{"type":"string","description":"`yyyy-mm`: the month, or the last month of the rolling window."},"period_start":{"type":"string","description":"`yyyy-mm-01` of `period`: what `from_date` and `to_date` filter on."},"year":{"type":"number","description":"The year of `period`."},"value":{"type":"number","description":"The value as DANE published it."},"release":{"type":"string","description":"`yyyy-mm`: the monthly release this value was read from."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The DANE workbook this value comes from, exactly as DANE published it, always available at this link."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The same workbook's link at DANE."}},"required":["series_id","territory_code","territory_name","territory_level","domain","indicator_code","indicator","unit","period_type","period","period_start","year","value","release","document_url","source_document_url"]}}},"required":["as_of","territory_code","territory_level","indicator_code","period_type","domain","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"DaneLabourMarketResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DaneLabourMarketData"}}},"DanePovertyData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"territory_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"territory_level":{"anyOf":[{"type":"string"},{"type":"null"}]},"indicator_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"domain":{"anyOf":[{"type":"string"},{"type":"null"}]},"year_from":{"anyOf":[{"type":"number"},{"type":"null"}]},"year_to":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"series_id":{"type":"string","description":"The observation: territory, domain, indicator and year, e.g. \"44:total:multidimensional_poverty_rate:2025\"."},"territory_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DIVIPOLA code: 2 digits for a department, 5 for a municipality. A metropolitan area carries its core municipality's code. Null for the national total, regions and groups of cities."},"territory_name":{"type":"string","description":"The territory as DANE names it, e.g. \"Bogotá D.C.\", \"Medellín A.M.\", \"La Guajira\", \"Caribe\"."},"territory_level":{"type":"string","enum":["national","region","department","metropolitan_area","city","city_aggregate"],"description":"`national`, `region`, `department`, `metropolitan_area`, `city` or `city_aggregate`."},"domain":{"type":"string","enum":["total","urban","rural"],"description":"`total`, `urban` (cabeceras) or `rural` (centros poblados y rural disperso)."},"indicator_code":{"type":"string","description":"The indicator, e.g. `monetary_poverty_rate`, `extreme_poverty_rate`, `multidimensional_poverty_rate`, `gini`."},"indicator":{"type":"string","description":"The indicator as DANE names it, e.g. \"Incidencia de la pobreza monetaria\"."},"unit":{"type":"string","enum":["percent","thousands_of_people","cop_per_month","coefficient"],"description":"`percent`, `thousands_of_people`, `cop_per_month` (current pesos per person per month) or `coefficient` (Gini, 0 to 1)."},"year":{"type":"number","description":"The year the value measures."},"value":{"type":"number","description":"The value as DANE published it."},"release":{"type":"string","description":"The annual release this value was read from, e.g. \"2025\"."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The DANE workbook this value comes from, exactly as DANE published it, always available at this link."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The same workbook's link at DANE."}},"required":["series_id","territory_code","territory_name","territory_level","domain","indicator_code","indicator","unit","year","value","release","document_url","source_document_url"]}}},"required":["as_of","territory_code","territory_level","indicator_code","domain","year_from","year_to","total","total_is_exact","page","per_page","total_pages","count","results"]},"DanePovertyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DanePovertyData"}}},"DaneMunicipalIpmData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"territory_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"query":{"type":"string"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"territory_code":{"type":"string","description":"5-digit DIVIPOLA code of the municipality."},"territory_name":{"type":"string","description":"The municipality as DANE names it, e.g. \"RIOHACHA\"."},"department_code":{"type":"string","description":"2-digit DIVIPOLA code of the department."},"department_name":{"type":"string"},"year":{"type":"number","description":"2018: the census the index is computed from."},"ipm":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Multidimensional poverty index: percent of people in multidimensionally poor households."},"ipm_urban":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Same, in the cabecera."},"ipm_rural":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Same, in centros poblados y rural disperso."},"deprivations":{"type":"array","items":{"type":"object","properties":{"indicator_code":{"type":"string","description":"The deprivation, e.g. `illiteracy`, `informal_work`, `no_health_insurance`."},"indicator":{"type":"string","description":"The deprivation as DANE names it, e.g. \"Analfabetismo\"."},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percent of people in deprived households, whole municipality."},"urban":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Same, in the cabecera."},"rural":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Same, in centros poblados y rural disperso."}},"required":["indicator_code","indicator","total","urban","rural"]},"description":"The fifteen deprivations behind the index."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The DANE workbook this value comes from, exactly as DANE published it, always available at this link."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The same workbook's link at DANE."}},"required":["territory_code","territory_name","department_code","department_name","year","ipm","ipm_urban","ipm_rural","deprivations","document_url","source_document_url"]}}},"required":["as_of","territory_code","query","total","total_is_exact","page","per_page","total_pages","count","results"]},"DaneMunicipalIpmResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DaneMunicipalIpmData"}}},"DaneCensusMunicipalitiesData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"territory_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"query":{"type":"string"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"territory_code":{"type":"string","description":"5-digit DIVIPOLA code of the municipality."},"territory_name":{"type":"string","description":"The municipality as DANE names it, e.g. \"RIOHACHA\"."},"department_code":{"type":"string","description":"2-digit DIVIPOLA code of the department."},"department_name":{"type":"string"},"year":{"type":"number","description":"2018: the census year."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude of the municipality's centroid."},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude of the municipality's centroid."},"area_km2":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Area of the municipality in square kilometres."},"population":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"People counted."},"men":{"anyOf":[{"type":"number"},{"type":"null"}]},"women":{"anyOf":[{"type":"number"},{"type":"null"}]},"in_households":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"People in private households."},"in_group_quarters":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"People in group quarters (LEA: institutions, barracks, prisons)."}},"required":["total","men","women","in_households","in_group_quarters"]},"age":{"type":"object","properties":{"from_0_to_9":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_10_to_19":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_20_to_29":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_30_to_39":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_40_to_49":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_50_to_59":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_60_to_69":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_70_to_79":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_80":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["from_0_to_9","from_10_to_19","from_20_to_29","from_30_to_39","from_40_to_49","from_50_to_59","from_60_to_69","from_70_to_79","from_80"]},"education":{"type":"object","properties":{"primary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"People whose last level reached is preschool or primary."},"secondary":{"anyOf":[{"type":"number"},{"type":"null"}]},"higher":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Technical, technological or university."},"postgraduate":{"anyOf":[{"type":"number"},{"type":"null"}]},"none":{"anyOf":[{"type":"number"},{"type":"null"}]},"unknown":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["primary","secondary","higher","postgraduate","none","unknown"]},"households":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Households counted."},"dwellings":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Dwellings counted."},"house":{"anyOf":[{"type":"number"},{"type":"null"}]},"apartment":{"anyOf":[{"type":"number"},{"type":"null"}]},"room":{"anyOf":[{"type":"number"},{"type":"null"}]},"indigenous_traditional":{"anyOf":[{"type":"number"},{"type":"null"}]},"ethnic_traditional":{"anyOf":[{"type":"number"},{"type":"null"}]},"other":{"anyOf":[{"type":"number"},{"type":"null"}]},"occupied":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Occupied with people present."},"occupied_absent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Occupied with every person absent."},"temporary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Temporary use (holidays, work)."},"vacant":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["total","house","apartment","room","indigenous_traditional","ethnic_traditional","other","occupied","occupied_absent","temporary","vacant"]},"services":{"type":"object","properties":{"electricity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Dwellings with electricity."},"no_electricity":{"anyOf":[{"type":"number"},{"type":"null"}]},"water":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Dwellings with piped water (acueducto)."},"no_water":{"anyOf":[{"type":"number"},{"type":"null"}]},"sewerage":{"anyOf":[{"type":"number"},{"type":"null"}]},"no_sewerage":{"anyOf":[{"type":"number"},{"type":"null"}]},"gas":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Dwellings with piped natural gas."},"no_gas":{"anyOf":[{"type":"number"},{"type":"null"}]},"garbage_collection":{"anyOf":[{"type":"number"},{"type":"null"}]},"no_garbage_collection":{"anyOf":[{"type":"number"},{"type":"null"}]},"internet":{"anyOf":[{"type":"number"},{"type":"null"}]},"no_internet":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["electricity","no_electricity","water","no_water","sewerage","no_sewerage","gas","no_gas","garbage_collection","no_garbage_collection","internet","no_internet"]},"estrato":{"type":"object","properties":{"e1":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Dwellings billed for electricity in estrato 1."},"e2":{"anyOf":[{"type":"number"},{"type":"null"}]},"e3":{"anyOf":[{"type":"number"},{"type":"null"}]},"e4":{"anyOf":[{"type":"number"},{"type":"null"}]},"e5":{"anyOf":[{"type":"number"},{"type":"null"}]},"e6":{"anyOf":[{"type":"number"},{"type":"null"}]},"unknown":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Dwellings that do not know or have no estrato."}},"required":["e1","e2","e3","e4","e5","e6","unknown"]},"units":{"type":"object","properties":{"residential":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Units used as dwellings."},"mixed":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Units used as dwellings and for another use."},"non_residential":{"anyOf":[{"type":"number"},{"type":"null"}]},"group_quarters":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["residential","mixed","non_residential","group_quarters"]}},"required":["territory_code","territory_name","department_code","department_name","year","latitude","longitude","area_km2","population","age","education","households","dwellings","services","estrato","units"]}}},"required":["as_of","territory_code","query","total","total_is_exact","page","per_page","total_pages","count","results"]},"DaneCensusMunicipalitiesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DaneCensusMunicipalitiesData"}}},"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","page","per_page","total_pages","count","number","edition","published_from","published_to","results"]},"ImprentaDiariosResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ImprentaDiariosData"}}},"IgacPropertiesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"query":{"type":"string"},"block_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"economic_destination":{"anyOf":[{"type":"string"},{"type":"null"}]},"zone":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_cadastral_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"cadastral_number":{"type":"string","description":"The 30-digit número predial nacional that identifies the property, e.g. `170130001000000010001000000000`."},"previous_cadastral_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The 20-digit number the property had before the national numbering, when IGAC keeps it."},"department_code":{"type":"string","description":"Two-digit DANE department code, the first two digits of the number."},"municipality_code":{"type":"string","description":"Five-digit DANE municipality code, the first five digits of the number."},"zone":{"type":"string","enum":["urban","rural"],"description":"`urban` or `rural`, from digits 6 and 7 of the number (`00` is rural)."},"zone_code":{"type":"string","description":"Digits 6 and 7 of the number: `00` rural, `01` the main urban area, higher codes other urban centres (corregimientos)."},"sector_code":{"type":"string","description":"Digits 8 and 9: the cadastral sector."},"block_code":{"type":"string","description":"The first 17 digits: the manzana (urban) or vereda (rural) the property sits in. Every property of one block shares it."},"condition_code":{"type":"string","description":"Digit 22, the property's condition: `0` a plain property, `9` a unit under propiedad horizontal, other codes for condominiums, improvements and public goods."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address or the name of the farm, as IGAC records it."},"economic_destination_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IGAC's economic destination code, e.g. `A` housing, `C` commerce, `D` agricultural; `economic_destination` spells it out."},"economic_destination":{"anyOf":[{"type":"string"},{"type":"null"}]},"land_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Land area in m²."},"built_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Built area in m², every unit together."},"land_zones":{"type":"array","items":{"type":"object","properties":{"physical_zone_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The homogeneous physical zone the land falls in, as IGAC codes it (`000` when none)."},"economic_zone_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The homogeneous geoeconomic zone, which fixes the land value per m² or hectare used in the appraisal."},"area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The land area in that zone, m²."}},"required":["physical_zone_code","economic_zone_code","area_m2"]},"description":"The homogeneous zones the land falls in, with the area in each."},"buildings":{"type":"array","items":{"type":"object","properties":{"rooms":{"anyOf":[{"type":"number"},{"type":"null"}]},"bathrooms":{"anyOf":[{"type":"number"},{"type":"null"}]},"shops":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Commercial units (locales)."},"floors":{"anyOf":[{"type":"number"},{"type":"null"}]},"typology_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IGAC's construction typology code."},"use_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IGAC's use code; `use` spells it out."},"use":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the unit is used as, e.g. `Vivienda hasta 3 pisos`, `Comercio`, `Industrias`."},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The construction's quality score (puntaje), 0 to 100, which drives its value in the appraisal."},"built_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["rooms","bathrooms","shops","floors","typology_code","use_code","use","score","built_area_m2"]},"description":"Every building unit IGAC has qualified on the property."},"building_count":{"type":"number"}},"required":["cadastral_number","previous_cadastral_number","department_code","municipality_code","zone","zone_code","sector_code","block_code","condition_code","address","economic_destination_code","economic_destination","land_area_m2","built_area_m2","land_zones","buildings","building_count"]}}},"required":["as_of","municipality_code","query","block_code","economic_destination","zone","previous_cadastral_number","total","total_is_exact","page","per_page","total_pages","count","results"]},"IgacPropertiesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacPropertiesSearchData"}}},"IgacPropertyData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when IGAC has no property under that number (gestores propios such as Bogotá, Medellín, Cali or Antioquia are not IGAC's)."},"cadastral_number":{"type":"string"},"checked_at":{"type":"string","description":"When IGAC was last asked for this property."},"served_from":{"type":"string","enum":["copy","upstream","stale"],"description":"`copy`: answered from Croma's stored answer; `upstream`: IGAC was read for this call; `stale`: IGAC could not be read and the stored answer stood in."},"property":{"anyOf":[{"type":"object","properties":{"cadastral_number":{"type":"string","description":"The 30-digit número predial nacional."},"previous_cadastral_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Municipio, Departamento` as IGAC names it."},"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"land_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}]},"built_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}]},"economic_destination_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"economic_destination":{"anyOf":[{"type":"string"},{"type":"null"}]},"appraisal":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The current avalúo catastral in Colombian pesos, as IGAC holds it for the property. Null when IGAC states none."},"vigencia":{"description":"The vigencia of the avalúo and where the municipality's cadastre stands for the property's zone. Compare avalúos only within the same process and update year: one carried forward since an old update is not comparable with one just re-estimated. Null when IGAC's statistics do not cover the municipality.","anyOf":[{"type":"object","properties":{"year":{"type":"number","description":"The vigencia the avalúo belongs to: the year IGAC was asked, since an avalúo catastral takes effect on 1 January."},"zone":{"type":"string","enum":["urban","rural"],"description":"The part of the municipality the property sits in, which has a cadastral process of its own."},"process":{"anyOf":[{"type":"string","enum":["formacion","actualizacion","conservacion"]},{"type":"null"}],"description":"Where the zone's cadastre stands: `formacion` when it has not been formed, `actualizacion` when the update took effect this vigencia, `conservacion` when the avalúo has been carried forward since `update_year`. Null when IGAC reports no status."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cadastral status as IGAC reports it: `Actualizado Total`, `Desactualizado`, `Por Formar` and others."},"update_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The vigencia of the zone's last formación or actualización. Null when it has had none."},"years_since_update":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"`year` minus `update_year`: how long the avalúo has been carried forward instead of re-estimated."},"reported_year":{"type":"number","description":"The year of IGAC's municipal statistics the status comes from."}},"required":["year","zone","process","status","update_year","years_since_update","reported_year"]},{"type":"null"}]},"buildings":{"type":"array","items":{"type":"object","properties":{"area_m2":{"anyOf":[{"type":"number"},{"type":"null"}]},"use_code":{"anyOf":[{"type":"number"},{"type":"null"}]},"use":{"anyOf":[{"type":"string"},{"type":"null"}]},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Quality score (puntaje), 0 to 100."},"floors":{"anyOf":[{"type":"number"},{"type":"null"}]},"rooms":{"anyOf":[{"type":"number"},{"type":"null"}]},"shops":{"anyOf":[{"type":"number"},{"type":"null"}]},"bathrooms":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["area_m2","use_code","use","score","floors","rooms","shops","bathrooms"]}},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"checked_at":{"type":"string"}},"required":["cadastral_number","previous_cadastral_number","department_code","municipality_code","municipality","address","land_area_m2","built_area_m2","economic_destination_code","economic_destination","appraisal","buildings","latitude","longitude","geometry","checked_at"]},{"type":"null"}]}},"required":["found","cadastral_number","checked_at","served_from","property"]},"IgacPropertyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacPropertyData"}}},"IgacPropertyByPointData":{"type":"object","properties":{"found":{"type":"boolean"},"latitude":{"type":"number"},"longitude":{"type":"number"},"cadastral_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The property IGAC's cadastre draws at that point, null when no IGAC parcel contains it."},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"served_from":{"anyOf":[{"type":"string","enum":["copy","upstream","stale"]},{"type":"null"}]},"property":{"anyOf":[{"type":"object","properties":{"cadastral_number":{"type":"string","description":"The 30-digit número predial nacional."},"previous_cadastral_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Municipio, Departamento` as IGAC names it."},"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"land_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}]},"built_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}]},"economic_destination_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"economic_destination":{"anyOf":[{"type":"string"},{"type":"null"}]},"appraisal":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The current avalúo catastral in Colombian pesos, as IGAC holds it for the property. Null when IGAC states none."},"vigencia":{"description":"The vigencia of the avalúo and where the municipality's cadastre stands for the property's zone. Compare avalúos only within the same process and update year: one carried forward since an old update is not comparable with one just re-estimated. Null when IGAC's statistics do not cover the municipality.","anyOf":[{"type":"object","properties":{"year":{"type":"number","description":"The vigencia the avalúo belongs to: the year IGAC was asked, since an avalúo catastral takes effect on 1 January."},"zone":{"type":"string","enum":["urban","rural"],"description":"The part of the municipality the property sits in, which has a cadastral process of its own."},"process":{"anyOf":[{"type":"string","enum":["formacion","actualizacion","conservacion"]},{"type":"null"}],"description":"Where the zone's cadastre stands: `formacion` when it has not been formed, `actualizacion` when the update took effect this vigencia, `conservacion` when the avalúo has been carried forward since `update_year`. Null when IGAC reports no status."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cadastral status as IGAC reports it: `Actualizado Total`, `Desactualizado`, `Por Formar` and others."},"update_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The vigencia of the zone's last formación or actualización. Null when it has had none."},"years_since_update":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"`year` minus `update_year`: how long the avalúo has been carried forward instead of re-estimated."},"reported_year":{"type":"number","description":"The year of IGAC's municipal statistics the status comes from."}},"required":["year","zone","process","status","update_year","years_since_update","reported_year"]},{"type":"null"}]},"buildings":{"type":"array","items":{"type":"object","properties":{"area_m2":{"anyOf":[{"type":"number"},{"type":"null"}]},"use_code":{"anyOf":[{"type":"number"},{"type":"null"}]},"use":{"anyOf":[{"type":"string"},{"type":"null"}]},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Quality score (puntaje), 0 to 100."},"floors":{"anyOf":[{"type":"number"},{"type":"null"}]},"rooms":{"anyOf":[{"type":"number"},{"type":"null"}]},"shops":{"anyOf":[{"type":"number"},{"type":"null"}]},"bathrooms":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["area_m2","use_code","use","score","floors","rooms","shops","bathrooms"]}},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"checked_at":{"type":"string"}},"required":["cadastral_number","previous_cadastral_number","department_code","municipality_code","municipality","address","land_area_m2","built_area_m2","economic_destination_code","economic_destination","appraisal","buildings","latitude","longitude","geometry","checked_at"]},{"type":"null"}]}},"required":["found","latitude","longitude","cadastral_number","checked_at","served_from","property"]},"IgacPropertyByPointResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacPropertyByPointData"}}},"IgacParcelData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"cadastral_number":{"type":"string"},"parcel":{"anyOf":[{"type":"object","properties":{"cadastral_number":{"type":"string","description":"The 30-digit número predial nacional of the parcel (terreno)."},"zone":{"type":"string","enum":["urban","rural"]},"department_code":{"type":"string"},"municipality_code":{"type":"string"},"block_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manzana (urban) or vereda (rural) code, 17 digits."},"previous_cadastral_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"basement_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"part_count":{"type":"number","description":"How many polygons IGAC draws for the parcel; more than one is a MultiPolygon."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Centre of the parcel's bounding box."},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline (a rural zone can run to tens of MB): the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["cadastral_number","zone","department_code","municipality_code","block_code","previous_cadastral_number","basement_count","part_count","latitude","longitude","geometry","geometry_url"]},{"type":"null"}]}},"required":["as_of","found","cadastral_number","parcel"]},"IgacParcelResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacParcelData"}}},"IgacParcelsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"type":"string"},"block_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"zone":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"cadastral_number":{"type":"string","description":"The 30-digit número predial nacional of the parcel (terreno)."},"zone":{"type":"string","enum":["urban","rural"]},"department_code":{"type":"string"},"municipality_code":{"type":"string"},"block_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manzana (urban) or vereda (rural) code, 17 digits."},"previous_cadastral_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"basement_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"part_count":{"type":"number","description":"How many polygons IGAC draws for the parcel; more than one is a MultiPolygon."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Centre of the parcel's bounding box."},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline (a rural zone can run to tens of MB): the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["cadastral_number","zone","department_code","municipality_code","block_code","previous_cadastral_number","basement_count","part_count","latitude","longitude","geometry","geometry_url"]}}},"required":["as_of","municipality_code","block_code","zone","total","total_is_exact","page","per_page","total_pages","count","results"]},"IgacParcelsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacParcelsSearchData"}}},"IgacBuildingsByPropertyData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"cadastral_number":{"type":"string"},"count":{"type":"number"},"buildings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The building's code and letter, e.g. `170130001000000010001000000000-A`."},"cadastral_number":{"type":"string","description":"The property's número predial."},"parcel_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The parcel (terreno) the building stands on."},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The letter that tells the buildings of one property apart (`A`, `B`, ...)."},"construction_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`CONVENCIONAL` or `NO CONVENCIONAL`."},"ownership_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`PRIVADO`, `COMUN` or `PUBLICO`."},"floors":{"anyOf":[{"type":"number"},{"type":"null"}]},"basements":{"anyOf":[{"type":"number"},{"type":"null"}]},"mezzanines":{"anyOf":[{"type":"number"},{"type":"null"}]},"semi_basements":{"anyOf":[{"type":"number"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"building_code":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"zone":{"type":"string","enum":["urban","rural"]},"municipality_code":{"type":"string"},"part_count":{"type":"number"},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline (a rural zone can run to tens of MB): the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["id","cadastral_number","parcel_code","identifier","construction_type","ownership_type","floors","basements","mezzanines","semi_basements","label","building_code","previous_code","zone","municipality_code","part_count","geometry","geometry_url"]}}},"required":["as_of","cadastral_number","count","buildings"]},"IgacBuildingsByPropertyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacBuildingsByPropertyData"}}},"IgacBlocksSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"type":"string"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The 17-digit manzana code."},"neighborhood_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"department_code":{"type":"string"},"municipality_code":{"type":"string"},"part_count":{"type":"number"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline (a rural zone can run to tens of MB): the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["code","neighborhood_code","previous_code","department_code","municipality_code","part_count","latitude","longitude","geometry","geometry_url"]}}},"required":["as_of","municipality_code","total","total_is_exact","page","per_page","total_pages","count","results"]},"IgacBlocksSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacBlocksSearchData"}}},"IgacRuralDistrictsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"type":"string"},"query":{"type":"string"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The 17-digit vereda code."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The vereda's name, as IGAC records it."},"names":{"type":"array","items":{"type":"string"},"description":"Every name IGAC records for the code, when its parts disagree."},"sector_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"department_code":{"type":"string"},"municipality_code":{"type":"string"},"part_count":{"type":"number"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline (a rural zone can run to tens of MB): the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["code","name","names","sector_code","previous_code","department_code","municipality_code","part_count","latitude","longitude","geometry","geometry_url"]}}},"required":["as_of","municipality_code","query","total","total_is_exact","page","per_page","total_pages","count","results"]},"IgacRuralDistrictsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacRuralDistrictsSearchData"}}},"IgacSectorsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"type":"string"},"zone":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"sectors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`urban:<code>` or `rural:<code>`."},"code":{"type":"string","description":"The sector code."},"zone":{"type":"string","enum":["urban","rural"]},"department_code":{"type":"string"},"municipality_code":{"type":"string"},"part_count":{"type":"number"},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline (a rural zone can run to tens of MB): the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["id","code","zone","department_code","municipality_code","part_count","geometry","geometry_url"]}},"urban_perimeters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<municipality_code>:<name_code>`."},"department_code":{"type":"string"},"municipality_code":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The urban centre's geographic name."},"name_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"appraisal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IGAC's appraisal regime for the centre (tipo de avalúo)."},"part_count":{"type":"number"},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline (a rural zone can run to tens of MB): the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["id","department_code","municipality_code","name","name_code","appraisal_type","part_count","geometry","geometry_url"]}}},"required":["as_of","municipality_code","zone","total","total_is_exact","page","per_page","total_pages","count","sectors","urban_perimeters"]},"IgacSectorsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacSectorsSearchData"}}},"IgacEconomicZonesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"type":"string"},"zone":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<zone initial>:<municipality_code>:<zone_code>`."},"zone_code":{"type":"string","description":"IGAC's geoeconomic zone code within the municipality; what a property's `land_zones[].economic_zone_code` points at."},"zone":{"type":"string","enum":["urban","rural"]},"department_code":{"type":"string"},"municipality_code":{"type":"string"},"value_per_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Urban zones: the land value per m² in pesos IGAC adopted for the zone."},"value_per_hectare":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Rural zones: the land value per hectare in pesos."},"physical_subzones":{"type":"array","items":{"type":"string"},"description":"The physical zones the geoeconomic zone covers."},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the zone's values date from (its last formation or update)."},"part_count":{"type":"number"},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline (a rural zone can run to tens of MB): the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["id","zone_code","zone","department_code","municipality_code","value_per_m2","value_per_hectare","physical_subzones","valid_from","part_count","geometry","geometry_url"]}}},"required":["as_of","municipality_code","zone","total","total_is_exact","page","per_page","total_pages","count","results"]},"IgacEconomicZonesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacEconomicZonesSearchData"}}},"IgacPhysicalZonesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"type":"string"},"zone":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<zone initial>:<municipality_code>:<zone_code>`."},"zone_code":{"type":"string"},"zone":{"type":"string","enum":["urban","rural"]},"department_code":{"type":"string"},"municipality_code":{"type":"string"},"topography":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Urban zones."},"road_influence":{"anyOf":[{"type":"number"},{"type":"null"}]},"public_services":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Urban zones."},"land_use":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The current land use, as IGAC codes it."},"land_use_norm":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The land use the planning norm allows."},"construction_typology":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Urban zones."},"land_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Rural zones: the homogeneous land class (área homogénea de tierra)."},"water_availability":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Rural zones."},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"part_count":{"type":"number"},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline (a rural zone can run to tens of MB): the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["id","zone_code","zone","department_code","municipality_code","topography","road_influence","public_services","land_use","land_use_norm","construction_typology","land_class","water_availability","valid_from","part_count","geometry","geometry_url"]}}},"required":["as_of","municipality_code","zone","total","total_is_exact","page","per_page","total_pages","count","results"]},"IgacPhysicalZonesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacPhysicalZonesSearchData"}}},"IgacMunicipalStatisticsData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"type":"string"},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"zone":{"anyOf":[{"type":"string"},{"type":"null"}]},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<municipality_code>:<zone initial>:<year>`."},"municipality_code":{"type":"string"},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"cadastral_manager":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who administered the municipality's cadastre that year, as IGAC reports it."},"year":{"type":"number","description":"The reporting year (vigencia de información)."},"zone":{"type":"string","enum":["urban","rural"]},"appraisal_total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The sum of every property's avalúo catastral in the zone that year, pesos."},"property_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"built_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}]},"land_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}]},"land_area_ha":{"anyOf":[{"type":"number"},{"type":"null"}]},"geographic_area_ha":{"anyOf":[{"type":"number"},{"type":"null"}]},"rural_update_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of the last rural cadastral update (0 when never)."},"urban_update_year":{"anyOf":[{"type":"number"},{"type":"null"}]},"rural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Actualizado`, `Desactualizado` or `Por Formar`."},"urban_status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","municipality_code","municipality","department","cadastral_manager","year","zone","appraisal_total","property_count","built_area_m2","land_area_m2","land_area_ha","geographic_area_ha","rural_update_year","urban_update_year","rural_status","urban_status"]}}},"required":["as_of","municipality_code","year","zone","count","results"]},"IgacMunicipalStatisticsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacMunicipalStatisticsData"}}},"IgacCadastralManagersData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"query":{"type":"string"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"municipality_code":{"type":"string","description":"Five-digit DANE code."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"manager":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who administers the municipality's cadastre, as IGAC names it: `Igac`, `Catastro Antioquia`, `Unidad Administrativa Especial de Catastro Distrital UAECD` and others."},"manager_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"office":{"anyOf":[{"type":"string"},{"type":"null"}]},"nit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manager's tax id."},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manager's institutional contact address, as IGAC publishes it."},"is_igac":{"type":"boolean","description":"True when IGAC itself administers the municipality, which is where the other endpoints of this source have data."}},"required":["municipality_code","municipality","department_code","department","manager","manager_id","office","nit","contact_email","is_igac"]}}},"required":["as_of","municipality_code","query","total","total_is_exact","page","per_page","total_pages","count","results"]},"IgacCadastralManagersResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacCadastralManagersData"}}},"IgacAddressPlatesByPropertyData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"cadastral_number":{"type":"string"},"count":{"type":"number"},"plates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<zone initial>:<municipality_code>:<parcel code or ->:<text>`."},"text":{"type":"string","description":"The plate as IGAC prints it on the map, e.g. `16A 32`."},"parcel_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The parcel the plate belongs to, when IGAC links one."},"zone":{"type":"string","enum":["urban","rural"]},"department_code":{"type":"string"},"municipality_code":{"type":"string"},"part_count":{"type":"number"},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline (a rural zone can run to tens of MB): the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["id","text","parcel_code","zone","department_code","municipality_code","part_count","geometry","geometry_url"]}}},"required":["as_of","cadastral_number","count","plates"]},"IgacAddressPlatesByPropertyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacAddressPlatesByPropertyData"}}},"IgacStreetNamesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"type":"string"},"query":{"type":"string"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<zone initial>:<municipality_code>:<text>`."},"text":{"type":"string","description":"The street's name or nomenclature as IGAC prints it on the map."},"zone":{"type":"string","enum":["urban","rural"]},"department_code":{"type":"string"},"municipality_code":{"type":"string"},"part_count":{"type":"number"},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon`, `MultiPolygon`, `LineString`, `MultiLineString` or `Point`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The feature's geometry as GeoJSON in WGS84, exactly as IGAC draws it; referential, it does not certify boundaries."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline (a rural zone can run to tens of MB): the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["id","text","zone","department_code","municipality_code","part_count","geometry","geometry_url"]}}},"required":["as_of","municipality_code","query","total","total_is_exact","page","per_page","total_pages","count","results"]},"IgacStreetNamesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacStreetNamesSearchData"}}},"BanrepSeriesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"frequency":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Banco de la República code of the series, e.g. `1` (TRM) or `59` (policy rate). Pass it as `series_code` to read the observations."},"name":{"type":"string","description":"The series' name as the Banco de la República publishes it, e.g. `Tasa de política monetaria`."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A short description of the series: unit, adjustment, prices and base where they apply."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The top-level category, e.g. `Tasas de interés y sector financiero` or `Precios e inflación`."},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The second-level category, e.g. `Tasas de interés`."},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-level category, e.g. `Tasas de interés de colocación`."},"frequency":{"anyOf":[{"type":"string","enum":["daily","weekly","monthly","quarterly","semiannual","annual"]},{"type":"null"}],"description":"The native frequency of the observations: `daily`, `weekly`, `monthly`, `quarterly`, `semiannual` or `annual`."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit as published, e.g. `Tasa efectiva anual (porcentaje)` or `Miles de millones COP, base 2015`."},"unit_symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The short unit, e.g. `%` or `COP`."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who produces the data, e.g. `Banco de la República` or `Departamento Administrativo Nacional de Estadística (DANE)`."},"produced_by_banrep":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the Banco de la República produces the series itself; false when it republishes another entity's data."},"geography":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The geography the series covers, e.g. `Nacional` or a city or departamento."},"seasonal_adjustment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The seasonal adjustment, e.g. `Sin ajuste estacional`."},"base_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The base period of an index or a constant-price series, e.g. `2015`."},"prices":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Current or constant prices, where the series says, e.g. `Precios constantes`."},"decimals":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How many decimals the Banco de la República publishes the values with."},"definition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The definition and notes the Banco de la República publishes with the series, as plain text."},"methodology_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The methodology sheet the Banco de la República links for the series, where there is one."},"first_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the first observation."},"last_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the latest observation. Daily series can run a few days ahead, when a value is set in advance (the TRM over a weekend)."},"last_load_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Banco de la República last updated the series."},"next_load_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Banco de la República plans to update the series next. Null when no update is scheduled, as for a discontinued series."}},"required":["id","name","description","category","subcategory","topic","frequency","unit","unit_symbol","source","produced_by_banrep","geography","seasonal_adjustment","base_period","prices","decimals","definition","methodology_url","first_date","last_date","last_load_date","next_load_date"]}}},"required":["as_of","query","frequency","total","total_is_exact","page","per_page","total_pages","count","results"]},"BanrepSeriesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/BanrepSeriesSearchData"}}},"BanrepSeriesData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"False when the Banco de la República publishes no series under that code."},"series_code":{"type":"string"},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"series":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The Banco de la República code of the series, e.g. `1` (TRM) or `59` (policy rate). Pass it as `series_code` to read the observations."},"name":{"type":"string","description":"The series' name as the Banco de la República publishes it, e.g. `Tasa de política monetaria`."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A short description of the series: unit, adjustment, prices and base where they apply."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The top-level category, e.g. `Tasas de interés y sector financiero` or `Precios e inflación`."},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The second-level category, e.g. `Tasas de interés`."},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-level category, e.g. `Tasas de interés de colocación`."},"frequency":{"anyOf":[{"type":"string","enum":["daily","weekly","monthly","quarterly","semiannual","annual"]},{"type":"null"}],"description":"The native frequency of the observations: `daily`, `weekly`, `monthly`, `quarterly`, `semiannual` or `annual`."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit as published, e.g. `Tasa efectiva anual (porcentaje)` or `Miles de millones COP, base 2015`."},"unit_symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The short unit, e.g. `%` or `COP`."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who produces the data, e.g. `Banco de la República` or `Departamento Administrativo Nacional de Estadística (DANE)`."},"produced_by_banrep":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the Banco de la República produces the series itself; false when it republishes another entity's data."},"geography":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The geography the series covers, e.g. `Nacional` or a city or departamento."},"seasonal_adjustment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The seasonal adjustment, e.g. `Sin ajuste estacional`."},"base_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The base period of an index or a constant-price series, e.g. `2015`."},"prices":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Current or constant prices, where the series says, e.g. `Precios constantes`."},"decimals":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How many decimals the Banco de la República publishes the values with."},"definition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The definition and notes the Banco de la República publishes with the series, as plain text."},"methodology_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The methodology sheet the Banco de la República links for the series, where there is one."},"first_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the first observation."},"last_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the latest observation. Daily series can run a few days ahead, when a value is set in advance (the TRM over a weekend)."},"last_load_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Banco de la República last updated the series."},"next_load_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Banco de la República plans to update the series next. Null when no update is scheduled, as for a discontinued series."}},"required":["id","name","description","category","subcategory","topic","frequency","unit","unit_symbol","source","produced_by_banrep","geography","seasonal_adjustment","base_period","prices","decimals","definition","methodology_url","first_date","last_date","last_load_date","next_load_date"]},{"type":"null"}]},"count":{"type":"number","description":"Observations in `observations`."},"observations":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","description":"`yyyy-mm-dd` the value applies to: the day, the date a week is stamped with, or the last day of the month, quarter or year."},"value":{"type":"number","description":"The value, in the series' unit."}},"required":["date","value"]},"description":"Every observation in the requested range, oldest first."}},"required":["as_of","found","series_code","from_date","to_date","series","count","observations"]},"BanrepSeriesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/BanrepSeriesData"}}},"BanrepResearchPublicationsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"series":{"anyOf":[{"type":"string"},{"type":"null"}]},"author":{"anyOf":[{"type":"string"},{"type":"null"}]},"jel_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The publication's handle number in the Banco de la República's repository, e.g. `11430`."},"handle_url":{"type":"string","description":"The publication's permanent handle link, e.g. `https://hdl.handle.net/20.500.12134/11430`."},"series":{"type":"string","enum":["borradores","regional_working_papers","regional_essays","espe","monetary_policy_report","financial_stability_report","financial_stability_special_reports","financial_stability_topics","board_report_to_congress","icer","regional_bulletin","labour_market_report","credit_report","financial_markets_report","other"],"description":"The series it belongs to, e.g. `borradores` or `regional_bulletin`; `other` for books, chapters and the smaller series."},"collection":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The repository collection it is filed in, by name, e.g. `Borradores de Economía` or `Boletín Económico Regional`."},"series_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The series as the publication names itself, e.g. `Boletín Económico Regional - Costa Caribe`."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its number in the series where it has one, e.g. `Borrador 1371`."},"title":{"type":"string","description":"The title as published."},"title_alternative":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The title in the other language, where the repository carries one."},"authors":{"type":"array","items":{"type":"string"},"description":"The people who wrote it, as `Surname-Surname, Given names`."},"corporate_authors":{"type":"array","items":{"type":"string"},"description":"The institutions credited as authors, e.g. `Banco de la República de Colombia` or `DANE`."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The publication date at the precision the repository gives: `yyyy`, `yyyy-mm` or `yyyy-mm-dd`."},"published_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of `date`, the first day of the month or year when the date is less precise. The `from_date` and `to_date` filters read it."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of publication."},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 639-2 language of the text: `spa` or `eng`."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of publication, e.g. `Working Paper`, `Report` or `Book`."},"abstract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The abstract in Spanish."},"abstract_en":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The abstract in English."},"abstract_en_truncated":{"type":"boolean","description":"True when the repository holds the English abstract cut at 255 characters, as it does for many older working papers; the full text is in the document."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The longer non-technical summary the newer working papers carry (approach, contribution, results)."},"keywords":{"type":"array","items":{"type":"string"},"description":"The Spanish keywords."},"keywords_en":{"type":"array","items":{"type":"string"},"description":"The English keywords."},"jel_codes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The JEL code, e.g. `E52`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its English label as the Banco de la República files it, e.g. `Monetary Policy`."}},"required":["code","label"]},"description":"The JEL classification codes, with their labels."},"subjects":{"type":"array","items":{"type":"string"},"description":"The subject headings, often with a place and a year, e.g. `Mercado laboral -- Costa Caribe (Región, Colombia) -- 2026`."},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Banco de la República's own topic, e.g. `6. Actividad económica y mercado laboral`."},"regions":{"type":"array","items":{"type":"string"},"description":"The Colombian departments the publication covers, as the repository names them. The regional bulletins and ICER reports carry them."},"branch":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Banco de la República branch that produced it, e.g. `Cartagena` or `Bogotá`."},"doi":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The DOI link, e.g. `https://doi.org/10.32468/be.1371`."},"repec_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The RePEc handle, e.g. `RePEc:bdr:borrec:1371`."},"pages":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The length as published, e.g. `21 páginas`."},"license":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The licence the Banco de la República publishes it under, as a link, e.g. `https://creativecommons.org/licenses/by-nc-sa/4.0/`."},"portal_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The publication's page on banrep.gov.co, where there is one."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the main document (the publication's PDF)."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The main document's link at the Banco de la República's repository."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name the Banco de la República published it under, e.g. `be_1371.pdf`."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the file is, as the repository describes it: the publication itself, an English version, a summary, a box, an annex or a chart."},"content_type":{"type":"string","description":"The file's media type, e.g. `application/pdf`."},"bytes":{"type":"number","description":"The file's size in bytes."},"md5":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The MD5 checksum the repository publishes for the file; our copy matches it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the file. Null when the repository no longer serves it."},"source_document_url":{"type":"string","description":"The file's link at the Banco de la República's repository."}},"required":["name","description","content_type","bytes","md5","document_url","source_document_url"]},"description":"Every file published with it, the main document first: English versions, summaries, boxes, annexes, data files and charts, each with Croma's copy."},"text_status":{"type":"string","enum":["ok","truncated","missing"],"description":"`ok` when the main document's whole text is here; `truncated` when it is longer than this field keeps (read the document for the rest); `missing` when the repository has no text for it."},"text_length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Characters in the main document's whole text, however much of it `text` keeps."},"source_updated_at":{"type":"string","description":"When the repository last changed the publication's record."}},"required":["id","handle_url","series","collection","series_title","number","title","title_alternative","authors","corporate_authors","date","published_on","year","language","type","abstract","abstract_en","abstract_en_truncated","summary","keywords","keywords_en","jel_codes","subjects","topic","regions","branch","doi","repec_id","pages","license","portal_url","document_url","source_document_url","documents","text_status","text_length","source_updated_at"]}}},"required":["as_of","query","series","author","jel_code","region","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"BanrepResearchPublicationsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/BanrepResearchPublicationsSearchData"}}},"BanrepResearchPublicationData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"False when the repository holds no publication under that handle."},"handle":{"type":"string"},"publication":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The publication's handle number in the Banco de la República's repository, e.g. `11430`."},"handle_url":{"type":"string","description":"The publication's permanent handle link, e.g. `https://hdl.handle.net/20.500.12134/11430`."},"series":{"type":"string","enum":["borradores","regional_working_papers","regional_essays","espe","monetary_policy_report","financial_stability_report","financial_stability_special_reports","financial_stability_topics","board_report_to_congress","icer","regional_bulletin","labour_market_report","credit_report","financial_markets_report","other"],"description":"The series it belongs to, e.g. `borradores` or `regional_bulletin`; `other` for books, chapters and the smaller series."},"collection":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The repository collection it is filed in, by name, e.g. `Borradores de Economía` or `Boletín Económico Regional`."},"series_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The series as the publication names itself, e.g. `Boletín Económico Regional - Costa Caribe`."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its number in the series where it has one, e.g. `Borrador 1371`."},"title":{"type":"string","description":"The title as published."},"title_alternative":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The title in the other language, where the repository carries one."},"authors":{"type":"array","items":{"type":"string"},"description":"The people who wrote it, as `Surname-Surname, Given names`."},"corporate_authors":{"type":"array","items":{"type":"string"},"description":"The institutions credited as authors, e.g. `Banco de la República de Colombia` or `DANE`."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The publication date at the precision the repository gives: `yyyy`, `yyyy-mm` or `yyyy-mm-dd`."},"published_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of `date`, the first day of the month or year when the date is less precise. The `from_date` and `to_date` filters read it."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of publication."},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 639-2 language of the text: `spa` or `eng`."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of publication, e.g. `Working Paper`, `Report` or `Book`."},"abstract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The abstract in Spanish."},"abstract_en":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The abstract in English."},"abstract_en_truncated":{"type":"boolean","description":"True when the repository holds the English abstract cut at 255 characters, as it does for many older working papers; the full text is in the document."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The longer non-technical summary the newer working papers carry (approach, contribution, results)."},"keywords":{"type":"array","items":{"type":"string"},"description":"The Spanish keywords."},"keywords_en":{"type":"array","items":{"type":"string"},"description":"The English keywords."},"jel_codes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The JEL code, e.g. `E52`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its English label as the Banco de la República files it, e.g. `Monetary Policy`."}},"required":["code","label"]},"description":"The JEL classification codes, with their labels."},"subjects":{"type":"array","items":{"type":"string"},"description":"The subject headings, often with a place and a year, e.g. `Mercado laboral -- Costa Caribe (Región, Colombia) -- 2026`."},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Banco de la República's own topic, e.g. `6. Actividad económica y mercado laboral`."},"regions":{"type":"array","items":{"type":"string"},"description":"The Colombian departments the publication covers, as the repository names them. The regional bulletins and ICER reports carry them."},"branch":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Banco de la República branch that produced it, e.g. `Cartagena` or `Bogotá`."},"doi":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The DOI link, e.g. `https://doi.org/10.32468/be.1371`."},"repec_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The RePEc handle, e.g. `RePEc:bdr:borrec:1371`."},"pages":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The length as published, e.g. `21 páginas`."},"license":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The licence the Banco de la República publishes it under, as a link, e.g. `https://creativecommons.org/licenses/by-nc-sa/4.0/`."},"portal_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The publication's page on banrep.gov.co, where there is one."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the main document (the publication's PDF)."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The main document's link at the Banco de la República's repository."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name the Banco de la República published it under, e.g. `be_1371.pdf`."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the file is, as the repository describes it: the publication itself, an English version, a summary, a box, an annex or a chart."},"content_type":{"type":"string","description":"The file's media type, e.g. `application/pdf`."},"bytes":{"type":"number","description":"The file's size in bytes."},"md5":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The MD5 checksum the repository publishes for the file; our copy matches it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the file. Null when the repository no longer serves it."},"source_document_url":{"type":"string","description":"The file's link at the Banco de la República's repository."}},"required":["name","description","content_type","bytes","md5","document_url","source_document_url"]},"description":"Every file published with it, the main document first: English versions, summaries, boxes, annexes, data files and charts, each with Croma's copy."},"text_status":{"type":"string","enum":["ok","truncated","missing"],"description":"`ok` when the main document's whole text is here; `truncated` when it is longer than this field keeps (read the document for the rest); `missing` when the repository has no text for it."},"text_length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Characters in the main document's whole text, however much of it `text` keeps."},"source_updated_at":{"type":"string","description":"When the repository last changed the publication's record."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the main 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 text Croma keeps 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 main document's text, or null when `text_status` is `missing`."}},"required":["id","handle_url","series","collection","series_title","number","title","title_alternative","authors","corporate_authors","date","published_on","year","language","type","abstract","abstract_en","abstract_en_truncated","summary","keywords","keywords_en","jel_codes","subjects","topic","regions","branch","doi","repec_id","pages","license","portal_url","document_url","source_document_url","documents","text_status","text_length","source_updated_at","content"]},{"type":"null"}]}},"required":["as_of","found","handle","publication"]},"BanrepResearchPublicationResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/BanrepResearchPublicationData"}}},"IcfesSaber11SchoolsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"school_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"territory_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"period":{"anyOf":[{"type":"string"},{"type":"null"}]},"school_sector":{"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 period, the school's DANE code and the municipality, e.g. `2022-2:111001000078:11001`."},"period":{"type":"string","description":"The exam period: `yyyy-1` for the first sitting of the year (mostly calendar B schools), `yyyy-2` for the second (calendar A, most of the country), e.g. `2022-2`."},"year":{"type":"number","description":"The exam year."},"sitting":{"type":"number","description":"`1` for the first sitting of the year, `2` for the second."},"school_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The school's 12-digit DANE code (establecimiento educativo). Null for students ICFES records without one."},"school_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The school's name as ICFES writes it."},"school_sector":{"anyOf":[{"type":"string","enum":["oficial","no_oficial"]},{"type":"null"}],"description":"`oficial` (public) or `no_oficial` (private)."},"calendar":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The school calendar: `A` (February to November), `B` (September to June) or `OTRO`."},"area":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`URBANO` or `RURAL`."},"territory_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The 5-digit DIVIPOLA code of the municipality where the school is, e.g. `11001`. Null when ICFES records none."},"territory_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality's name as ICFES writes it, e.g. `BOGOTÁ D.C.`."},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The 2-digit DIVIPOLA code of the department, e.g. `11`."},"department_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department's name as ICFES writes it."},"students":{"type":"number","description":"Students who sat the exam, each counted once."},"mean_global":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean global score (puntaje global, 0 to 500) of the group's students, rounded to two decimals. Published from 2014-2, when the exam took its current form; null before, and when no student in the group has one."},"mean_mathematics":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean mathematics (0 to 100) score of the group's students, rounded to two decimals. Every period has it; before 2014-2 it is on the earlier exam's scale, so compare it only within one form of the exam."},"mean_critical_reading":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean critical reading (lectura crítica, 0 to 100) score of the group's students, rounded to two decimals. Published from 2014-2, when the exam took its current form; null before, and when no student in the group has one."},"mean_natural_sciences":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean natural sciences (0 to 100) score of the group's students, rounded to two decimals. Published from 2014-2, when the exam took its current form; null before, and when no student in the group has one."},"mean_social_studies":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean social studies and citizenship (sociales y ciudadanas, 0 to 100) score of the group's students, rounded to two decimals. Published from 2014-2, when the exam took its current form; null before, and when no student in the group has one."},"mean_english":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean English (0 to 100) score of the group's students, rounded to two decimals. Every period has it; before 2014-2 it is on the earlier exam's scale, so compare it only within one form of the exam."}},"required":["id","period","year","sitting","school_code","school_name","school_sector","calendar","area","territory_code","territory_name","department_code","department_name","students","mean_global","mean_mathematics","mean_critical_reading","mean_natural_sciences","mean_social_studies","mean_english"]}}},"required":["as_of","query","school_code","territory_code","year","period","school_sector","total","page","per_page","total_pages","count","results"]},"IcfesSaber11SchoolsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IcfesSaber11SchoolsSearchData"}}},"IcfesSaber11StrataSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"territory_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"period":{"anyOf":[{"type":"string"},{"type":"null"}]},"stratum":{"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 period, the municipality and the stratum, e.g. `2022-2:11001:3`."},"period":{"type":"string","description":"The exam period: `yyyy-1` for the first sitting of the year (mostly calendar B schools), `yyyy-2` for the second (calendar A, most of the country), e.g. `2022-2`."},"year":{"type":"number","description":"The exam year."},"sitting":{"type":"number","description":"`1` for the first sitting of the year, `2` for the second."},"territory_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The 5-digit DIVIPOLA code of the municipality where the school is, e.g. `11001`. Null when ICFES records none."},"territory_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality's name as ICFES writes it, e.g. `BOGOTÁ D.C.`."},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The 2-digit DIVIPOLA code of the department, e.g. `11`."},"department_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department's name as ICFES writes it."},"stratum":{"type":"string","enum":["1","2","3","4","5","6","sin_estrato","no_reportado"],"description":"The socioeconomic stratum of the student's home as the student reported it: `1` to `6`, `sin_estrato` (the home has none) or `no_reportado` (not answered)."},"students":{"type":"number","description":"Students who sat the exam, each counted once."},"mean_global":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean global score (puntaje global, 0 to 500) of the group's students, rounded to two decimals. Published from 2014-2, when the exam took its current form; null before, and when no student in the group has one."},"mean_mathematics":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean mathematics (0 to 100) score of the group's students, rounded to two decimals. Every period has it; before 2014-2 it is on the earlier exam's scale, so compare it only within one form of the exam."},"mean_critical_reading":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean critical reading (lectura crítica, 0 to 100) score of the group's students, rounded to two decimals. Published from 2014-2, when the exam took its current form; null before, and when no student in the group has one."},"mean_natural_sciences":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean natural sciences (0 to 100) score of the group's students, rounded to two decimals. Published from 2014-2, when the exam took its current form; null before, and when no student in the group has one."},"mean_social_studies":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean social studies and citizenship (sociales y ciudadanas, 0 to 100) score of the group's students, rounded to two decimals. Published from 2014-2, when the exam took its current form; null before, and when no student in the group has one."},"mean_english":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean English (0 to 100) score of the group's students, rounded to two decimals. Every period has it; before 2014-2 it is on the earlier exam's scale, so compare it only within one form of the exam."}},"required":["id","period","year","sitting","territory_code","territory_name","department_code","department_name","stratum","students","mean_global","mean_mathematics","mean_critical_reading","mean_natural_sciences","mean_social_studies","mean_english"]}}},"required":["as_of","territory_code","year","period","stratum","total","page","per_page","total_pages","count","results"]},"IcfesSaber11StrataSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IcfesSaber11StrataSearchData"}}},"IgacTransactionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"act_code":{"anyOf":[{"type":"number"},{"type":"null"}]},"zone":{"anyOf":[{"type":"string","enum":["urban","rural"]},{"type":"null"}]},"year_from":{"anyOf":[{"type":"number"},{"type":"null"}]},"year_to":{"anyOf":[{"type":"number"},{"type":"null"}]},"min_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"max_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"with_value":{"type":"boolean"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier of the annotation: municipality, registry office, folio, annotation number, act code and year, e.g. `05002-002-008032-00012-00125-2021`."},"registration_number":{"type":"string","description":"The matrícula inmobiliaria, `<registry office>-<folio>`, e.g. `002-8032`."},"registry_office_code":{"type":"string","description":"The registry office (oficina de registro de instrumentos públicos) that keeps the folio, e.g. `002`, `50C`."},"folio_number":{"type":"string","description":"The folio's number within its office."},"annotation_number":{"type":"number","description":"The annotation's place in the folio's history, 1 for the first."},"municipality_code":{"type":"string","description":"Five-digit DANE code of the municipality the property is in."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"zone":{"anyOf":[{"type":"string","enum":["urban","rural"]},{"type":"null"}],"description":"Whether the property is urban or rural."},"rurality_category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality's rurality category (2024): `Ciudades y aglomeraciones`, `Intermedio`, `Rural`, `Rural disperso`."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was filed (radicado) at the registry."},"filed_year":{"type":"number","description":"The year the act was filed."},"act_code":{"type":"number","description":"The registry's code for the act (naturaleza jurídica), e.g. `125` compraventa, `219` hipoteca abierta."},"act":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act as the registry names it, e.g. `COMPRAVENTA`, `HIPOTECA ABIERTA SIN LIMITE DE CUANTIA`."},"instrument":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The instrument the act rests on and who issued it, as the registry records it, e.g. `00-ESCRITURA 537 DE 28/11/2016; NOTARIA UNICA - ABEJORRAL`."},"value_cop":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value the act declares, in Colombian pesos; null when it declares none. For a sale it is the price written in the deed, which can sit below the price agreed."},"has_value":{"type":"boolean","description":"Whether the act declares a value."},"has_several_values":{"type":"boolean","description":"Whether the act declares more than one value; `value_cop` is then the one the registry kept."},"parties_from":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How many parties the act is from (e.g. the sellers)."},"parties_to":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How many parties the act is to (e.g. the buyers)."},"new_folio":{"type":"boolean","description":"Whether the act opened new folios (a subdivision, a horizontal property)."},"market_activity":{"type":"boolean","description":"Whether the registry counts the act as a sign of real-estate market activity."},"folio_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The folio's status: `ACTIVO`, `CERRADO`, `CUSTODIA`; often unreported."},"folio_opened_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the folio was opened, when reported."},"derived_folios":{"type":"array","items":{"type":"string"},"description":"Matrículas opened from this folio by the act, when it opened any."}},"required":["id","registration_number","registry_office_code","folio_number","annotation_number","municipality_code","municipality","department","zone","rurality_category","filed_on","filed_year","act_code","act","instrument","value_cop","has_value","has_several_values","parties_from","parties_to","new_folio","market_activity","folio_status","folio_opened_on","derived_folios"]}}},"required":["as_of","municipality_code","registration_number","act_code","zone","year_from","year_to","min_value","max_value","with_value","total","total_is_exact","page","per_page","total_pages","count","results"]},"IgacTransactionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacTransactionsSearchData"}}},"IgacFolioHistoryData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"registration_number":{"type":"string"},"found":{"type":"boolean","description":"False when the registry recorded no act on the folio between 2015 and 2023, or the folio does not exist; the two cannot be told apart."},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"zone":{"anyOf":[{"type":"string","enum":["urban","rural"]},{"type":"null"}]},"count":{"type":"number"},"annotations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier of the annotation: municipality, registry office, folio, annotation number, act code and year, e.g. `05002-002-008032-00012-00125-2021`."},"registration_number":{"type":"string","description":"The matrícula inmobiliaria, `<registry office>-<folio>`, e.g. `002-8032`."},"registry_office_code":{"type":"string","description":"The registry office (oficina de registro de instrumentos públicos) that keeps the folio, e.g. `002`, `50C`."},"folio_number":{"type":"string","description":"The folio's number within its office."},"annotation_number":{"type":"number","description":"The annotation's place in the folio's history, 1 for the first."},"municipality_code":{"type":"string","description":"Five-digit DANE code of the municipality the property is in."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"zone":{"anyOf":[{"type":"string","enum":["urban","rural"]},{"type":"null"}],"description":"Whether the property is urban or rural."},"rurality_category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality's rurality category (2024): `Ciudades y aglomeraciones`, `Intermedio`, `Rural`, `Rural disperso`."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was filed (radicado) at the registry."},"filed_year":{"type":"number","description":"The year the act was filed."},"act_code":{"type":"number","description":"The registry's code for the act (naturaleza jurídica), e.g. `125` compraventa, `219` hipoteca abierta."},"act":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act as the registry names it, e.g. `COMPRAVENTA`, `HIPOTECA ABIERTA SIN LIMITE DE CUANTIA`."},"instrument":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The instrument the act rests on and who issued it, as the registry records it, e.g. `00-ESCRITURA 537 DE 28/11/2016; NOTARIA UNICA - ABEJORRAL`."},"value_cop":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value the act declares, in Colombian pesos; null when it declares none. For a sale it is the price written in the deed, which can sit below the price agreed."},"has_value":{"type":"boolean","description":"Whether the act declares a value."},"has_several_values":{"type":"boolean","description":"Whether the act declares more than one value; `value_cop` is then the one the registry kept."},"parties_from":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How many parties the act is from (e.g. the sellers)."},"parties_to":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How many parties the act is to (e.g. the buyers)."},"new_folio":{"type":"boolean","description":"Whether the act opened new folios (a subdivision, a horizontal property)."},"market_activity":{"type":"boolean","description":"Whether the registry counts the act as a sign of real-estate market activity."},"folio_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The folio's status: `ACTIVO`, `CERRADO`, `CUSTODIA`; often unreported."},"folio_opened_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the folio was opened, when reported."},"derived_folios":{"type":"array","items":{"type":"string"},"description":"Matrículas opened from this folio by the act, when it opened any."}},"required":["id","registration_number","registry_office_code","folio_number","annotation_number","municipality_code","municipality","department","zone","rurality_category","filed_on","filed_year","act_code","act","instrument","value_cop","has_value","has_several_values","parties_from","parties_to","new_folio","market_activity","folio_status","folio_opened_on","derived_folios"]},"description":"Every annotation of the folio filed 2015-2023, in the folio's order."}},"required":["as_of","registration_number","found","municipality_code","municipality","department","zone","count","annotations"]},"IgacFolioHistoryResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacFolioHistoryData"}}},"IgacPriceStatisticsData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"type":"string"},"act_code":{"anyOf":[{"type":"number"},{"type":"null"}]},"zone":{"anyOf":[{"type":"string","enum":["urban","rural"]},{"type":"null"}]},"year_from":{"anyOf":[{"type":"number"},{"type":"null"}]},"year_to":{"anyOf":[{"type":"number"},{"type":"null"}]},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<municipality_code>:<year>:<zone>:<act_code>`, e.g. `17013:2023:urban:125`."},"municipality_code":{"type":"string"},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"type":"number","description":"The year the acts were filed."},"zone":{"type":"string","enum":["urban","rural","unknown"],"description":"`unknown` for the acts the registry records without a zone."},"act_code":{"type":"number"},"act":{"anyOf":[{"type":"string"},{"type":"null"}]},"transaction_count":{"type":"number","description":"Acts of this kind filed that year in the zone that declare a value above zero."},"median_value_cop":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The median declared value, pesos: the figure to compare, since a few acts declare whole-portfolio amounts."},"average_value_cop":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The mean declared value, pesos. Outliers move it; prefer the median."},"min_value_cop":{"anyOf":[{"type":"number"},{"type":"null"}]},"max_value_cop":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_value_cop":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The sum of the declared values, pesos."}},"required":["id","municipality_code","municipality","department","year","zone","act_code","act","transaction_count","median_value_cop","average_value_cop","min_value_cop","max_value_cop","total_value_cop"]},"description":"Newest year first, then zone and act."}},"required":["as_of","municipality_code","act_code","zone","year_from","year_to","count","results"]},"IgacPriceStatisticsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IgacPriceStatisticsData"}}},"UpraLandPricesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_price_per_hectare":{"anyOf":[{"type":"number"},{"type":"null"}]},"max_price_per_hectare":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<department_code>-<valuation_year>-<number>`, e.g. `73-2017-1520`."},"department_code":{"type":"string","description":"Two-digit DANE code of the department."},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Five-digit DANE code of the municipality."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"valuation_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year UPRA's price study for the department refers to (vigencia)."},"price_status":{"type":"string","enum":["priced","excluded","no_information"],"description":"`priced` when the zone carries a price range; `excluded` when the land is outside the agricultural land market (`exclusion` says why); `no_information` when UPRA has no price for it."},"price_range":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The range as UPRA labels it, in millions of pesos per hectare, e.g. `Mayor que 5 - hasta 8`; null unless priced."},"exclusion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why the zone is outside the land market, as UPRA names it, e.g. `Zonas urbanas`, `Resguardos indígenas constituidos`, `Parques Nacionales Naturales`; null unless excluded."},"price_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UPRA's code for the range or the exclusion, e.g. `2.2.1`, `E-3`, `SI`."},"min_price_cop_per_ha":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The range's lower bound in pesos per hectare (0 for `Menor a 1`); null without a range."},"max_price_cop_per_ha":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The range's upper bound in pesos per hectare; null for the open top range or without a range."},"market_category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The zone's standing in UPRA's land-market frontier: `Incluida` or `Condicionada`."},"area_ha":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The zone's area in hectares."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Centre of the zone's bounding box."},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon` or `MultiPolygon`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The zone as GeoJSON in WGS84, as UPRA draws it at 1:100,000."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline: the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["id","department_code","department","municipality_code","municipality","valuation_year","price_status","price_range","exclusion","price_code","min_price_cop_per_ha","max_price_cop_per_ha","market_category","area_ha","latitude","longitude","geometry","geometry_url"]}}},"required":["as_of","municipality_code","department_code","min_price_per_hectare","max_price_per_hectare","total","total_is_exact","page","per_page","total_pages","count","results"]},"UpraLandPricesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UpraLandPricesSearchData"}}},"UpraLandPriceByPointData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when no UPRA zone covers the point: most of the country outside the 18 departments studied. Land outside the market (urban, reserves, parks) is a zone with `price_status: excluded`."},"latitude":{"type":"number"},"longitude":{"type":"number"},"zone":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"`<department_code>-<valuation_year>-<number>`, e.g. `73-2017-1520`."},"department_code":{"type":"string","description":"Two-digit DANE code of the department."},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Five-digit DANE code of the municipality."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"valuation_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year UPRA's price study for the department refers to (vigencia)."},"price_status":{"type":"string","enum":["priced","excluded","no_information"],"description":"`priced` when the zone carries a price range; `excluded` when the land is outside the agricultural land market (`exclusion` says why); `no_information` when UPRA has no price for it."},"price_range":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The range as UPRA labels it, in millions of pesos per hectare, e.g. `Mayor que 5 - hasta 8`; null unless priced."},"exclusion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why the zone is outside the land market, as UPRA names it, e.g. `Zonas urbanas`, `Resguardos indígenas constituidos`, `Parques Nacionales Naturales`; null unless excluded."},"price_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UPRA's code for the range or the exclusion, e.g. `2.2.1`, `E-3`, `SI`."},"min_price_cop_per_ha":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The range's lower bound in pesos per hectare (0 for `Menor a 1`); null without a range."},"max_price_cop_per_ha":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The range's upper bound in pesos per hectare; null for the open top range or without a range."},"market_category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The zone's standing in UPRA's land-market frontier: `Incluida` or `Condicionada`."},"area_ha":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The zone's area in hectares."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Centre of the zone's bounding box."},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","description":"`Polygon` or `MultiPolygon`."},"coordinates":{"description":"GeoJSON coordinates in WGS84 (EPSG:4326), longitude first."}},"required":["type","coordinates"],"description":"The zone as GeoJSON in WGS84, as UPRA draws it at 1:100,000."},{"type":"null"}]},"geometry_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when the geometry is too large to carry inline: the same GeoJSON geometry, kept by us, and `geometry` is null."}},"required":["id","department_code","department","municipality_code","municipality","valuation_year","price_status","price_range","exclusion","price_code","min_price_cop_per_ha","max_price_cop_per_ha","market_category","area_ha","latitude","longitude","geometry","geometry_url"]},{"type":"null"}]}},"required":["found","latitude","longitude","zone"]},"UpraLandPriceByPointResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UpraLandPriceByPointData"}}},"InvimaRegistrationsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"holder":{"anyOf":[{"type":"string"},{"type":"null"}]},"product_group":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The INVIMA file number (expediente) that identifies the registration, e.g. `20190868`."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registro sanitario or NSO number as INVIMA prints it, e.g. `INVIMA 2020M-0019848`, `RSIAD11M04589` or `NSO-PC-C 32.233 -VE`."},"product":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The product's name as registered. When one registration covers several, the most frequent; `products` lists them all."},"products":{"type":"array","items":{"type":"string"},"description":"Every product name the registration covers."},"product_group":{"type":"string","description":"INVIMA's product group, e.g. `MEDICAMENTOS`, `ALIMENTOS`, `COSMETICOS`, `MEDICO QUIRURGICOS`, `REACTIVO DIAGNOSTICO`."},"directorate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The INVIMA directorate that oversees the product, e.g. `DIRECCIÓN DE COSMÉTICOS`."},"status":{"type":"string","description":"`Vigente` (in force) or `Vencido` (expired), as INVIMA states it."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration was issued. Null when INVIMA records no date."},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration expires or expired. Null when INVIMA records no date."},"holder":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The holder (titular) of the registration, as registered."},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the product reaches the market, as INVIMA states it, e.g. `FABRICAR Y VENDER` or `IMPORTAR Y VENDER`."},"risk_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The risk class, where the group has one (devices and reagents): `I`, `IIa`, `IIb` or `III`."},"uses":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The intended use, where INVIMA records one."},"shelf_life":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The shelf life as INVIMA records it, e.g. `5` or `5 AÑOS`."},"parties":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"The role as INVIMA names it, e.g. `FABRICANTE`, `IMPORTADOR`, `ACONDICIONADOR`, `APODERADO`, `REPRESENTANTE LEGAL`, `QUIMICO FARMACEUTICO`."},"name":{"type":"string","description":"The company or person in that role, as registered."}},"required":["role","name"]},"description":"Every company or person in a role on the registration: manufacturers, importers, packagers, attorneys, legal representatives, pharmacists."},"entries":{"type":"number","description":"How many rows INVIMA's list carries for this registration (one per product name and role holder)."}},"required":["id","registration_number","product","products","product_group","directorate","status","issued_at","expires_at","holder","modality","risk_level","uses","shelf_life","parties","entries"]}}},"required":["as_of","query","registration_number","holder","product_group","status","expires_from","expires_to","total","total_is_exact","page","per_page","total_pages","count","results"]},"InvimaRegistrationsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/InvimaRegistrationsSearchData"}}},"InvimaRegistrationData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"False when INVIMA lists no registration under that file number."},"file_number":{"type":"string"},"registration":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The INVIMA file number (expediente) that identifies the registration, e.g. `20190868`."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registro sanitario or NSO number as INVIMA prints it, e.g. `INVIMA 2020M-0019848`, `RSIAD11M04589` or `NSO-PC-C 32.233 -VE`."},"product":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The product's name as registered. When one registration covers several, the most frequent; `products` lists them all."},"products":{"type":"array","items":{"type":"string"},"description":"Every product name the registration covers."},"product_group":{"type":"string","description":"INVIMA's product group, e.g. `MEDICAMENTOS`, `ALIMENTOS`, `COSMETICOS`, `MEDICO QUIRURGICOS`, `REACTIVO DIAGNOSTICO`."},"directorate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The INVIMA directorate that oversees the product, e.g. `DIRECCIÓN DE COSMÉTICOS`."},"status":{"type":"string","description":"`Vigente` (in force) or `Vencido` (expired), as INVIMA states it."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration was issued. Null when INVIMA records no date."},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration expires or expired. Null when INVIMA records no date."},"holder":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The holder (titular) of the registration, as registered."},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the product reaches the market, as INVIMA states it, e.g. `FABRICAR Y VENDER` or `IMPORTAR Y VENDER`."},"risk_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The risk class, where the group has one (devices and reagents): `I`, `IIa`, `IIb` or `III`."},"uses":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The intended use, where INVIMA records one."},"shelf_life":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The shelf life as INVIMA records it, e.g. `5` or `5 AÑOS`."},"parties":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"The role as INVIMA names it, e.g. `FABRICANTE`, `IMPORTADOR`, `ACONDICIONADOR`, `APODERADO`, `REPRESENTANTE LEGAL`, `QUIMICO FARMACEUTICO`."},"name":{"type":"string","description":"The company or person in that role, as registered."}},"required":["role","name"]},"description":"Every company or person in a role on the registration: manufacturers, importers, packagers, attorneys, legal representatives, pharmacists."},"entries":{"type":"number","description":"How many rows INVIMA's list carries for this registration (one per product name and role holder)."}},"required":["id","registration_number","product","products","product_group","directorate","status","issued_at","expires_at","holder","modality","risk_level","uses","shelf_life","parties","entries"]},{"type":"null"}]}},"required":["as_of","found","file_number","registration"]},"InvimaRegistrationResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/InvimaRegistrationData"}}},"InvimaMedicinesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"active_ingredient":{"anyOf":[{"type":"string"},{"type":"null"}]},"atc_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"holder":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"cum_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The CUM code: the file number and the presentation's sequence, e.g. `20042480-41`."},"file_number":{"type":"string","description":"The INVIMA file number (expediente) of the registration, e.g. `20042480`; every presentation of one medicine shares it."},"cum_sequence":{"type":"number","description":"The presentation's sequence within the file, the second half of the CUM."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registro sanitario as INVIMA prints it, e.g. `INVIMA 2023M-0013598-R2`."},"product":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The medicine's name as registered, e.g. `CARDIK ® 3 160/5/12.5`."},"holder":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The holder (titular) of the registration."},"status":{"type":"string","description":"The registration's status as INVIMA states it: `Vigente`, `Vencido`, `Perdida Fuerza Ejec`, `Cancelado`, `Negado`, `Suspendido`, `En tramite renov`, `Temp. no comerc - Vigente` and others."},"cum_status":{"anyOf":[{"type":"string","enum":["activo","inactivo"]},{"type":"null"}],"description":"Whether this presentation is active in the CUM: `activo` or `inactivo`."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration was issued."},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration expires or expired. Null when INVIMA records none."},"cum_active_since":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the presentation became active in the CUM."},"cum_inactive_since":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the presentation became inactive, when it did."},"commercial_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The commercial presentation as registered, e.g. `CAJA POR 30 TABLETAS RECUBIERTAS EN BLISTER`."},"pack_quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Units in the pack, e.g. 30."},"pack_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit those are counted in, e.g. `U`, `ml` or `g`."},"medical_sample":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the presentation is a medical sample (muestra médica)."},"atc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The WHO ATC code, e.g. `N02BE01`; the `atc_code` filter matches it from the start."},"atc_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the ATC code stands for, as INVIMA writes it."},"pharmaceutical_form":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pharmaceutical form, e.g. `TABLETA RECUBIERTA`, `SOLUCION INYECTABLE`."},"administration_routes":{"type":"array","items":{"type":"string"},"description":"Every route of administration, e.g. `ORAL`, `INTRAVENOSA`."},"active_ingredients":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The active ingredient as INVIMA names it, e.g. `ACETAMINOFEN`."},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How much of it per reference unit, e.g. 500."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit of that quantity, e.g. `mg`."},"reference_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the quantity is per, e.g. `TABLETA RECUBIERTA` or `ML`."}},"required":["name","quantity","unit","reference_unit"]},"description":"Every active ingredient with its quantity per reference unit."},"parties":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"The role as INVIMA names it, e.g. `FABRICANTE`, `IMPORTADOR`, `ACONDICIONADOR`, `APODERADO`, `REPRESENTANTE LEGAL`, `QUIMICO FARMACEUTICO`."},"name":{"type":"string","description":"The company or person in that role, as registered."}},"required":["role","name"]},"description":"Every company in a role on the registration: manufacturers and importers."},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the medicine reaches the market, e.g. `FABRICAR Y VENDER`."},"ium":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Identificador Único de Medicamento, where INVIMA has assigned one."},"entries":{"type":"number","description":"How many rows INVIMA's lists carry for this presentation (one per active ingredient, role holder and route)."}},"required":["id","file_number","cum_sequence","registration_number","product","holder","status","cum_status","issued_at","expires_at","cum_active_since","cum_inactive_since","commercial_description","pack_quantity","pack_unit","medical_sample","atc_code","atc_description","pharmaceutical_form","administration_routes","active_ingredients","parties","modality","ium","entries"]}}},"required":["as_of","query","registration_number","file_number","active_ingredient","atc_code","holder","status","cum_status","expires_from","expires_to","total","total_is_exact","page","per_page","total_pages","count","results"]},"InvimaMedicinesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/InvimaMedicinesSearchData"}}},"InvimaMedicineData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"False when INVIMA lists no presentation under that CUM code."},"cum":{"type":"string"},"medicine":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The CUM code: the file number and the presentation's sequence, e.g. `20042480-41`."},"file_number":{"type":"string","description":"The INVIMA file number (expediente) of the registration, e.g. `20042480`; every presentation of one medicine shares it."},"cum_sequence":{"type":"number","description":"The presentation's sequence within the file, the second half of the CUM."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registro sanitario as INVIMA prints it, e.g. `INVIMA 2023M-0013598-R2`."},"product":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The medicine's name as registered, e.g. `CARDIK ® 3 160/5/12.5`."},"holder":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The holder (titular) of the registration."},"status":{"type":"string","description":"The registration's status as INVIMA states it: `Vigente`, `Vencido`, `Perdida Fuerza Ejec`, `Cancelado`, `Negado`, `Suspendido`, `En tramite renov`, `Temp. no comerc - Vigente` and others."},"cum_status":{"anyOf":[{"type":"string","enum":["activo","inactivo"]},{"type":"null"}],"description":"Whether this presentation is active in the CUM: `activo` or `inactivo`."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration was issued."},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration expires or expired. Null when INVIMA records none."},"cum_active_since":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the presentation became active in the CUM."},"cum_inactive_since":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the presentation became inactive, when it did."},"commercial_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The commercial presentation as registered, e.g. `CAJA POR 30 TABLETAS RECUBIERTAS EN BLISTER`."},"pack_quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Units in the pack, e.g. 30."},"pack_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit those are counted in, e.g. `U`, `ml` or `g`."},"medical_sample":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the presentation is a medical sample (muestra médica)."},"atc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The WHO ATC code, e.g. `N02BE01`; the `atc_code` filter matches it from the start."},"atc_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the ATC code stands for, as INVIMA writes it."},"pharmaceutical_form":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pharmaceutical form, e.g. `TABLETA RECUBIERTA`, `SOLUCION INYECTABLE`."},"administration_routes":{"type":"array","items":{"type":"string"},"description":"Every route of administration, e.g. `ORAL`, `INTRAVENOSA`."},"active_ingredients":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The active ingredient as INVIMA names it, e.g. `ACETAMINOFEN`."},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How much of it per reference unit, e.g. 500."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit of that quantity, e.g. `mg`."},"reference_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the quantity is per, e.g. `TABLETA RECUBIERTA` or `ML`."}},"required":["name","quantity","unit","reference_unit"]},"description":"Every active ingredient with its quantity per reference unit."},"parties":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"The role as INVIMA names it, e.g. `FABRICANTE`, `IMPORTADOR`, `ACONDICIONADOR`, `APODERADO`, `REPRESENTANTE LEGAL`, `QUIMICO FARMACEUTICO`."},"name":{"type":"string","description":"The company or person in that role, as registered."}},"required":["role","name"]},"description":"Every company in a role on the registration: manufacturers and importers."},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the medicine reaches the market, e.g. `FABRICAR Y VENDER`."},"ium":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Identificador Único de Medicamento, where INVIMA has assigned one."},"entries":{"type":"number","description":"How many rows INVIMA's lists carry for this presentation (one per active ingredient, role holder and route)."}},"required":["id","file_number","cum_sequence","registration_number","product","holder","status","cum_status","issued_at","expires_at","cum_active_since","cum_inactive_since","commercial_description","pack_quantity","pack_unit","medical_sample","atc_code","atc_description","pharmaceutical_form","administration_routes","active_ingredients","parties","modality","ium","entries"]},{"type":"null"}]}},"required":["as_of","found","cum","medicine"]},"InvimaMedicineResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/InvimaMedicineData"}}},"MineducacionIndicatorsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"territory_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"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 year and the municipality's DIVIPOLA code, e.g. `2024-05001`."},"year":{"type":"number","description":"The school year the figures describe."},"territory_code":{"type":"string","description":"The municipality's 5-digit DIVIPOLA code, e.g. `05001`."},"territory_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality's name, e.g. `Medellín`."},"department_code":{"type":"string","description":"The department's 2-digit DIVIPOLA code, e.g. `05`."},"department_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department's name, e.g. `Antioquia`."},"certified_entity_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code of the certified territorial entity (entidad territorial certificada, ETC) that runs the municipality's public schools."},"certified_entity_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The certified territorial entity's name, e.g. `Antioquia (ETC)` or `Medellín`."},"population_5_16":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The municipality's population aged 5 to 16, as the Ministry projects it."},"enrollment_rate_5_16":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Children aged 5 to 16 enrolled, over the population of that age, in percent."},"net_coverage":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net coverage: pupils of the official age for the level, over the population of that age across preschool, primary and secondary, in percent."},"transition":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net coverage: pupils of the official age for the level, over the population of that age in transición (the last year of preschool), in percent."},"primary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net coverage: pupils of the official age for the level, over the population of that age in primaria, in percent."},"lower_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net coverage: pupils of the official age for the level, over the population of that age in secundaria (grades 6 to 9), in percent."},"upper_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net coverage: pupils of the official age for the level, over the population of that age in media (grades 10 and 11), in percent."}},"required":["total","transition","primary","lower_secondary","upper_secondary"],"description":"Net coverage: pupils of the official age for the level, over the population of that age, overall and by level, in percent. A level is null where the Ministry publishes nothing for it."},"gross_coverage":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Gross coverage: every pupil in the level, whatever the age, over the population of the official age (can exceed 100) across preschool, primary and secondary, in percent."},"transition":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Gross coverage: every pupil in the level, whatever the age, over the population of the official age (can exceed 100) in transición (the last year of preschool), in percent."},"primary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Gross coverage: every pupil in the level, whatever the age, over the population of the official age (can exceed 100) in primaria, in percent."},"lower_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Gross coverage: every pupil in the level, whatever the age, over the population of the official age (can exceed 100) in secundaria (grades 6 to 9), in percent."},"upper_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Gross coverage: every pupil in the level, whatever the age, over the population of the official age (can exceed 100) in media (grades 10 and 11), in percent."}},"required":["total","transition","primary","lower_secondary","upper_secondary"],"description":"Gross coverage: every pupil in the level, whatever the age, over the population of the official age (can exceed 100), overall and by level, in percent. A level is null where the Ministry publishes nothing for it."},"dropout":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Intra-annual dropout (deserción): pupils who left during the year across preschool, primary and secondary, in percent."},"transition":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Intra-annual dropout (deserción): pupils who left during the year in transición (the last year of preschool), in percent."},"primary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Intra-annual dropout (deserción): pupils who left during the year in primaria, in percent."},"lower_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Intra-annual dropout (deserción): pupils who left during the year in secundaria (grades 6 to 9), in percent."},"upper_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Intra-annual dropout (deserción): pupils who left during the year in media (grades 10 and 11), in percent."}},"required":["total","transition","primary","lower_secondary","upper_secondary"],"description":"Intra-annual dropout (deserción): pupils who left during the year, overall and by level, in percent. A level is null where the Ministry publishes nothing for it."},"approval":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Approval (aprobación): pupils who passed the year across preschool, primary and secondary, in percent."},"transition":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Approval (aprobación): pupils who passed the year in transición (the last year of preschool), in percent."},"primary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Approval (aprobación): pupils who passed the year in primaria, in percent."},"lower_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Approval (aprobación): pupils who passed the year in secundaria (grades 6 to 9), in percent."},"upper_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Approval (aprobación): pupils who passed the year in media (grades 10 and 11), in percent."}},"required":["total","transition","primary","lower_secondary","upper_secondary"],"description":"Approval (aprobación): pupils who passed the year, overall and by level, in percent. A level is null where the Ministry publishes nothing for it."},"failure":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Failure (reprobación): pupils who did not pass the year across preschool, primary and secondary, in percent."},"transition":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Failure (reprobación): pupils who did not pass the year in transición (the last year of preschool), in percent."},"primary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Failure (reprobación): pupils who did not pass the year in primaria, in percent."},"lower_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Failure (reprobación): pupils who did not pass the year in secundaria (grades 6 to 9), in percent."},"upper_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Failure (reprobación): pupils who did not pass the year in media (grades 10 and 11), in percent."}},"required":["total","transition","primary","lower_secondary","upper_secondary"],"description":"Failure (reprobación): pupils who did not pass the year, overall and by level, in percent. A level is null where the Ministry publishes nothing for it."},"repetition":{"type":"object","properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Repetition (repitencia): pupils repeating the grade they were in the year before across preschool, primary and secondary, in percent."},"transition":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Repetition (repitencia): pupils repeating the grade they were in the year before in transición (the last year of preschool), in percent."},"primary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Repetition (repitencia): pupils repeating the grade they were in the year before in primaria, in percent."},"lower_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Repetition (repitencia): pupils repeating the grade they were in the year before in secundaria (grades 6 to 9), in percent."},"upper_secondary":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Repetition (repitencia): pupils repeating the grade they were in the year before in media (grades 10 and 11), in percent."}},"required":["total","transition","primary","lower_secondary","upper_secondary"],"description":"Repetition (repitencia): pupils repeating the grade they were in the year before, overall and by level, in percent. A level is null where the Ministry publishes nothing for it."},"average_group_size":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pupils per class group, on average. Published from 2011 to 2017 only."},"schools_with_internet":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of school sites (sedes) with an internet connection, in percent. Published from 2011 to 2017 only."}},"required":["id","year","territory_code","territory_name","department_code","department_name","certified_entity_code","certified_entity_name","population_5_16","enrollment_rate_5_16","net_coverage","gross_coverage","dropout","approval","failure","repetition","average_group_size","schools_with_internet"]}}},"required":["as_of","query","territory_code","year","total","page","per_page","total_pages","count","results"]},"MineducacionIndicatorsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MineducacionIndicatorsSearchData"}}},"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 from the source (local Colombia time), 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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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"}]},"legal_rep_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 contractor's legal representative, digits only. Filter by it to see every contract a person signed on behalf of a company."},"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","total_is_exact","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","legal_rep_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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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 contractor's legal representative, digits only. Filter by it to see every contract a person signed on behalf of a company."},"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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"}}},"SimevShareholdersData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"False when the NIT is not an issuer with a published shareholder list."},"document_number":{"type":"string","description":"Echoes the request's `document_number`."},"cutoff_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cut-off answered: the one asked, or the latest on record."},"cutoff_dates":{"type":"array","items":{"type":"string"},"description":"Every cut-off on record for the issuer, newest first."},"issuer":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","name","entity_type"]},{"type":"null"}]},"count":{"type":"integer"},"shareholders":{"type":"array","items":{"type":"object","properties":{"document_type_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document type as the registry codes it, as filed."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document number or NIT, as filed."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"nationality_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 3166-1 numeric country code as filed, e.g. `170` for Colombia."},"nationality":{"anyOf":[{"type":"string"},{"type":"null"}]},"ordinary_shares":{"anyOf":[{"type":"number"},{"type":"null"}]},"ordinary_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the ordinary shares, in percent."},"privileged_shares":{"anyOf":[{"type":"number"},{"type":"null"}]},"privileged_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the privileged shares, in percent."},"preferred_shares":{"anyOf":[{"type":"number"},{"type":"null"}]},"preferred_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the preferred shares, in percent."}},"required":["document_type_code","document_number","name","nationality_code","nationality","ordinary_shares","ordinary_pct","privileged_shares","privileged_pct","preferred_shares","preferred_pct"]}},"totals":{"type":"array","items":{"type":"object","properties":{"concept":{"type":"string","description":"The line as the issuer's share register states it, e.g. `ACCIONES ORDINARIAS`, `PORCENTAJE QUE REPRESENTAN PERSONAS NATURALES`."},"shareholders":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Number of holders, or the percentage the line states."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Number of shares, or the percentage the line states."}},"required":["concept","shareholders","shares"]}}},"required":["as_of","found","document_number","cutoff_date","cutoff_dates","issuer","count","shareholders","totals"]},"SimevShareholdersResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SimevShareholdersData"}}},"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"}}},"AdresUninsuredAccidentDebtsData":{"type":"object","properties":{"found":{"type":"boolean","description":"false when ADRES holds no debt for the document."},"document_number":{"type":"string","description":"The queried document number, echoed back."},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name the statement is issued to, null when not found."},"total_owed":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total owed to ADRES, in COP, null when not found."},"claims":{"type":"array","items":{"type":"object","properties":{"claim_id":{"type":"string","description":"ADRES's id for the claim."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's document type as ADRES files it, e.g. \"CC\" or \"NI\"."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's document number on the claim."},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's name as ADRES files it."},"plate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Plate of the vehicle in the accident."},"accident_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the accident (yyyy-mm-dd)."},"package_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the package the IPS filed the claim in."},"claim_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ADRES's number for the claim."},"payment_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date ADRES paid the IPS (yyyy-mm-dd)."},"total_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Amount ADRES paid the IPS, in COP."},"paid":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Amount already repaid to ADRES, in COP."},"balance":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Amount still owed on the claim, in COP."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Collection status, e.g. \"VIGENTE\"."}},"required":["claim_id","document_type","document_number","full_name","plate","accident_date","package_number","claim_number","payment_date","total_value","paid","balance","status"]},"description":"One entry per claim; empty when not found."}},"required":["found","document_number","full_name","total_owed","claims"]},"AdresUninsuredAccidentDebtsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AdresUninsuredAccidentDebtsData"}}},"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"}}},"TerridataIndicatorsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}]},"query":{"type":"string"},"dimension_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"integer"},"total_is_exact":{"type":"boolean","description":"False when there are more than 1000 matches and `total` is a floor."},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"count":{"type":"integer"},"indicators":{"type":"array","items":{"type":"object","properties":{"indicator_code":{"type":"string","description":"Nine-digit indicator code."},"indicator":{"type":"string","description":"The indicator's name, in Spanish."},"dimension_code":{"type":"string","description":"Two-digit dimension code."},"dimension":{"type":"string"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"data_source":{"anyOf":[{"type":"string"},{"type":"null"}]},"territories":{"type":"integer","description":"How many territories have a value for it."},"municipalities":{"type":"integer","description":"How many municipalities have a value for it."},"first_year":{"type":"integer"},"last_year":{"type":"integer"},"observations":{"type":"integer","description":"How many values the panel holds for it, across territories and years."}},"required":["indicator_code","indicator","dimension_code","dimension","subcategory","unit","data_source","territories","municipalities","first_year","last_year","observations"]}}},"required":["as_of","query","dimension_code","total","total_is_exact","page","per_page","total_pages","count","indicators"]},"TerridataIndicatorsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TerridataIndicatorsSearchData"}}},"TerridataSeriesData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}]},"found":{"type":"boolean","description":"False when the panel holds nothing for that territory (and indicator)."},"territory_code":{"type":"string"},"territory_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"territory_level":{"anyOf":[{"type":"string","enum":["country","department","municipality"]},{"type":"null"}]},"indicator_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"dimension_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"query":{"type":"string"},"total":{"type":"integer"},"total_is_exact":{"type":"boolean","description":"False when there are more than 1000 matches and `total` is a floor."},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"count":{"type":"integer"},"series":{"type":"array","items":{"type":"object","properties":{"series_id":{"type":"string","description":"`<territory_code>-<indicator_code>`, the stable key."},"territory_code":{"type":"string","description":"Five-digit DANE code of the territory: a municipality, a department (`DD000`) or `01001` for Colombia."},"territory_name":{"type":"string"},"territory_level":{"type":"string","enum":["country","department","municipality"],"description":"`country`, `department` or `municipality`."},"department_code":{"type":"string","description":"Two-digit DANE code of the territory's department; `01` for Colombia."},"department_name":{"type":"string"},"indicator_code":{"type":"string","description":"Nine-digit indicator code; its first two digits are the dimension."},"indicator":{"type":"string","description":"The indicator's name, in Spanish."},"dimension_code":{"type":"string","description":"Two-digit dimension code."},"dimension":{"type":"string","description":"The dimension's name, in Spanish (`Pobreza`, `Educación`, ...)."},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subcategory inside the dimension, in Spanish."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit of measure, in Spanish (`Porcentaje`, `Número`, `Pesos corrientes`, ...)."},"data_source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agency that produced the figure (`DANE`, `MEN`, `DNP`, ...)."},"first_year":{"type":"integer","description":"The earliest year with a value."},"last_year":{"type":"integer","description":"The latest year with a value."},"latest_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value of the latest year (and month), when numeric."},"latest_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value of the latest year (and month), when text."},"observations":{"type":"array","items":{"type":"object","properties":{"year":{"type":"integer","description":"The year the value describes."},"month":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The month the value describes, `1` to `12`, when the indicator is monthly or measured at a cut-off; null for a description that has no period."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The numeric value, in the series' `unit`."},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value when it is text, e.g. a category or a name."}},"required":["year","month","value","text"]},"description":"Every value of the series, oldest first."}},"required":["series_id","territory_code","territory_name","territory_level","department_code","department_name","indicator_code","indicator","dimension_code","dimension","subcategory","unit","data_source","first_year","last_year","latest_value","latest_text","observations"]}}},"required":["as_of","found","territory_code","territory_name","territory_level","indicator_code","dimension_code","query","total","total_is_exact","page","per_page","total_pages","count","series"]},"TerridataSeriesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TerridataSeriesData"}}},"TerridataRankingData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}]},"found":{"type":"boolean","description":"False when no territory at that level has a numeric value for the indicator (and year)."},"indicator_code":{"type":"string"},"indicator":{"anyOf":[{"type":"string"},{"type":"null"}]},"dimension":{"anyOf":[{"type":"string"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"data_source":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The year compared; null when each territory's latest value is compared."},"level":{"type":"string","enum":["municipality","department"]},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"order":{"type":"string","enum":["desc","asc"]},"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"count":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"integer"},"territory_code":{"type":"string"},"territory_name":{"type":"string"},"department_code":{"type":"string"},"department_name":{"type":"string"},"year":{"type":"integer"},"month":{"anyOf":[{"type":"integer"},{"type":"null"}]},"value":{"type":"number"}},"required":["rank","territory_code","territory_name","department_code","department_name","year","month","value"]}}},"required":["as_of","found","indicator_code","indicator","dimension","unit","data_source","year","level","department_code","order","total","page","per_page","total_pages","count","results"]},"TerridataRankingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TerridataRankingData"}}},"TransmilenioStopsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the network last published the data in this response."},"query":{"type":"string"},"route":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"radius_m":{"anyOf":[{"type":"integer"},{"type":"null"}]},"total":{"type":"integer","description":"Matches across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match and `total` is a floor."},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"count":{"type":"integer"},"stops":{"type":"array","items":{"type":"object","properties":{"stop_id":{"type":"string","description":"The stop's id in the network's feed, e.g. `10000`."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code shown at the stop, when it has one, e.g. `B096` or `080A01_TM`."},"name":{"type":"string","description":"The stop's or station's name, e.g. `Portal Norte T1`."},"kind":{"type":"string","enum":["stop","station","entrance","node","boarding_area"],"description":"`station` (holds platforms), `stop` (a platform or a street stop), `entrance`, `node` or `boarding_area`."},"parent_station":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The `stop_id` of the station a platform belongs to."},"latitude":{"type":"number","description":"Decimal degrees (WGS84)."},"longitude":{"type":"number","description":"Decimal degrees (WGS84)."},"wheelchair_boarding":{"anyOf":[{"type":"string","enum":["accessible","not_accessible"]},{"type":"null"}],"description":"Whether a wheelchair can board here; null when the feed does not say."},"zone_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"route_ids":{"type":"array","items":{"type":"string"},"description":"Every route that stops here (for a station, at any of its platforms)."},"route_codes":{"type":"array","items":{"type":"string"},"description":"The public codes of those routes, e.g. `B10`, upper case."},"routes":{"type":"array","items":{"type":"object","properties":{"route_id":{"type":"string"},"short_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code printed on the bus, e.g. `B10`."},"long_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The route's name, usually its destination, e.g. `Portal Norte`."},"system":{"type":"string","enum":["troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable","other"]}},"required":["route_id","short_name","long_name","system"]},"description":"Every route that stops here, with its code, name and system."},"systems":{"type":"array","items":{"type":"string","enum":["troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable","other"]},"description":"The parts of the network that serve the stop."},"platforms":{"type":"array","items":{"type":"string"},"description":"For a station, the `stop_id` of every platform inside it."},"distance_m":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Metres from the point searched around; null without one."}},"required":["stop_id","code","name","kind","parent_station","latitude","longitude","wheelchair_boarding","zone_id","route_ids","route_codes","routes","systems","platforms","distance_m"]}}},"required":["as_of","query","route","kind","latitude","longitude","radius_m","total","total_is_exact","page","per_page","total_pages","count","stops"]},"TransmilenioStopsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TransmilenioStopsSearchData"}}},"TransmilenioStopData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the network last published the data in this response."},"found":{"type":"boolean","description":"False for an id the network does not publish."},"stop_id":{"type":"string"},"stop":{"anyOf":[{"type":"object","properties":{"stop_id":{"type":"string","description":"The stop's id in the network's feed, e.g. `10000`."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code shown at the stop, when it has one, e.g. `B096` or `080A01_TM`."},"name":{"type":"string","description":"The stop's or station's name, e.g. `Portal Norte T1`."},"kind":{"type":"string","enum":["stop","station","entrance","node","boarding_area"],"description":"`station` (holds platforms), `stop` (a platform or a street stop), `entrance`, `node` or `boarding_area`."},"parent_station":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The `stop_id` of the station a platform belongs to."},"latitude":{"type":"number","description":"Decimal degrees (WGS84)."},"longitude":{"type":"number","description":"Decimal degrees (WGS84)."},"wheelchair_boarding":{"anyOf":[{"type":"string","enum":["accessible","not_accessible"]},{"type":"null"}],"description":"Whether a wheelchair can board here; null when the feed does not say."},"zone_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"route_ids":{"type":"array","items":{"type":"string"},"description":"Every route that stops here (for a station, at any of its platforms)."},"route_codes":{"type":"array","items":{"type":"string"},"description":"The public codes of those routes, e.g. `B10`, upper case."},"routes":{"type":"array","items":{"type":"object","properties":{"route_id":{"type":"string"},"short_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code printed on the bus, e.g. `B10`."},"long_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The route's name, usually its destination, e.g. `Portal Norte`."},"system":{"type":"string","enum":["troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable","other"]}},"required":["route_id","short_name","long_name","system"]},"description":"Every route that stops here, with its code, name and system."},"systems":{"type":"array","items":{"type":"string","enum":["troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable","other"]},"description":"The parts of the network that serve the stop."},"platforms":{"type":"array","items":{"type":"string"},"description":"For a station, the `stop_id` of every platform inside it."}},"required":["stop_id","code","name","kind","parent_station","latitude","longitude","wheelchair_boarding","zone_id","route_ids","route_codes","routes","systems","platforms"]},{"type":"null"}]},"station":{"anyOf":[{"type":"object","properties":{"stop_id":{"type":"string","description":"The stop's id in the network's feed, e.g. `10000`."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code shown at the stop, when it has one, e.g. `B096` or `080A01_TM`."},"name":{"type":"string","description":"The stop's or station's name, e.g. `Portal Norte T1`."},"kind":{"type":"string","enum":["stop","station","entrance","node","boarding_area"],"description":"`station` (holds platforms), `stop` (a platform or a street stop), `entrance`, `node` or `boarding_area`."},"parent_station":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The `stop_id` of the station a platform belongs to."},"latitude":{"type":"number","description":"Decimal degrees (WGS84)."},"longitude":{"type":"number","description":"Decimal degrees (WGS84)."},"wheelchair_boarding":{"anyOf":[{"type":"string","enum":["accessible","not_accessible"]},{"type":"null"}],"description":"Whether a wheelchair can board here; null when the feed does not say."},"zone_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"route_ids":{"type":"array","items":{"type":"string"},"description":"Every route that stops here (for a station, at any of its platforms)."},"route_codes":{"type":"array","items":{"type":"string"},"description":"The public codes of those routes, e.g. `B10`, upper case."},"routes":{"type":"array","items":{"type":"object","properties":{"route_id":{"type":"string"},"short_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code printed on the bus, e.g. `B10`."},"long_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The route's name, usually its destination, e.g. `Portal Norte`."},"system":{"type":"string","enum":["troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable","other"]}},"required":["route_id","short_name","long_name","system"]},"description":"Every route that stops here, with its code, name and system."},"systems":{"type":"array","items":{"type":"string","enum":["troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable","other"]},"description":"The parts of the network that serve the stop."},"platforms":{"type":"array","items":{"type":"string"},"description":"For a station, the `stop_id` of every platform inside it."}},"required":["stop_id","code","name","kind","parent_station","latitude","longitude","wheelchair_boarding","zone_id","route_ids","route_codes","routes","systems","platforms"]},{"type":"null"}],"description":"For a platform, the station it belongs to."}},"required":["as_of","found","stop_id","stop","station"]},"TransmilenioStopResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TransmilenioStopData"}}},"TransmilenioStopDeparturesData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the network last published the data in this response."},"found":{"type":"boolean","description":"False for an id the network does not publish."},"stop_id":{"type":"string"},"stop_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"date":{"type":"string","description":"The service day read, `yyyy-mm-dd`."},"from_time":{"type":"string","description":"`HH:MM` the list starts from."},"route":{"anyOf":[{"type":"string"},{"type":"null"}]},"services":{"type":"array","items":{"type":"string"},"description":"The timetables in force that day."},"count":{"type":"integer"},"departures":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string","description":"`HH:MM` on the clock in Bogotá."},"at":{"type":"string","description":"The departure as an ISO 8601 timestamp, `-05:00`."},"minutes_from_now":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Minutes from the moment of the request; null for another day."},"route_id":{"type":"string"},"route_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"route_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"system":{"type":"string","enum":["troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable","other"]},"stop_id":{"type":"string","description":"The platform it leaves from (for a station, one of its platforms)."}},"required":["time","at","minutes_from_now","route_id","route_code","route_name","system","stop_id"]}}},"required":["as_of","found","stop_id","stop_name","date","from_time","route","services","count","departures"]},"TransmilenioStopDeparturesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TransmilenioStopDeparturesData"}}},"TransmilenioRoutesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the network last published the data in this response."},"query":{"type":"string"},"system":{"anyOf":[{"type":"string"},{"type":"null"}]},"stop_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"integer","description":"Matches across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match and `total` is a floor."},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"count":{"type":"integer"},"routes":{"type":"array","items":{"type":"object","properties":{"route_id":{"type":"string","description":"The route's id; each direction has its own."},"short_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code printed on the bus, upper case, e.g. `B10`."},"long_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The route's name, usually its destination."},"system":{"type":"string","enum":["troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable","other"],"description":"`troncal`, `alimentador`, `dual`, `zonal_urbano`, `zonal_complementario`, `zonal_especial` or `transmicable`."},"system_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The operating agency's name in the feed, e.g. `Transmilenio-Troncal`."},"mode":{"type":"string","enum":["bus","gondola","rail","other"],"description":"The vehicle: `bus` or `gondola` (TransMiCable)."},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The route's colour as `#rrggbb`."},"text_color":{"anyOf":[{"type":"string"},{"type":"null"}]},"stops_count":{"type":"integer"},"trips_per_week":{"type":"integer","description":"Scheduled trips a week."},"first_departure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`HH:MM:SS` of the earliest departure on any day."},"last_departure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`HH:MM:SS` of the latest departure on any day; past `24:00:00` means after midnight."},"services":{"type":"array","items":{"type":"object","properties":{"service_id":{"type":"string"},"days":{"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"description":"The weekdays this timetable runs; public holidays may swap it for another."},"trips":{"type":"integer","description":"Trips a day."},"first_departure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`HH:MM:SS` of the first departure from the first stop; past `24:00:00` means after midnight."},"last_departure":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["service_id","days","trips","first_departure","last_departure"]},"description":"The timetables the route runs, with their days, trips and first and last departures."},"headways":{"type":"array","items":{"type":"object","properties":{"start_time":{"type":"string"},"end_time":{"type":"string"},"headway_seconds":{"type":"integer"}},"required":["start_time","end_time","headway_seconds"]},"description":"Windows where the route runs by frequency rather than a fixed timetable (TransMiCable)."}},"required":["route_id","short_name","long_name","system","system_name","mode","color","text_color","stops_count","trips_per_week","first_departure","last_departure","services","headways"]}}},"required":["as_of","query","system","stop_id","total","total_is_exact","page","per_page","total_pages","count","routes"]},"TransmilenioRoutesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TransmilenioRoutesSearchData"}}},"TransmilenioRouteData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the network last published the data in this response."},"found":{"type":"boolean","description":"False for an id the network does not publish."},"route_id":{"type":"string"},"route":{"anyOf":[{"type":"object","properties":{"route_id":{"type":"string","description":"The route's id; each direction has its own."},"short_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code printed on the bus, upper case, e.g. `B10`."},"long_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The route's name, usually its destination."},"system":{"type":"string","enum":["troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable","other"],"description":"`troncal`, `alimentador`, `dual`, `zonal_urbano`, `zonal_complementario`, `zonal_especial` or `transmicable`."},"system_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The operating agency's name in the feed, e.g. `Transmilenio-Troncal`."},"mode":{"type":"string","enum":["bus","gondola","rail","other"],"description":"The vehicle: `bus` or `gondola` (TransMiCable)."},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The route's colour as `#rrggbb`."},"text_color":{"anyOf":[{"type":"string"},{"type":"null"}]},"stops_count":{"type":"integer"},"trips_per_week":{"type":"integer","description":"Scheduled trips a week."},"first_departure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`HH:MM:SS` of the earliest departure on any day."},"last_departure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`HH:MM:SS` of the latest departure on any day; past `24:00:00` means after midnight."},"services":{"type":"array","items":{"type":"object","properties":{"service_id":{"type":"string"},"days":{"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"description":"The weekdays this timetable runs; public holidays may swap it for another."},"trips":{"type":"integer","description":"Trips a day."},"first_departure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`HH:MM:SS` of the first departure from the first stop; past `24:00:00` means after midnight."},"last_departure":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["service_id","days","trips","first_departure","last_departure"]},"description":"The timetables the route runs, with their days, trips and first and last departures."},"headways":{"type":"array","items":{"type":"object","properties":{"start_time":{"type":"string"},"end_time":{"type":"string"},"headway_seconds":{"type":"integer"}},"required":["start_time","end_time","headway_seconds"]},"description":"Windows where the route runs by frequency rather than a fixed timetable (TransMiCable)."},"patterns":{"type":"array","items":{"type":"object","properties":{"shape_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The path's id; pass `include_geometry` to the route lookup for its map line."},"trips_per_week":{"type":"integer","description":"Scheduled trips a week that follow this sequence of stops."},"stops":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer"},"stop_id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"offset_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Scheduled seconds after the trip leaves its first stop."}},"required":["sequence","stop_id","name","code","latitude","longitude","offset_seconds"]},"description":"The stops in the order the bus serves them."},"length_m":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The path's length in metres."},"geometry":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"LineString"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"number"}}}},"required":["type","coordinates"]},{"type":"null"}],"description":"The path as GeoJSON, with `include_geometry`; null otherwise."}},"required":["shape_id","trips_per_week","stops","length_m","geometry"]}}},"required":["route_id","short_name","long_name","system","system_name","mode","color","text_color","stops_count","trips_per_week","first_departure","last_departure","services","headways","patterns"]},{"type":"null"}]}},"required":["as_of","found","route_id","route"]},"TransmilenioRouteResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TransmilenioRouteData"}}},"TransmilenioVehiclesData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the network last published the data in this response."},"live":{"type":"boolean","description":"False when the network has published nothing new for over 5 minutes; `as_of` says when it last did."},"notice":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null while the data is live. Otherwise, in plain words: that TransMilenio is not publishing live data, since when, and what this response holds instead."},"route":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"radius_m":{"anyOf":[{"type":"integer"},{"type":"null"}]},"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"count":{"type":"integer"},"vehicles":{"type":"array","items":{"type":"object","properties":{"vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The vehicle's fleet label."},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"type":"number"},"longitude":{"type":"number"},"bearing":{"anyOf":[{"type":"number"},{"type":"null"}]},"speed_kmh":{"anyOf":[{"type":"number"},{"type":"null"}]},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"route_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"route_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"system":{"anyOf":[{"type":"string","enum":["troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable","other"]},{"type":"null"}]},"trip_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"trip_start_time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`HH:MM:SS` the trip was scheduled to start."},"stop_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The stop the vehicle is at or heading to."},"stop_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"stop_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`incoming_at`, `stopped_at` or `in_transit_to` that stop."},"reported_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the vehicle reported this position, ISO 8601."},"distance_m":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Metres from the point searched around; null without one."}},"required":["vehicle_id","label","license_plate","latitude","longitude","bearing","speed_kmh","route_id","route_code","route_name","system","trip_id","trip_start_time","stop_id","stop_name","stop_status","reported_at","distance_m"]}}},"required":["as_of","live","notice","route","latitude","longitude","radius_m","total","page","per_page","total_pages","count","vehicles"]},"TransmilenioVehiclesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TransmilenioVehiclesData"}}},"TransmilenioStopArrivalsData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the network last published the data in this response."},"live":{"type":"boolean","description":"False when the network has published nothing new for over 5 minutes; `as_of` says when it last did."},"notice":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null while the data is live. Otherwise, in plain words: that TransMilenio is not publishing live data, since when, and what this response holds instead."},"found":{"type":"boolean","description":"False for an id the network does not publish."},"stop_id":{"type":"string"},"stop_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"route":{"anyOf":[{"type":"string"},{"type":"null"}]},"count":{"type":"integer"},"arrivals":{"type":"array","items":{"type":"object","properties":{"predicted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the vehicle is expected at the stop, ISO 8601 `-05:00`."},"minutes_away":{"anyOf":[{"type":"integer"},{"type":"null"}]},"basis":{"type":"string","enum":["predicted","estimated","scheduled"],"description":"`predicted` when the network predicts this stop itself; `estimated` from the last stop the vehicle reported plus the scheduled running time from there; `scheduled` from the timetable, when the live data is not arriving (`live: false`)."},"delay_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Seconds behind (positive) or ahead of (negative) the timetable."},"stop_id":{"type":"string","description":"The platform it arrives at."},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"route_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"route_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"system":{"anyOf":[{"type":"string","enum":["troncal","alimentador","dual","zonal_urbano","zonal_complementario","zonal_especial","transmicable","other"]},{"type":"null"}]},"trip_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"vehicle_label":{"anyOf":[{"type":"string"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["predicted_at","minutes_away","basis","delay_seconds","stop_id","route_id","route_code","route_name","system","trip_id","vehicle_id","vehicle_label","license_plate"]}}},"required":["as_of","live","notice","found","stop_id","stop_name","route","count","arrivals"]},"TransmilenioStopArrivalsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TransmilenioStopArrivalsData"}}},"TransmilenioAlertsData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the network last published the data in this response."},"route":{"anyOf":[{"type":"string"},{"type":"null"}]},"stop_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"count":{"type":"integer"},"alerts":{"type":"array","items":{"type":"object","properties":{"alert_id":{"type":"string"},"cause":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`technical_problem`, `accident`, `construction`, `demonstration`, ... as the network classifies it."},"effect":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`detour`, `no_service`, `reduced_service`, `significant_delays`, `stop_moved`, ..."},"header":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"active_periods":{"type":"array","items":{"type":"object","properties":{"start":{"anyOf":[{"type":"string"},{"type":"null"}]},"end":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["start","end"]}},"routes":{"type":"array","items":{"type":"object","properties":{"route_id":{"type":"string"},"route_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"route_name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["route_id","route_code","route_name"]}},"stops":{"type":"array","items":{"type":"object","properties":{"stop_id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["stop_id","name"]}}},"required":["alert_id","cause","effect","header","description","url","active_periods","routes","stops"]}}},"required":["as_of","route","stop_id","count","alerts"]},"TransmilenioAlertsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TransmilenioAlertsData"}}},"SupersociedadesShareholdersData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when the NIT has no filing with these notes."},"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"}]}},"required":["name"]},{"type":"null"}]},"filing":{"anyOf":[{"type":"object","properties":{"year":{"type":"number","description":"Fiscal year of the filing."},"cutoff_date":{"type":"string","description":"Fiscal-year cutoff (yyyy-mm-dd)."},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filing number (radicado)."},"statement_type":{"anyOf":[{"type":"string","enum":["individual","separado","consolidado","combinado"]},{"type":"null"}]},"niif_group":{"anyOf":[{"type":"string","enum":["plenas","pymes"]},{"type":"null"}]}},"required":["year","cutoff_date","filing_id","statement_type","niif_group"]},{"type":"null"}]},"shareholders":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name as declared."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document type as declared, e.g. \"CEDULA DE CIUDADANIA\", \"NIT\", \"CEDULA DE EXTRANJERIA\", \"PASAPORTE\"."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document number or NIT as declared."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country as declared, e.g. \"169 - COLOMBIA\"."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares or cuotas held, as declared."},"participation_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the capital, in percent, as declared."}},"required":["name","document_type","document_number","country","shares","participation_pct"]},"description":"Shareholders or partners as declared in the filing's notes."},"foreign_investors":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name as declared."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document type as declared, e.g. \"CEDULA DE CIUDADANIA\", \"NIT\", \"CEDULA DE EXTRANJERIA\", \"PASAPORTE\"."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document number or NIT as declared."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country as declared, e.g. \"169 - COLOMBIA\"."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares held, as declared."},"participation_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the capital, in percent, as declared."},"movement":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Movement of the stake during the fiscal year, as declared."}},"required":["name","document_type","document_number","country","shares","participation_pct","movement"]},"description":"Foreign investors as declared, when the filing carries that note."},"subsidiaries":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subsidiary's NIT, as declared."},"place_of_business":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"non_controlling_interest_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the subsidiary's capital held by parties other than this company, in percent."},"non_controlling_voting_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the subsidiary's voting rights held by parties other than this company, in percent."}},"required":["name","document_number","place_of_business","country","non_controlling_interest_pct","non_controlling_voting_pct"]},"description":"Companies this company controls, as declared."},"associates":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The associate's NIT, as declared."},"place_of_business":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownership_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"This company's share of the associate's capital, in percent."},"voting_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"This company's share of the associate's voting rights, in percent."}},"required":["name","document_number","place_of_business","country","ownership_pct","voting_pct"]},"description":"Companies this company holds a significant stake in, as declared."},"officers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"`legal_representative`, `first_alternate_legal_representative`, `second_alternate_legal_representative`, `accountant`, `statutory_auditor` (revisor fiscal), `alternate_statutory_auditor`, or the filing's own label."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_names":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_names":{"anyOf":[{"type":"string"},{"type":"null"}]},"professional_card":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tarjeta profesional, for the accountant and the revisor fiscal."},"chamber_registration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the appointment was registered at the chamber of commerce, yyyy-mm-dd."}},"required":["role","document_type","document_number","first_names","last_names","professional_card","chamber_registration_date"]},"description":"Legal representatives, accountant and revisor fiscal as declared."}},"required":["found","document_number","company","filing","shareholders","foreign_investors","subsidiaries","associates","officers"]},"SupersociedadesShareholdersResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesShareholdersData"}}},"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"}}},"SupersociedadesCompaniesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"number","description":"Matches across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number","description":"Results on this page."},"fiscal_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The fiscal year searched: the one asked, or the latest available when `0` was sent. Null when the copy is empty."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The filing's identifier: entry point, NIT and corte, e.g. `pymes_individuales_800011651_2025-12-31`. The same filing carries the same id in every Supersociedades dataset."},"document_number":{"type":"string","description":"The company's NIT, numeric, no verification digit."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as filed."},"fiscal_year":{"type":"integer","description":"Fiscal year of the corte."},"cutoff_date":{"type":"string","description":"The corte, `yyyy-mm-dd`; December 31 for an annual filing."},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de radicado of the filing. Numbers grow with time, so the highest one held for a corte is what a refresh reads above."},"statement_type":{"anyOf":[{"type":"string","enum":["individual","separado","consolidado","combinado"]},{"type":"null"}],"description":"What the filing covers: `individual`, `separado`, `consolidado` or `combinado`."},"niif_group":{"anyOf":[{"type":"string","enum":["plenas","pymes"]},{"type":"null"}],"description":"Reporting framework: `plenas` (group 1) or `pymes` (group 2)."},"preferred":{"type":"boolean","description":"True for the one filing that stands for the company in that fiscal year: the individual books when filed, else the separado, else the consolidado, latest radicado first. Searches return preferred filings unless asked otherwise."},"ciiu_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Primary CIIU Rev. 4 A.C. activity code as filed, four digits, e.g. `4220`. A prefix filter takes a division (`42`) or a full code."},"ciiu_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The activity's label as filed."},"ciiu_section":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CIIU section letter, `A` to `U`; `F` is construction."},"ciiu_division":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CIIU two-digit division, e.g. `42`."},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The CIIU division's label, e.g. `Obras de ingeniería civil`."},"macrosector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's own grouping: `AGROPECUARIO`, `MINERO E HIDROCARBUROS`, `MANUFACTURA`, `CONSTRUCCION`, `COMERCIO`, `SERVICIOS`, `TRANSPORTE`, or `SIN CIIU`."},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Region as the Superintendencia groups departments, e.g. `Bogotá-Cundinamarca`, `Antioquia`, `Región Caribe`."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department of the company's domicile, as filed."},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City of the company's domicile, as filed."},"supervision_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's standing before the Superintendencia: `INSPECCION`, `VIGILANCIA`, `CONTROL`, `CANCELADA`, `EXENTA`; null when the filing carries none."},"supervision_status_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the supervision status was set."},"incorporation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of incorporation."},"employees_men":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Men employed, as filed."},"employees_women":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Women employed, as filed."},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Ingresos de actividades ordinarias for the fiscal year, in thousands of COP."},"gross_profit":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Ganancia bruta, in thousands of COP."},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Ganancia (pérdida) for the fiscal year, in thousands of COP."},"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total de activos at the corte, in thousands of COP."},"total_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total pasivos at the corte, in thousands of COP."},"total_equity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Patrimonio total at the corte, in thousands of COP."},"revenue_previous":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Revenue restated for the previous fiscal year."},"gross_profit_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_assets_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_equity_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"comprehensive_income":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Resultado integral total for the fiscal year, in thousands of COP."},"other_comprehensive_income":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Otro resultado integral for the fiscal year, in thousands of COP."},"comprehensive_income_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"other_comprehensive_income_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_from_operating":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net cash from operating activities, in thousands of COP."},"cash_from_investing":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_from_financing":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_from_operating_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_from_investing_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_from_financing_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"debt_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Nivel de endeudamiento: total liabilities over total assets."},"liquidity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Razón de liquidez general."},"roa":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Return on assets, as a fraction."},"roe":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Return on equity, as a fraction."},"margin":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Gross margin, as a fraction."},"ros":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Return on sales (net income over revenue), as a fraction."},"debt_ratio_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"liquidity_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"roa_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"roe_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"rank_country":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The Superintendencia's ranking of the company by revenue among every filer that year; null when not ranked."},"rank_sector":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Ranking within its macrosector; null when not ranked."},"rank_top500":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Position among the 500 largest, when in it."},"rank_top9000":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Position among the 9,000 largest, when in it."},"rank_country_previous":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Previous year's ranking among every filer."},"rank_sector_previous":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Previous year's ranking within its macrosector."},"insolvency_processes_active":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Insolvency processes open at the corte, as the Superintendencia counts them."},"insolvency_processes_closed":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Insolvency processes closed, as the Superintendencia counts them."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address of the domicile, as filed."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude of the domicile as the Superintendencia geocodes it."},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","document_number","name","fiscal_year","cutoff_date","filing_id","statement_type","niif_group","preferred","ciiu_code","ciiu_description","ciiu_section","ciiu_division","sector","macrosector","region","department","city","supervision_status","supervision_status_date","incorporation_date","employees_men","employees_women","revenue","gross_profit","net_income","total_assets","total_liabilities","total_equity","revenue_previous","gross_profit_previous","net_income_previous","total_assets_previous","total_liabilities_previous","total_equity_previous","comprehensive_income","other_comprehensive_income","comprehensive_income_previous","other_comprehensive_income_previous","cash_from_operating","cash_from_investing","cash_from_financing","cash_from_operating_previous","cash_from_investing_previous","cash_from_financing_previous","debt_ratio","liquidity","roa","roe","margin","ros","debt_ratio_previous","liquidity_previous","roa_previous","roe_previous","rank_country","rank_sector","rank_top500","rank_top9000","rank_country_previous","rank_sector_previous","insolvency_processes_active","insolvency_processes_closed","address","latitude","longitude"]},"description":"Largest revenue first."}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","fiscal_year","results"]},"SupersociedadesCompaniesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesCompaniesSearchData"}}},"SupersociedadesCompanyData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"False when the NIT has no filing on record."},"document_number":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as filed most recently."},"fiscal_years":{"type":"array","items":{"type":"number"},"description":"Every fiscal year the company filed for, newest first."},"filings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The filing's identifier: entry point, NIT and corte, e.g. `pymes_individuales_800011651_2025-12-31`. The same filing carries the same id in every Supersociedades dataset."},"document_number":{"type":"string","description":"The company's NIT, numeric, no verification digit."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as filed."},"fiscal_year":{"type":"integer","description":"Fiscal year of the corte."},"cutoff_date":{"type":"string","description":"The corte, `yyyy-mm-dd`; December 31 for an annual filing."},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de radicado of the filing. Numbers grow with time, so the highest one held for a corte is what a refresh reads above."},"statement_type":{"anyOf":[{"type":"string","enum":["individual","separado","consolidado","combinado"]},{"type":"null"}],"description":"What the filing covers: `individual`, `separado`, `consolidado` or `combinado`."},"niif_group":{"anyOf":[{"type":"string","enum":["plenas","pymes"]},{"type":"null"}],"description":"Reporting framework: `plenas` (group 1) or `pymes` (group 2)."},"preferred":{"type":"boolean","description":"True for the one filing that stands for the company in that fiscal year: the individual books when filed, else the separado, else the consolidado, latest radicado first. Searches return preferred filings unless asked otherwise."},"ciiu_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Primary CIIU Rev. 4 A.C. activity code as filed, four digits, e.g. `4220`. A prefix filter takes a division (`42`) or a full code."},"ciiu_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The activity's label as filed."},"ciiu_section":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CIIU section letter, `A` to `U`; `F` is construction."},"ciiu_division":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CIIU two-digit division, e.g. `42`."},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The CIIU division's label, e.g. `Obras de ingeniería civil`."},"macrosector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's own grouping: `AGROPECUARIO`, `MINERO E HIDROCARBUROS`, `MANUFACTURA`, `CONSTRUCCION`, `COMERCIO`, `SERVICIOS`, `TRANSPORTE`, or `SIN CIIU`."},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Region as the Superintendencia groups departments, e.g. `Bogotá-Cundinamarca`, `Antioquia`, `Región Caribe`."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department of the company's domicile, as filed."},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City of the company's domicile, as filed."},"supervision_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's standing before the Superintendencia: `INSPECCION`, `VIGILANCIA`, `CONTROL`, `CANCELADA`, `EXENTA`; null when the filing carries none."},"supervision_status_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the supervision status was set."},"incorporation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of incorporation."},"employees_men":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Men employed, as filed."},"employees_women":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Women employed, as filed."},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Ingresos de actividades ordinarias for the fiscal year, in thousands of COP."},"gross_profit":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Ganancia bruta, in thousands of COP."},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Ganancia (pérdida) for the fiscal year, in thousands of COP."},"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total de activos at the corte, in thousands of COP."},"total_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total pasivos at the corte, in thousands of COP."},"total_equity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Patrimonio total at the corte, in thousands of COP."},"revenue_previous":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Revenue restated for the previous fiscal year."},"gross_profit_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_assets_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_equity_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"comprehensive_income":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Resultado integral total for the fiscal year, in thousands of COP."},"other_comprehensive_income":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Otro resultado integral for the fiscal year, in thousands of COP."},"comprehensive_income_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"other_comprehensive_income_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_from_operating":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net cash from operating activities, in thousands of COP."},"cash_from_investing":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_from_financing":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_from_operating_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_from_investing_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_from_financing_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"debt_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Nivel de endeudamiento: total liabilities over total assets."},"liquidity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Razón de liquidez general."},"roa":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Return on assets, as a fraction."},"roe":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Return on equity, as a fraction."},"margin":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Gross margin, as a fraction."},"ros":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Return on sales (net income over revenue), as a fraction."},"debt_ratio_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"liquidity_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"roa_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"roe_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"rank_country":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The Superintendencia's ranking of the company by revenue among every filer that year; null when not ranked."},"rank_sector":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Ranking within its macrosector; null when not ranked."},"rank_top500":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Position among the 500 largest, when in it."},"rank_top9000":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Position among the 9,000 largest, when in it."},"rank_country_previous":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Previous year's ranking among every filer."},"rank_sector_previous":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Previous year's ranking within its macrosector."},"insolvency_processes_active":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Insolvency processes open at the corte, as the Superintendencia counts them."},"insolvency_processes_closed":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Insolvency processes closed, as the Superintendencia counts them."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address of the domicile, as filed."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude of the domicile as the Superintendencia geocodes it."},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","document_number","name","fiscal_year","cutoff_date","filing_id","statement_type","niif_group","preferred","ciiu_code","ciiu_description","ciiu_section","ciiu_division","sector","macrosector","region","department","city","supervision_status","supervision_status_date","incorporation_date","employees_men","employees_women","revenue","gross_profit","net_income","total_assets","total_liabilities","total_equity","revenue_previous","gross_profit_previous","net_income_previous","total_assets_previous","total_liabilities_previous","total_equity_previous","comprehensive_income","other_comprehensive_income","comprehensive_income_previous","other_comprehensive_income_previous","cash_from_operating","cash_from_investing","cash_from_financing","cash_from_operating_previous","cash_from_investing_previous","cash_from_financing_previous","debt_ratio","liquidity","roa","roe","margin","ros","debt_ratio_previous","liquidity_previous","roa_previous","roe_previous","rank_country","rank_sector","rank_top500","rank_top9000","rank_country_previous","rank_sector_previous","insolvency_processes_active","insolvency_processes_closed","address","latitude","longitude"]},"description":"Every filing on record, newest first, the preferred filing of each year first."}},"required":["as_of","found","document_number","name","fiscal_years","filings"]},"SupersociedadesCompanyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesCompanyData"}}},"SupersociedadesFilingStatementsData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"False when no filing matches the NIT, year and statement type asked."},"document_number":{"type":"string"},"fiscal_years":{"type":"array","items":{"type":"number"},"description":"Every fiscal year the company has a filing for in this dataset, newest first."},"filing":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The filing's identifier: entry point, NIT and corte, e.g. `pymes_individuales_800011651_2025-12-31`. The same filing carries the same id in every Supersociedades dataset."},"document_number":{"type":"string","description":"The company's NIT, numeric, no verification digit."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as filed."},"fiscal_year":{"type":"integer","description":"Fiscal year of the corte."},"cutoff_date":{"type":"string","description":"The corte, `yyyy-mm-dd`; December 31 for an annual filing."},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de radicado of the filing. Numbers grow with time, so the highest one held for a corte is what a refresh reads above."},"statement_type":{"anyOf":[{"type":"string","enum":["individual","separado","consolidado","combinado"]},{"type":"null"}],"description":"What the filing covers: `individual`, `separado`, `consolidado` or `combinado`."},"niif_group":{"anyOf":[{"type":"string","enum":["plenas","pymes"]},{"type":"null"}],"description":"Reporting framework: `plenas` (group 1) or `pymes` (group 2)."},"preferred":{"type":"boolean","description":"True for the one filing that stands for the company in that fiscal year: the individual books when filed, else the separado, else the consolidado, latest radicado first. Searches return preferred filings unless asked otherwise."},"reporting_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit every figure is filed in, as the cover declares it (`MILES DE PESOS` from fiscal 2025); null on older filings, which are also in thousands of COP."},"business_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Objeto social principal, as filed."},"society_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Corporate form, e.g. \"08. SOCIEDAD POR ACCIONES SIMPLIFICADA SAS\"."},"company_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the company declares itself to be (\"La sociedad es\"), e.g. \"07. ACTIVIDAD ECONÓMICA DIFERENTE A LAS ANTERIORES\"."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State on the filing cover (\"Estado actual\"), e.g. \"ACTIVA\"."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Matrícula mercantil."},"incorporation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of incorporation."},"accounts_closing":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Corte de cuentas según estatutos, e.g. \"01. ANUAL\"."},"has_statutory_auditor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the company is required to have a revisor fiscal."},"audited":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the statements come with the revisor fiscal's opinion."},"auditor_opinion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The revisor fiscal's opinion, e.g. \"03. LIMPIO\"."},"restated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the statements present restated figures."},"dividends_approved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the shareholders' meeting approved distributing the previous year's profit."},"has_investments_in_others":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the company declares subsidiaries, associates or joint ventures."},"cover":{"type":"array","items":{"type":"object","properties":{"concept":{"type":"string","description":"The concept as the taxonomy names it, e.g. `NombreAccionistaSocio`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The concept's label in the form, when the filing carries it."},"value":{"type":"string","description":"The value as filed. Numbers are filed as text, in the filing's unit."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the fact's period ends, when the form carries several periods."}},"required":["concept","label","value","period_end"]},"description":"Every field of the filing cover (Carátula), as filed."},"balance_sheet":{"anyOf":[{"type":"object","properties":{"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_current_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_current_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_equity":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_assets_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_assets_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_current_assets_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_liabilities_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_current_liabilities_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_equity_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"lines":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The line's key in the taxonomy, e.g. `efectivoEquivalentes`."},"group":{"type":"string","description":"Where the line sits, dotted: `activos.corrientes`. Empty for a top-level line."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The line's label as the statement prints it."},"current":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value for the fiscal year, in the filing's unit."},"previous":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value restated for the previous fiscal year."}},"required":["code","group","label","current","previous"]},"description":"Every line of the statement of financial position that carries a value, in statement order."}},"required":["total_assets","current_assets","non_current_assets","total_liabilities","current_liabilities","non_current_liabilities","total_equity","total_assets_previous","current_assets_previous","non_current_assets_previous","total_liabilities_previous","current_liabilities_previous","non_current_liabilities_previous","total_equity_previous","lines"]},{"type":"null"}]},"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"}]},"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"}]},"revenue_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_of_sales_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross_profit_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"operating_profit_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"profit_before_tax_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"income_tax_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"lines":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The line's key in the taxonomy, e.g. `efectivoEquivalentes`."},"group":{"type":"string","description":"Where the line sits, dotted: `activos.corrientes`. Empty for a top-level line."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The line's label as the statement prints it."},"current":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value for the fiscal year, in the filing's unit."},"previous":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value restated for the previous fiscal year."}},"required":["code","group","label","current","previous"]},"description":"Every line of the income statement that carries a value."}},"required":["revenue","cost_of_sales","gross_profit","operating_profit","profit_before_tax","income_tax","net_income","revenue_previous","cost_of_sales_previous","gross_profit_previous","operating_profit_previous","profit_before_tax_previous","income_tax_previous","net_income_previous","lines"]},{"type":"null"}]},"comprehensive_income":{"anyOf":[{"type":"object","properties":{"net_income":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Resultado integral total: net income plus other comprehensive income."},"net_income_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"lines":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The line's key in the taxonomy, e.g. `efectivoEquivalentes`."},"group":{"type":"string","description":"Where the line sits, dotted: `activos.corrientes`. Empty for a top-level line."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The line's label as the statement prints it."},"current":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value for the fiscal year, in the filing's unit."},"previous":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value restated for the previous fiscal year."}},"required":["code","group","label","current","previous"]},"description":"Every line of the statement of other comprehensive income that carries a value."}},"required":["net_income","total","net_income_previous","total_previous","lines"]},{"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"}]},"net_change_in_cash":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_at_start":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_at_end":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_cash_from_operating_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_cash_from_investing_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_cash_from_financing_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_change_in_cash_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_at_start_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash_at_end_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"lines":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The line's key in the taxonomy, e.g. `efectivoEquivalentes`."},"group":{"type":"string","description":"Where the line sits, dotted: `activos.corrientes`. Empty for a top-level line."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The line's label as the statement prints it."},"current":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value for the fiscal year, in the filing's unit."},"previous":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value restated for the previous fiscal year."}},"required":["code","group","label","current","previous"]},"description":"Every line of the cash flow statement that carries a value."}},"required":["net_cash_from_operating","net_cash_from_investing","net_cash_from_financing","net_change_in_cash","cash_at_start","cash_at_end","net_cash_from_operating_previous","net_cash_from_investing_previous","net_cash_from_financing_previous","net_change_in_cash_previous","cash_at_start_previous","cash_at_end_previous","lines"]},{"type":"null"}]},"indicators":{"anyOf":[{"type":"object","properties":{"leverage":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Apalancamiento: total liabilities over equity."},"total_debt_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Endeudamiento total: total liabilities over total assets."},"working_capital":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Capital de trabajo, in thousands of COP."},"working_capital_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Razón corriente."},"current_ratio_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"general_liquidity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Liquidez general."},"general_liquidity_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"operating_asset_turnover":{"anyOf":[{"type":"number"},{"type":"null"}]},"operating_asset_turnover_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"receivables_turnover":{"anyOf":[{"type":"number"},{"type":"null"}]},"receivables_turnover_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"inventory_turnover":{"anyOf":[{"type":"number"},{"type":"null"}]},"inventory_turnover_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"ebitda":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"In thousands of COP."},"ebitda_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"roa":{"anyOf":[{"type":"number"},{"type":"null"}]},"roa_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"roe":{"anyOf":[{"type":"number"},{"type":"null"}]},"roe_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"solvency":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total assets over total liabilities."},"solvency_previous":{"anyOf":[{"type":"number"},{"type":"null"}]},"assets_change":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Year-on-year variation, as a fraction."},"liabilities_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"equity_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"costs_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross_profit_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"operating_profit_change":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["leverage","total_debt_ratio","working_capital","working_capital_previous","current_ratio","current_ratio_previous","general_liquidity","general_liquidity_previous","operating_asset_turnover","operating_asset_turnover_previous","receivables_turnover","receivables_turnover_previous","inventory_turnover","inventory_turnover_previous","ebitda","ebitda_previous","roa","roa_previous","roe","roe_previous","solvency","solvency_previous","assets_change","liabilities_change","equity_change","revenue_change","costs_change","gross_profit_change","operating_profit_change"]},{"type":"null"}]},"equity_changes":{"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","description":"The dimension the member belongs to, e.g. `ContraparteAccionistasSocios`."},"member":{"type":"string","description":"The member: one shareholder, one asset class, one component of equity."},"row":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The row number for line-item members, else null."},"values":{"type":"array","items":{"type":"object","properties":{"concept":{"type":"string","description":"The concept as the taxonomy names it, e.g. `NombreAccionistaSocio`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The concept's label in the form, when the filing carries it."},"value":{"type":"string","description":"The value as filed. Numbers are filed as text, in the filing's unit."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the fact's period ends, when the form carries several periods."}},"required":["concept","label","value","period_end"]},"description":"Every fact filed for the member."}},"required":["dimension","member","row","values"]},"description":"The statement of changes in equity: one member per component of equity (issued capital, retained earnings, ...) and one for the total, each with the movements filed for it."},"equity_changes_totals":{"type":"array","items":{"type":"object","properties":{"concept":{"type":"string","description":"The concept as the taxonomy names it, e.g. `NombreAccionistaSocio`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The concept's label in the form, when the filing carries it."},"value":{"type":"string","description":"The value as filed. Numbers are filed as text, in the filing's unit."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the fact's period ends, when the form carries several periods."}},"required":["concept","label","value","period_end"]},"description":"The undimensioned lines of the statement of changes in equity."},"cash_breakdown":{"type":"array","items":{"type":"object","properties":{"concept":{"type":"string","description":"The concept as the taxonomy names it, e.g. `NombreAccionistaSocio`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The concept's label in the form, when the filing carries it."},"value":{"type":"string","description":"The value as filed. Numbers are filed as text, in the filing's unit."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the fact's period ends, when the form carries several periods."}},"required":["concept","label","value","period_end"]},"description":"The subclassification of cash and cash equivalents."}},"required":["id","document_number","name","fiscal_year","cutoff_date","filing_id","statement_type","niif_group","preferred","reporting_unit","business_purpose","society_type","company_kind","status","registration_number","incorporation_date","accounts_closing","has_statutory_auditor","audited","auditor_opinion","restated","dividends_approved","has_investments_in_others","cover","balance_sheet","income_statement","comprehensive_income","cash_flow","indicators","equity_changes","equity_changes_totals","cash_breakdown"]},{"type":"null"}],"description":"The filing's full financial statements."}},"required":["as_of","found","document_number","fiscal_years","filing"]},"SupersociedadesFilingStatementsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesFilingStatementsData"}}},"SupersociedadesOwnershipSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"number","description":"Matches across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number","description":"Results on this page."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The filing's identifier: entry point, NIT and corte, e.g. `pymes_individuales_800011651_2025-12-31`. The same filing carries the same id in every Supersociedades dataset."},"document_number":{"type":"string","description":"The company's NIT, numeric, no verification digit."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as filed."},"fiscal_year":{"type":"integer","description":"Fiscal year of the corte."},"cutoff_date":{"type":"string","description":"The corte, `yyyy-mm-dd`; December 31 for an annual filing."},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de radicado of the filing. Numbers grow with time, so the highest one held for a corte is what a refresh reads above."},"statement_type":{"anyOf":[{"type":"string","enum":["individual","separado","consolidado","combinado"]},{"type":"null"}],"description":"What the filing covers: `individual`, `separado`, `consolidado` or `combinado`."},"niif_group":{"anyOf":[{"type":"string","enum":["plenas","pymes"]},{"type":"null"}],"description":"Reporting framework: `plenas` (group 1) or `pymes` (group 2)."},"preferred":{"type":"boolean","description":"True for the one filing that stands for the company in that fiscal year: the individual books when filed, else the separado, else the consolidado, latest radicado first. Searches return preferred filings unless asked otherwise."},"shareholders":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name as declared."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document type as declared, e.g. \"CEDULA DE CIUDADANIA\", \"NIT\", \"CEDULA DE EXTRANJERIA\", \"PASAPORTE\"."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document number or NIT as declared."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country as declared, e.g. \"169 - COLOMBIA\"."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares or cuotas held, as declared."},"participation_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the capital, in percent, as declared."}},"required":["name","document_type","document_number","country","shares","participation_pct"]},"description":"Shareholders or partners as declared in the note, in the order filed."},"foreign_investors":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name as declared."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document type as declared, e.g. \"CEDULA DE CIUDADANIA\", \"NIT\", \"CEDULA DE EXTRANJERIA\", \"PASAPORTE\"."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document number or NIT as declared."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country as declared, e.g. \"169 - COLOMBIA\"."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares held, as declared."},"participation_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the capital, in percent, as declared."},"movement":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Movement of the stake during the fiscal year, as declared."}},"required":["name","document_type","document_number","country","shares","participation_pct","movement"]}},"subsidiaries":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subsidiary's NIT, as declared."},"place_of_business":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"non_controlling_interest_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the subsidiary's capital held by parties other than this company, in percent."},"non_controlling_voting_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the subsidiary's voting rights held by parties other than this company, in percent."}},"required":["name","document_number","place_of_business","country","non_controlling_interest_pct","non_controlling_voting_pct"]},"description":"Companies this company controls, as declared."},"associates":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The associate's NIT, as declared."},"place_of_business":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownership_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"This company's share of the associate's capital, in percent."},"voting_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"This company's share of the associate's voting rights, in percent."}},"required":["name","document_number","place_of_business","country","ownership_pct","voting_pct"]},"description":"Companies it holds a significant stake in, as declared."},"joint_ventures":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of the joint venture, as declared."},"place_of_business":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownership_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"voting_pct":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","document_number","place_of_business","country","ownership_pct","voting_pct"]}},"officers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"`legal_representative`, `first_alternate_legal_representative`, `second_alternate_legal_representative`, `accountant`, `statutory_auditor` (revisor fiscal), `alternate_statutory_auditor`, or the filing's own label."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_names":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_names":{"anyOf":[{"type":"string"},{"type":"null"}]},"professional_card":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tarjeta profesional, for the accountant and the revisor fiscal."},"chamber_registration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the appointment was registered at the chamber of commerce, yyyy-mm-dd."}},"required":["role","document_type","document_number","first_names","last_names","professional_card","chamber_registration_date"]},"description":"Legal representatives, accountant and revisor fiscal, as declared."},"investor_classes":{"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","description":"The dimension the member belongs to, e.g. `ContraparteAccionistasSocios`."},"member":{"type":"string","description":"The member: one shareholder, one asset class, one component of equity."},"row":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The row number for line-item members, else null."},"values":{"type":"array","items":{"type":"object","properties":{"concept":{"type":"string","description":"The concept as the taxonomy names it, e.g. `NombreAccionistaSocio`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The concept's label in the form, when the filing carries it."},"value":{"type":"string","description":"The value as filed. Numbers are filed as text, in the filing's unit."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the fact's period ends, when the form carries several periods."}},"required":["concept","label","value","period_end"]},"description":"Every fact filed for the member."}},"required":["dimension","member","row","values"]},"description":"Counts and nominal values by class of investor (natural persons, legal entities), as declared."},"shareholder_document_numbers":{"type":"array","items":{"type":"string"},"description":"Every identity document or NIT declared among the shareholders and foreign investors, for reverse lookup."},"officer_document_numbers":{"type":"array","items":{"type":"string"},"description":"Every identity document declared among the officers, for reverse lookup."},"related_document_numbers":{"type":"array","items":{"type":"string"},"description":"Every NIT declared among subsidiaries, associates and joint ventures, for reverse lookup."},"party_document_numbers":{"type":"array","items":{"type":"string"},"description":"The three lists above as one, for a lookup by document in any role."},"shareholder_count":{"type":"integer","description":"Shareholders declared in the note."}},"required":["id","document_number","name","fiscal_year","cutoff_date","filing_id","statement_type","niif_group","preferred","shareholders","foreign_investors","subsidiaries","associates","joint_ventures","officers","investor_classes","shareholder_document_numbers","officer_document_numbers","related_document_numbers","party_document_numbers","shareholder_count"]},"description":"Newest filing first."}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","results"]},"SupersociedadesOwnershipSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesOwnershipSearchData"}}},"SupersociedadesFilingOwnershipData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"False when no filing matches the NIT, year and statement type asked."},"document_number":{"type":"string"},"fiscal_years":{"type":"array","items":{"type":"number"},"description":"Every fiscal year the company has a filing for in this dataset, newest first."},"filing":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The filing's identifier: entry point, NIT and corte, e.g. `pymes_individuales_800011651_2025-12-31`. The same filing carries the same id in every Supersociedades dataset."},"document_number":{"type":"string","description":"The company's NIT, numeric, no verification digit."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as filed."},"fiscal_year":{"type":"integer","description":"Fiscal year of the corte."},"cutoff_date":{"type":"string","description":"The corte, `yyyy-mm-dd`; December 31 for an annual filing."},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de radicado of the filing. Numbers grow with time, so the highest one held for a corte is what a refresh reads above."},"statement_type":{"anyOf":[{"type":"string","enum":["individual","separado","consolidado","combinado"]},{"type":"null"}],"description":"What the filing covers: `individual`, `separado`, `consolidado` or `combinado`."},"niif_group":{"anyOf":[{"type":"string","enum":["plenas","pymes"]},{"type":"null"}],"description":"Reporting framework: `plenas` (group 1) or `pymes` (group 2)."},"preferred":{"type":"boolean","description":"True for the one filing that stands for the company in that fiscal year: the individual books when filed, else the separado, else the consolidado, latest radicado first. Searches return preferred filings unless asked otherwise."},"shareholders":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name as declared."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document type as declared, e.g. \"CEDULA DE CIUDADANIA\", \"NIT\", \"CEDULA DE EXTRANJERIA\", \"PASAPORTE\"."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document number or NIT as declared."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country as declared, e.g. \"169 - COLOMBIA\"."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares or cuotas held, as declared."},"participation_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the capital, in percent, as declared."}},"required":["name","document_type","document_number","country","shares","participation_pct"]},"description":"Shareholders or partners as declared in the note, in the order filed."},"foreign_investors":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name as declared."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document type as declared, e.g. \"CEDULA DE CIUDADANIA\", \"NIT\", \"CEDULA DE EXTRANJERIA\", \"PASAPORTE\"."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identity document number or NIT as declared."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country as declared, e.g. \"169 - COLOMBIA\"."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares held, as declared."},"participation_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the capital, in percent, as declared."},"movement":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Movement of the stake during the fiscal year, as declared."}},"required":["name","document_type","document_number","country","shares","participation_pct","movement"]}},"subsidiaries":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subsidiary's NIT, as declared."},"place_of_business":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"non_controlling_interest_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the subsidiary's capital held by parties other than this company, in percent."},"non_controlling_voting_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the subsidiary's voting rights held by parties other than this company, in percent."}},"required":["name","document_number","place_of_business","country","non_controlling_interest_pct","non_controlling_voting_pct"]},"description":"Companies this company controls, as declared."},"associates":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The associate's NIT, as declared."},"place_of_business":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownership_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"This company's share of the associate's capital, in percent."},"voting_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"This company's share of the associate's voting rights, in percent."}},"required":["name","document_number","place_of_business","country","ownership_pct","voting_pct"]},"description":"Companies it holds a significant stake in, as declared."},"joint_ventures":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT of the joint venture, as declared."},"place_of_business":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownership_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"voting_pct":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","document_number","place_of_business","country","ownership_pct","voting_pct"]}},"officers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"`legal_representative`, `first_alternate_legal_representative`, `second_alternate_legal_representative`, `accountant`, `statutory_auditor` (revisor fiscal), `alternate_statutory_auditor`, or the filing's own label."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_names":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_names":{"anyOf":[{"type":"string"},{"type":"null"}]},"professional_card":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tarjeta profesional, for the accountant and the revisor fiscal."},"chamber_registration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the appointment was registered at the chamber of commerce, yyyy-mm-dd."}},"required":["role","document_type","document_number","first_names","last_names","professional_card","chamber_registration_date"]},"description":"Legal representatives, accountant and revisor fiscal, as declared."},"investor_classes":{"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","description":"The dimension the member belongs to, e.g. `ContraparteAccionistasSocios`."},"member":{"type":"string","description":"The member: one shareholder, one asset class, one component of equity."},"row":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The row number for line-item members, else null."},"values":{"type":"array","items":{"type":"object","properties":{"concept":{"type":"string","description":"The concept as the taxonomy names it, e.g. `NombreAccionistaSocio`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The concept's label in the form, when the filing carries it."},"value":{"type":"string","description":"The value as filed. Numbers are filed as text, in the filing's unit."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the fact's period ends, when the form carries several periods."}},"required":["concept","label","value","period_end"]},"description":"Every fact filed for the member."}},"required":["dimension","member","row","values"]},"description":"Counts and nominal values by class of investor (natural persons, legal entities), as declared."},"shareholder_document_numbers":{"type":"array","items":{"type":"string"},"description":"Every identity document or NIT declared among the shareholders and foreign investors, for reverse lookup."},"officer_document_numbers":{"type":"array","items":{"type":"string"},"description":"Every identity document declared among the officers, for reverse lookup."},"related_document_numbers":{"type":"array","items":{"type":"string"},"description":"Every NIT declared among subsidiaries, associates and joint ventures, for reverse lookup."},"party_document_numbers":{"type":"array","items":{"type":"string"},"description":"The three lists above as one, for a lookup by document in any role."},"shareholder_count":{"type":"integer","description":"Shareholders declared in the note."}},"required":["id","document_number","name","fiscal_year","cutoff_date","filing_id","statement_type","niif_group","preferred","shareholders","foreign_investors","subsidiaries","associates","joint_ventures","officers","investor_classes","shareholder_document_numbers","officer_document_numbers","related_document_numbers","party_document_numbers","shareholder_count"]},{"type":"null"}],"description":"The parties the filing declares."}},"required":["as_of","found","document_number","fiscal_years","filing"]},"SupersociedadesFilingOwnershipResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesFilingOwnershipData"}}},"SupersociedadesFilingDisclosuresData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"False when no filing matches the NIT, year and statement type asked."},"document_number":{"type":"string"},"fiscal_years":{"type":"array","items":{"type":"number"},"description":"Every fiscal year the company has a filing for in this dataset, newest first."},"filing":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The filing's identifier: entry point, NIT and corte, e.g. `pymes_individuales_800011651_2025-12-31`. The same filing carries the same id in every Supersociedades dataset."},"document_number":{"type":"string","description":"The company's NIT, numeric, no verification digit."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as filed."},"fiscal_year":{"type":"integer","description":"Fiscal year of the corte."},"cutoff_date":{"type":"string","description":"The corte, `yyyy-mm-dd`; December 31 for an annual filing."},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de radicado of the filing. Numbers grow with time, so the highest one held for a corte is what a refresh reads above."},"statement_type":{"anyOf":[{"type":"string","enum":["individual","separado","consolidado","combinado"]},{"type":"null"}],"description":"What the filing covers: `individual`, `separado`, `consolidado` or `combinado`."},"niif_group":{"anyOf":[{"type":"string","enum":["plenas","pymes"]},{"type":"null"}],"description":"Reporting framework: `plenas` (group 1) or `pymes` (group 2)."},"preferred":{"type":"boolean","description":"True for the one filing that stands for the company in that fiscal year: the individual books when filed, else the separado, else the consolidado, latest radicado first. Searches return preferred filings unless asked otherwise."},"notes":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"Which note this is, as Croma names it, e.g. `property_plant_equipment`."},"form":{"type":"string","description":"The form's title as the taxonomy prints it."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The form's code in the taxonomy, e.g. `801900`."},"scalars":{"type":"array","items":{"type":"object","properties":{"concept":{"type":"string","description":"The concept as the taxonomy names it, e.g. `NombreAccionistaSocio`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The concept's label in the form, when the filing carries it."},"value":{"type":"string","description":"The value as filed. Numbers are filed as text, in the filing's unit."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the fact's period ends, when the form carries several periods."}},"required":["concept","label","value","period_end"]},"description":"Facts filed without a dimension member: totals, yes/no answers, free text."},"members":{"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","description":"The dimension the member belongs to, e.g. `ContraparteAccionistasSocios`."},"member":{"type":"string","description":"The member: one shareholder, one asset class, one component of equity."},"row":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The row number for line-item members, else null."},"values":{"type":"array","items":{"type":"object","properties":{"concept":{"type":"string","description":"The concept as the taxonomy names it, e.g. `NombreAccionistaSocio`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The concept's label in the form, when the filing carries it."},"value":{"type":"string","description":"The value as filed. Numbers are filed as text, in the filing's unit."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the fact's period ends, when the form carries several periods."}},"required":["concept","label","value","period_end"]},"description":"Every fact filed for the member."}},"required":["dimension","member","row","values"]},"description":"Facts filed per member of the form's dimension."}},"required":["kind","form","code","scalars","members"]},"description":"Every disclosure note the filing carries, whole: property, plant and equipment, intangibles, leases, payables, receivables, revenue by activity, expenses, provisions, impairment, biological assets, investment property, the AML questionnaire."},"note_kinds":{"type":"array","items":{"type":"string"},"description":"Which notes the filing carries, by `kind`."},"aml_precious_metals":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Circular Básica Jurídica cap. X: the company habitually traded precious metals or stones during the year."},"aml_virtual_asset_contributions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Cap. X: it received contributions in virtual assets of 100 SMLMV or more."},"aml_virtual_asset_operations":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Cap. X: it carried out operations with virtual assets of 100 SMLMV or more on behalf of others."},"aml_international_transactions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Cap. XIII: it carried out international transactions of 100 SMLMV or more."},"aml_state_contracts":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Cap. XIII: it signed contracts with state entities of 500 SMLMV or more."},"consolidated_summary":{"type":"array","items":{"type":"object","properties":{"concept":{"type":"string","description":"The concept as the taxonomy names it, e.g. `NombreAccionistaSocio`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The concept's label in the form, when the filing carries it."},"value":{"type":"string","description":"The value as filed. Numbers are filed as text, in the filing's unit."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the fact's period ends, when the form carries several periods."}},"required":["concept","label","value","period_end"]},"description":"For a parent that files a consolidated summary (vista consolidada), every figure of it, by dotted path."}},"required":["id","document_number","name","fiscal_year","cutoff_date","filing_id","statement_type","niif_group","preferred","notes","note_kinds","aml_precious_metals","aml_virtual_asset_contributions","aml_virtual_asset_operations","aml_international_transactions","aml_state_contracts","consolidated_summary"]},{"type":"null"}],"description":"The filing's disclosure notes."}},"required":["as_of","found","document_number","fiscal_years","filing"]},"SupersociedadesFilingDisclosuresResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesFilingDisclosuresData"}}},"SupersociedadesInsolvencyProcessesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"number","description":"Matches across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number","description":"Results on this page."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"NIT, admission date and process type, e.g. `900666117:2018-07-09:REORGANIZACION`."},"document_number":{"type":"string","description":"The company's NIT, numeric, no verification digit."},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as filed in the latest filing that reports the process."},"process":{"type":"string","description":"The process type as the Superintendencia names it: `REORGANIZACION`, `LIQUIDACION JUDICIAL`, `ACUERDOS DE REESTRUCTURACION`, `CONCORDATOS`, `LIQUIDACION OBLIGATORIA CREDITOS`, `VALIDACION`."},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stage as reported, e.g. `CELEBRADO`, `FIRMADO`, `AUTORIZADO`; null when the filing leaves it blank."},"origin":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the process began, as reported, e.g. `POR SOLICITUD DEL DEUDOR`, `DE OFICIO`."},"admission_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the process was admitted."},"closing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the process closed; null while open."},"active":{"type":"boolean","description":"True while the latest filing reports no closing date."},"reported_at":{"type":"string","description":"The corte of the latest filing that reports the process."},"reported_in_year":{"type":"integer","description":"Fiscal year of that filing."},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de radicado of that filing."}},"required":["id","document_number","company_name","process","stage","origin","admission_date","closing_date","active","reported_at","reported_in_year","filing_id"]},"description":"Most recently admitted first."}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","results"]},"SupersociedadesInsolvencyProcessesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesInsolvencyProcessesSearchData"}}},"SupersociedadesLargestCompaniesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"number","description":"Matches across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number","description":"Results on this page."},"fiscal_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The fiscal year searched: the one asked, or the latest available when `0` was sent."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Fiscal year and NIT, e.g. `2025-899999068`."},"document_number":{"type":"string","description":"NIT, numeric, no verification digit."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as published."},"supervisor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which superintendencia supervises the company: `SUPERSOCIEDADES`, `SUPERFINANCIERA`, `SUPERSALUD`, `SUPERSERVICIOS`, `SUPERTRANSPORTE`, `SUPERVIGILANCIA`."},"region":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Department of domicile, as published."},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"ciiu_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Primary CIIU code, four digits."},"ciiu_section":{"anyOf":[{"type":"string"},{"type":"null"}]},"ciiu_division":{"anyOf":[{"type":"string"},{"type":"null"}]},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The CIIU division's label."},"macrosector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As published, uppercase with accents removed: `AGROPECUARIO`, `MINERO`, `MANUFACTURA`, `CONSTRUCCION`, `COMERCIO`, `SERVICIOS`."},"fiscal_year":{"type":"integer"},"rank":{"type":"integer","description":"Position that year by revenue, 1 for the largest."},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Ingresos operacionales, in billions (10^12) of COP as published, two decimals."},"profit":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Ganancia (pérdida), in billions of COP."},"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"In billions of COP."},"total_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"In billions of COP."},"total_equity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"In billions of COP."}},"required":["id","document_number","name","supervisor","region","department","city","ciiu_code","ciiu_section","ciiu_division","sector","macrosector","fiscal_year","rank","revenue","profit","total_assets","total_liabilities","total_equity"]},"description":"By rank, largest revenue first."}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","fiscal_year","results"]},"SupersociedadesLargestCompaniesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesLargestCompaniesSearchData"}}},"SupersociedadesSupervisedEntitiesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"number","description":"Matches across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number","description":"Results on this page."},"fiscal_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The corte year searched: the one asked, or the latest available when `0` was sent."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Corte and NIT, e.g. `2025-12-31-890200122`."},"document_number":{"type":"string","description":"NIT, numeric, no verification digit."},"check_digit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Dígito de verificación, as published."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social as published."},"supervision_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`INSPECCION`, `VIGILANCIA`, `CONTROL`, `NUEVA`, or `CAMARA COMERCIO INSPECCION-VIGILANCIA-CONTROL`; null when the row is misaligned at the source."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Judicial notification address, as published."},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Judicial notification email, as published."},"cutoff_date":{"type":"string","description":"The corte of the snapshot the row belongs to."},"fiscal_year":{"type":"integer"},"misaligned":{"type":"boolean","description":"True when the source's row has its columns shifted beyond repair (no supervision status in either the status or the address column); the fields are then kept as published and `supervision_status` is null."}},"required":["id","document_number","check_digit","name","supervision_status","address","department","city","email","cutoff_date","fiscal_year","misaligned"]},"description":"By name."}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","fiscal_year","results"]},"SupersociedadesSupervisedEntitiesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesSupervisedEntitiesSearchData"}}},"SupersociedadesBarandaPublicationsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"integer","description":"Matching rows, or the count cap when `total_is_exact` is false."},"total_is_exact":{"type":"boolean","description":"False when `total` is the count cap rather than the exact number of matches."},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer","description":"A floor when `total_is_exact` is false."},"count":{"type":"integer","description":"Rows in this page."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<kind>:<dependency>:<radicado>`. A radicado published under two lists is two rows."},"kind":{"type":"string","enum":["estado","traslado","aviso","sentencia","auto","edicto","publicidad"],"description":"Which list published it: `estado`, `traslado`, `aviso`, `sentencia`, `auto`, `edicto` or `publicidad`."},"dependency":{"type":"string","description":"The dependencia code as the source keys its lists, e.g. `apoyoJudicialR`."},"dependency_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The dependencia's label, e.g. `APOYO JUDICIAL - REORGANIZACIÓN Y CONCORDATO`."},"filing_id":{"type":"string","description":"Número de radicado of the publication, `yyyy-01-nnnnnn`."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expediente (the process file) the publication belongs to, when the source links one."},"previous_filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The radicado this one answers or continues, when any."},"filed_date":{"type":"string","description":"Date of the publication, `yyyy-mm-dd`."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date and time of the publication in Bogotá time, when the source stamps one."},"term_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Término in days, as the source prints it."},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Folios."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite as the source names it."},"procedure_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The trámite's numeric code at the source."},"process":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Proceso as the source names it, e.g. `APOYO JUDICIAL`, `NOTIFICACIÓN`, `REORGANIZACIÓN EMPRESARIAL Y CONCORDATOS`."},"sequence":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of an estado or traslado, e.g. `415-000374`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado of the radicado as the source prints it."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Asunto."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document type as the source prints it."},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social of the company or person the row is about, as the source prints it; the Superintendencia itself on its own estados and traslados."},"company_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or cédula of the company or person the publication is about, digits only."},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own viewer link for the radicado's files."},"digitized":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the source has the radicado's files digitized, as it prints it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the radicado's main file; null when the source serves none."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the source lists it, e.g. `2026-01-706561.PDF`."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the file; null when the source lists the file but does not serve it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own viewer link for the radicado."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."}},"required":["name","document_url","source_document_url","bytes"]},"description":"Every file the source lists for the radicado, with our copy of each."}},"required":["id","kind","dependency","dependency_name","filing_id","file_number","previous_filing_id","filed_date","filed_at","term_days","pages","procedure","procedure_code","process","sequence","status","subject","description","company_name","company_document_number","city","department","country","source_document_url","digitized","document_url","documents"]}}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","results"]},"SupersociedadesBarandaPublicationsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesBarandaPublicationsSearchData"}}},"SupersociedadesBarandaPublicationData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"filing_id":{"type":"string","description":"Echoes the request."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<kind>:<dependency>:<radicado>`. A radicado published under two lists is two rows."},"kind":{"type":"string","enum":["estado","traslado","aviso","sentencia","auto","edicto","publicidad"],"description":"Which list published it: `estado`, `traslado`, `aviso`, `sentencia`, `auto`, `edicto` or `publicidad`."},"dependency":{"type":"string","description":"The dependencia code as the source keys its lists, e.g. `apoyoJudicialR`."},"dependency_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The dependencia's label, e.g. `APOYO JUDICIAL - REORGANIZACIÓN Y CONCORDATO`."},"filing_id":{"type":"string","description":"Número de radicado of the publication, `yyyy-01-nnnnnn`."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expediente (the process file) the publication belongs to, when the source links one."},"previous_filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The radicado this one answers or continues, when any."},"filed_date":{"type":"string","description":"Date of the publication, `yyyy-mm-dd`."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date and time of the publication in Bogotá time, when the source stamps one."},"term_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Término in days, as the source prints it."},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Folios."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite as the source names it."},"procedure_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The trámite's numeric code at the source."},"process":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Proceso as the source names it, e.g. `APOYO JUDICIAL`, `NOTIFICACIÓN`, `REORGANIZACIÓN EMPRESARIAL Y CONCORDATOS`."},"sequence":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of an estado or traslado, e.g. `415-000374`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado of the radicado as the source prints it."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Asunto."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document type as the source prints it."},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social of the company or person the row is about, as the source prints it; the Superintendencia itself on its own estados and traslados."},"company_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or cédula of the company or person the publication is about, digits only."},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own viewer link for the radicado's files."},"digitized":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the source has the radicado's files digitized, as it prints it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the radicado's main file; null when the source serves none."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the source lists it, e.g. `2026-01-706561.PDF`."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the file; null when the source lists the file but does not serve it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own viewer link for the radicado."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."}},"required":["name","document_url","source_document_url","bytes"]},"description":"Every file the source lists for the radicado, with our copy of each."}},"required":["id","kind","dependency","dependency_name","filing_id","file_number","previous_filing_id","filed_date","filed_at","term_days","pages","procedure","procedure_code","process","sequence","status","subject","description","company_name","company_document_number","city","department","country","source_document_url","digitized","document_url","documents"]},"description":"Every list the radicado was published under."}},"required":["as_of","found","filing_id","results"]},"SupersociedadesBarandaPublicationResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesBarandaPublicationData"}}},"SupersociedadesBarandaDecisionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"integer","description":"Matching rows, or the count cap when `total_is_exact` is false."},"total_is_exact":{"type":"boolean","description":"False when `total` is the count cap rather than the exact number of matches."},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer","description":"A floor when `total_is_exact` is false."},"count":{"type":"integer","description":"Rows in this page."},"results":{"type":"array","items":{"type":"object","properties":{"filing_id":{"type":"string","description":"Número de radicado of the auto, `yyyy-NN-nnnnnn` (`NN` is the office: `01` Bogotá, `02` Medellín, `03` Cali, `04` Barranquilla, `05` Manizales, `06` Bucaramanga, `07` Cartagena)."},"decided_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the auto as the estado prints it, `yyyy-mm-dd`."},"decided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date and time the auto was signed, in Bogotá time, when the auto carries the filing stamp (most since mid 2024; never on procedimientos mercantiles)."},"notified_date":{"type":"string","description":"Date of the estado that notified the auto, `yyyy-mm-dd`. Terms run from the day after."},"estado_filing_id":{"type":"string","description":"Radicado of the estado that notified the auto; the `publication` endpoint returns it."},"estado_sequence":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of that estado, e.g. `415-000374`."},"estado_entry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The estado's line for this auto, as printed: for procedimientos mercantiles the case number, the decision, the plaintiff and the defendant; for insolvency, the company and the trámite."},"dependency":{"type":"string","enum":["apoyoJudicialPM","apoyoJudicialR","apoyoJudicialL","apoyoJudicialI","barranquillaNew","bucaramangaNew","caliNew","cartagenaNew","manizalesNew","medellinNew"],"description":"The dependencia that notified it: `apoyoJudicialPM` (procedimientos mercantiles, the Superintendencia acting as a commercial court), `apoyoJudicialR` (reorganización), `apoyoJudicialL` (liquidación judicial), `apoyoJudicialI` (intervención), or an intendencia regional (`barranquillaNew`, `bucaramangaNew`, `caliNew`, `cartagenaNew`, `manizalesNew`, `medellinNew`)."},"dependency_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The dependencia's label, e.g. `APOYO JUDICIAL - PROCEDIMIENTOS MERCANTILES`."},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company or person the process is about (sujeto del proceso), as the auto prints it; null on procedimientos mercantiles, which name `parties` instead."},"company_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or cédula of that company or person, digits only, when the auto prints it."},"parties":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Procedimientos mercantiles: the parties as the auto prints them, `<plaintiff> contra <defendant>`."},"process":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The process as the auto names it, e.g. `Liquidación judicial`, `Reorganización empresarial`, `Proceso verbal sumario`."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Asunto: what the auto is about, in the Superintendencia's words, e.g. `Resuelve solicitud de nulidad`."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expediente number as the auto prints it."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de proceso as the auto prints it, e.g. `2024-800-00267` (procedimientos mercantiles) or `2024-INS-3404`."},"officer_role":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court officer's role as the auto prints it: liquidador, promotor, agente interventor, auxiliar de la justicia."},"officer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court officer's name."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite of the auto at the source, from its filing stamp."},"procedure_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The trámite's numeric code at the source."},"office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The group that issued the auto, from its filing stamp, e.g. `444 - GRUPO DE PROCESOS DE LIQUIDACION A`."},"sequence":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of the auto, from its filing stamp, e.g. `444-054899`."},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Pages of the auto."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the auto orders, cut to its first 1,500 characters; the `decision` endpoint returns it whole, with the full text."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the auto's PDF; null while the source has not digitized it."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the source lists it, e.g. `2026-01-706561.PDF`."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the file; null when the source lists the file but does not serve it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own viewer link for the radicado."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."}},"required":["name","document_url","source_document_url","bytes"]},"description":"Every file the source lists for the auto (the auto and any annex), with our copy of each."}},"required":["filing_id","decided_date","decided_at","notified_date","estado_filing_id","estado_sequence","estado_entry","dependency","dependency_name","company_name","company_document_number","parties","process","subject","file_number","case_number","officer_role","officer","procedure","procedure_code","office","sequence","pages","decision","document_url","documents"]}}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","results"]},"SupersociedadesBarandaDecisionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesBarandaDecisionsSearchData"}}},"SupersociedadesBarandaDecisionData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean","description":"False when the copy holds no auto under the radicado."},"filing_id":{"type":"string","description":"Echoes the request."},"decision":{"anyOf":[{"type":"object","properties":{"filing_id":{"type":"string","description":"Número de radicado of the auto, `yyyy-NN-nnnnnn` (`NN` is the office: `01` Bogotá, `02` Medellín, `03` Cali, `04` Barranquilla, `05` Manizales, `06` Bucaramanga, `07` Cartagena)."},"decided_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the auto as the estado prints it, `yyyy-mm-dd`."},"decided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date and time the auto was signed, in Bogotá time, when the auto carries the filing stamp (most since mid 2024; never on procedimientos mercantiles)."},"notified_date":{"type":"string","description":"Date of the estado that notified the auto, `yyyy-mm-dd`. Terms run from the day after."},"estado_filing_id":{"type":"string","description":"Radicado of the estado that notified the auto; the `publication` endpoint returns it."},"estado_sequence":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of that estado, e.g. `415-000374`."},"estado_entry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The estado's line for this auto, as printed: for procedimientos mercantiles the case number, the decision, the plaintiff and the defendant; for insolvency, the company and the trámite."},"dependency":{"type":"string","enum":["apoyoJudicialPM","apoyoJudicialR","apoyoJudicialL","apoyoJudicialI","barranquillaNew","bucaramangaNew","caliNew","cartagenaNew","manizalesNew","medellinNew"],"description":"The dependencia that notified it: `apoyoJudicialPM` (procedimientos mercantiles, the Superintendencia acting as a commercial court), `apoyoJudicialR` (reorganización), `apoyoJudicialL` (liquidación judicial), `apoyoJudicialI` (intervención), or an intendencia regional (`barranquillaNew`, `bucaramangaNew`, `caliNew`, `cartagenaNew`, `manizalesNew`, `medellinNew`)."},"dependency_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The dependencia's label, e.g. `APOYO JUDICIAL - PROCEDIMIENTOS MERCANTILES`."},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company or person the process is about (sujeto del proceso), as the auto prints it; null on procedimientos mercantiles, which name `parties` instead."},"company_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or cédula of that company or person, digits only, when the auto prints it."},"parties":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Procedimientos mercantiles: the parties as the auto prints them, `<plaintiff> contra <defendant>`."},"process":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The process as the auto names it, e.g. `Liquidación judicial`, `Reorganización empresarial`, `Proceso verbal sumario`."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Asunto: what the auto is about, in the Superintendencia's words, e.g. `Resuelve solicitud de nulidad`."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expediente number as the auto prints it."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de proceso as the auto prints it, e.g. `2024-800-00267` (procedimientos mercantiles) or `2024-INS-3404`."},"officer_role":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court officer's role as the auto prints it: liquidador, promotor, agente interventor, auxiliar de la justicia."},"officer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court officer's name."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite of the auto at the source, from its filing stamp."},"procedure_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The trámite's numeric code at the source."},"office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The group that issued the auto, from its filing stamp, e.g. `444 - GRUPO DE PROCESOS DE LIQUIDACION A`."},"sequence":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of the auto, from its filing stamp, e.g. `444-054899`."},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Pages of the auto."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the auto orders: the part after RESUELVE, up to the signature."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the auto's PDF; null while the source has not digitized it."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the source lists it, e.g. `2026-01-706561.PDF`."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the file; null when the source lists the file but does not serve it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own viewer link for the radicado."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."}},"required":["name","document_url","source_document_url","bytes"]},"description":"Every file the source lists for the auto (the auto and any annex), with our copy of each."},"text":{"type":"string","description":"The auto's full text: antecedentes, the Superintendencia's reasoning and the decision."},"text_truncated":{"type":"boolean","description":"True when `text` was cut at 400,000 characters."}},"required":["filing_id","decided_date","decided_at","notified_date","estado_filing_id","estado_sequence","estado_entry","dependency","dependency_name","company_name","company_document_number","parties","process","subject","file_number","case_number","officer_role","officer","procedure","procedure_code","office","sequence","pages","decision","document_url","documents","text","text_truncated"]},{"type":"null"}],"description":"The auto with its full text; null when not found."}},"required":["as_of","found","filing_id","decision"]},"SupersociedadesBarandaDecisionResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesBarandaDecisionData"}}},"SupersociedadesBarandaCompanyFileData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when the source holds no company under the number."},"document_number":{"type":"string","description":"Echoes the request."},"company":{"anyOf":[{"type":"object","properties":{"document_number":{"type":"string","description":"NIT or cédula, digits only."},"check_digit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The NIT's verification digit."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's expediente number at the Superintendencia."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"short_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sigla."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Matrícula mercantil."},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`."},"incorporation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`."},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fecha de vencimiento, `yyyy-mm-dd`, when the company has one."},"company_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tipo de sociedad as the source prints it, e.g. `S. A. S.`, `ANONIMA`."},"supervision_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's standing before the Superintendencia: `INSPECCION`, `VIGILANCIA`, `CONTROL`, ..."},"supervision_status_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"situation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Situación as the source prints it, e.g. `ACTIVA`, `LIQUIDACIÓN VOLUNTARIA`, `REORGANIZACIÓN`."},"situation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Etapa as the source prints it."},"stage_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"cause":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal cause of the supervision, as the source prints it."},"ciiu_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"activity":{"anyOf":[{"type":"string"},{"type":"null"}]},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Objeto social as the source prints it."},"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["document_number","check_digit","file_number","name","short_name","registration_number","registration_date","incorporation_date","expiry_date","company_type","supervision_status","supervision_status_date","situation","situation_date","stage","stage_date","cause","ciiu_code","activity","purpose","address","department","city"]},{"type":"null"}]},"officers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"Role as the source prints it, e.g. `REPRESENTANTE LEGAL`, `REVISOR FISCAL`, `CONTADOR`."},"name":{"type":"string"}},"required":["role","name"]},"description":"Legal representatives, auditors and accountants the source lists."},"decisions":{"type":"object","properties":{"total":{"type":"integer","description":"Rows the source holds for the company."},"page":{"type":"integer"},"per_page":{"type":"integer","description":"Always 10, the source's page."},"results":{"type":"array","items":{"type":"object","properties":{"filing_id":{"type":"string","description":"Número de radicado, `yyyy-01-nnnnnn`."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expediente (the process file) the row belongs to, when the source links one."},"previous_filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The radicado this one answers or continues, when any."},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the radicado, `yyyy-mm-dd`."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date and time of the radicado in Bogotá time, when the source stamps one."},"term_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Término in days, as the source prints it."},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Folios."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite as the source names it."},"procedure_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The trámite's numeric code at the source."},"process":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Proceso as the source names it, e.g. `APOYO JUDICIAL`, `NOTIFICACIÓN`, `REORGANIZACIÓN EMPRESARIAL Y CONCORDATOS`."},"sequence":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of an estado or traslado, e.g. `415-000374`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado of the radicado as the source prints it."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Asunto."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document type as the source prints it."},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social of the company or person the row is about, as the source prints it; the Superintendencia itself on its own estados and traslados."},"company_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or cédula of that company or person, digits only."},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own viewer link for the radicado's files."}},"required":["filing_id","file_number","previous_filing_id","filed_date","filed_at","term_days","pages","procedure","procedure_code","process","sequence","status","subject","description","company_name","company_document_number","city","department","country","source_document_url"]}}},"required":["total","page","per_page","results"],"description":"Providencias: the decisions the Superintendencia issued in the company's processes, newest first."},"filings":{"type":"object","properties":{"total":{"type":"integer","description":"Rows the source holds for the company."},"page":{"type":"integer"},"per_page":{"type":"integer","description":"Always 10, the source's page."},"results":{"type":"array","items":{"type":"object","properties":{"filing_id":{"type":"string","description":"Número de radicado, `yyyy-01-nnnnnn`."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expediente (the process file) the row belongs to, when the source links one."},"previous_filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The radicado this one answers or continues, when any."},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the radicado, `yyyy-mm-dd`."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date and time of the radicado in Bogotá time, when the source stamps one."},"term_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Término in days, as the source prints it."},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Folios."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite as the source names it."},"procedure_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The trámite's numeric code at the source."},"process":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Proceso as the source names it, e.g. `APOYO JUDICIAL`, `NOTIFICACIÓN`, `REORGANIZACIÓN EMPRESARIAL Y CONCORDATOS`."},"sequence":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of an estado or traslado, e.g. `415-000374`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado of the radicado as the source prints it."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Asunto."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document type as the source prints it."},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social of the company or person the row is about, as the source prints it; the Superintendencia itself on its own estados and traslados."},"company_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or cédula of that company or person, digits only."},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own viewer link for the radicado's files."}},"required":["filing_id","file_number","previous_filing_id","filed_date","filed_at","term_days","pages","procedure","procedure_code","process","sequence","status","subject","description","company_name","company_document_number","city","department","country","source_document_url"]}}},"required":["total","page","per_page","results"],"description":"Entradas: what was filed into the company's processes, newest first."},"checked_at":{"type":"string","description":"When the source was read, ISO 8601."}},"required":["found","document_number","company","officers","decisions","filings","checked_at"]},"SupersociedadesBarandaCompanyFileResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesBarandaCompanyFileData"}}},"SupersociedadesBarandaCompanySearchData":{"type":"object","properties":{"query":{"type":"string","description":"Echoes the request."},"total":{"type":"integer","description":"Companies the source matched."},"page":{"type":"integer"},"per_page":{"type":"integer"},"count":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"document_number":{"type":"string","description":"NIT or cédula, digits only."},"check_digit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The NIT's verification digit."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's expediente number at the Superintendencia."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"short_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sigla."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Matrícula mercantil."},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`."},"incorporation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`."},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fecha de vencimiento, `yyyy-mm-dd`, when the company has one."},"company_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tipo de sociedad as the source prints it, e.g. `S. A. S.`, `ANONIMA`."},"supervision_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's standing before the Superintendencia: `INSPECCION`, `VIGILANCIA`, `CONTROL`, ..."},"supervision_status_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"situation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Situación as the source prints it, e.g. `ACTIVA`, `LIQUIDACIÓN VOLUNTARIA`, `REORGANIZACIÓN`."},"situation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Etapa as the source prints it."},"stage_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"cause":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal cause of the supervision, as the source prints it."},"ciiu_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"activity":{"anyOf":[{"type":"string"},{"type":"null"}]},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Objeto social as the source prints it."},"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["document_number","check_digit","file_number","name","short_name","registration_number","registration_date","incorporation_date","expiry_date","company_type","supervision_status","supervision_status_date","situation","situation_date","stage","stage_date","cause","ciiu_code","activity","purpose","address","department","city"]}},"checked_at":{"type":"string","description":"When the source was read, ISO 8601."}},"required":["query","total","page","per_page","count","results","checked_at"]},"SupersociedadesBarandaCompanySearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesBarandaCompanySearchData"}}},"SupersociedadesBarandaFilingData":{"type":"object","properties":{"found":{"type":"boolean"},"filing_id":{"type":"string","description":"Echoes the request."},"filing":{"anyOf":[{"type":"object","properties":{"filing_id":{"type":"string","description":"Número de radicado, `yyyy-01-nnnnnn`."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expediente (the process file) the row belongs to, when the source links one."},"previous_filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The radicado this one answers or continues, when any."},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the radicado, `yyyy-mm-dd`."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date and time of the radicado in Bogotá time, when the source stamps one."},"term_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Término in days, as the source prints it."},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Folios."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite as the source names it."},"procedure_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The trámite's numeric code at the source."},"process":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Proceso as the source names it, e.g. `APOYO JUDICIAL`, `NOTIFICACIÓN`, `REORGANIZACIÓN EMPRESARIAL Y CONCORDATOS`."},"sequence":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of an estado or traslado, e.g. `415-000374`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado of the radicado as the source prints it."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Asunto."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document type as the source prints it."},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social of the company or person the row is about, as the source prints it; the Superintendencia itself on its own estados and traslados."},"company_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or cédula of that company or person, digits only."},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own viewer link for the radicado's files."}},"required":["filing_id","file_number","previous_filing_id","filed_date","filed_at","term_days","pages","procedure","procedure_code","process","sequence","status","subject","description","company_name","company_document_number","city","department","country","source_document_url"]},{"type":"null"}]},"related":{"type":"array","items":{"type":"object","properties":{"filing_id":{"type":"string","description":"Número de radicado, `yyyy-01-nnnnnn`."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expediente (the process file) the row belongs to, when the source links one."},"previous_filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The radicado this one answers or continues, when any."},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the radicado, `yyyy-mm-dd`."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date and time of the radicado in Bogotá time, when the source stamps one."},"term_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Término in days, as the source prints it."},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Folios."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite as the source names it."},"procedure_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The trámite's numeric code at the source."},"process":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Proceso as the source names it, e.g. `APOYO JUDICIAL`, `NOTIFICACIÓN`, `REORGANIZACIÓN EMPRESARIAL Y CONCORDATOS`."},"sequence":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of an estado or traslado, e.g. `415-000374`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estado of the radicado as the source prints it."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Asunto."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document type as the source prints it."},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Razón social of the company or person the row is about, as the source prints it; the Superintendencia itself on its own estados and traslados."},"company_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"NIT or cédula of that company or person, digits only."},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's own viewer link for the radicado's files."}},"required":["filing_id","file_number","previous_filing_id","filed_date","filed_at","term_days","pages","procedure","procedure_code","process","sequence","status","subject","description","company_name","company_document_number","city","department","country","source_document_url"]},"description":"Radicados the source associates with the same expediente."},"checked_at":{"type":"string","description":"When the source was read, ISO 8601."}},"required":["found","filing_id","filing","related","checked_at"]},"SupersociedadesBarandaFilingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesBarandaFilingData"}}},"SupersociedadesRelatoriaDocumentsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"integer","description":"Matching rows, or the count cap when `total_is_exact` is false."},"total_is_exact":{"type":"boolean","description":"False when `total` is the count cap rather than the exact number of matches."},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer","description":"A floor when `total_is_exact` is false."},"count":{"type":"integer","description":"Rows in this page."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The document's identifier at the relatoría."},"content_type":{"type":"string","enum":["legal_opinion","ruling","oral_ruling","topic"],"description":"`legal_opinion` (concepto jurídico), `ruling` (sentencia escrita), `oral_ruling` (sentencia en audiencia, published as a video) or `topic` (tema y problema)."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The title as the relatoría prints it; a concepto's starts with its consecutivo."},"ruling_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sentencia's own title, when the relatoría gives one apart."},"consecutive":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of the concepto or sentencia, e.g. `220-123456` or `810-000056`."},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de radicado, `yyyy-01-nnnnnn`."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de proceso of a sentencia, e.g. `2019-800-00212`."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tema as the relatoría names it, e.g. `Responsabilidad de los administradores`."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite of a sentencia, e.g. `Proceso verbal`."},"decided_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the sentencia or of the concepto, `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year of the expediente."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Normatividad the relatoría names as the basis of the decision."},"modified_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the relatoría last edited the document, `yyyy-mm-dd`; null on documents it never re-edited."},"descriptors":{"type":"array","items":{"type":"string"},"description":"Main descriptors of the relatoría's thesaurus, e.g. `Administradores`."},"secondary_descriptors":{"type":"array","items":{"type":"string"},"description":"Secondary descriptors, e.g. `Deberes`."},"parties":{"type":"array","items":{"type":"object","properties":{"role":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`DEMANDANTE`, `DEMANDADO`, ... as the relatoría prints it."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`NIT`, `CÉDULA`, ..."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["role","document_type","document_number","name"]},"description":"The parties of a sentencia, as the relatoría lists them; empty on conceptos."},"party_document_numbers":{"type":"array","items":{"type":"string"},"description":"NITs and cédulas of the parties, digits only."},"text_length":{"type":"integer","description":"Characters in `text`."},"video_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The recording of an oral ruling, at the source."},"source_url":{"type":"string","description":"The document at the relatoría."}},"required":["id","content_type","title","ruling_title","consecutive","filing_id","case_number","subject","procedure","decided_date","year","legal_basis","modified_date","descriptors","secondary_descriptors","parties","party_document_numbers","text_length","video_url","source_url"]}}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","results"]},"SupersociedadesRelatoriaDocumentsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesRelatoriaDocumentsSearchData"}}},"SupersociedadesRelatoriaDocumentData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"id":{"type":"string","description":"Echoes the request."},"document":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The document's identifier at the relatoría."},"content_type":{"type":"string","enum":["legal_opinion","ruling","oral_ruling","topic"],"description":"`legal_opinion` (concepto jurídico), `ruling` (sentencia escrita), `oral_ruling` (sentencia en audiencia, published as a video) or `topic` (tema y problema)."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The title as the relatoría prints it; a concepto's starts with its consecutivo."},"ruling_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sentencia's own title, when the relatoría gives one apart."},"consecutive":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consecutivo of the concepto or sentencia, e.g. `220-123456` or `810-000056`."},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de radicado, `yyyy-01-nnnnnn`."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de proceso of a sentencia, e.g. `2019-800-00212`."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tema as the relatoría names it, e.g. `Responsabilidad de los administradores`."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite of a sentencia, e.g. `Proceso verbal`."},"decided_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the sentencia or of the concepto, `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Year of the expediente."},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Normatividad the relatoría names as the basis of the decision."},"modified_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the relatoría last edited the document, `yyyy-mm-dd`; null on documents it never re-edited."},"descriptors":{"type":"array","items":{"type":"string"},"description":"Main descriptors of the relatoría's thesaurus, e.g. `Administradores`."},"secondary_descriptors":{"type":"array","items":{"type":"string"},"description":"Secondary descriptors, e.g. `Deberes`."},"legal_sources":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Legal`, `Jurisprudencial`, `Doctrinal`, as the relatoría classes it."},"source":{"type":"string","description":"The norm or precedent as cited, e.g. `Artículo 24 del Código General del Proceso`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Vigente`, `Derogado`, ... when the relatoría notes it."},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A link to the norm, when the relatoría gives one."}},"required":["type","source","status","link"]},"description":"Fuentes jurídicas the document rests on."},"citations":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Legal`, `Jurisprudencial`, `Doctrinal`, as the relatoría classes it."},"source":{"type":"string","description":"The norm or precedent as cited, e.g. `Artículo 24 del Código General del Proceso`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Vigente`, `Derogado`, ... when the relatoría notes it."},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A link to the norm, when the relatoría gives one."}},"required":["type","source","status","link"]},"description":"What the document cites."},"parties":{"type":"array","items":{"type":"object","properties":{"role":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`DEMANDANTE`, `DEMANDADO`, ... as the relatoría prints it."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`NIT`, `CÉDULA`, ..."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["role","document_type","document_number","name"]},"description":"The parties of a sentencia, as the relatoría lists them; empty on conceptos."},"party_document_numbers":{"type":"array","items":{"type":"string"},"description":"NITs and cédulas of the parties, digits only."},"questions":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string","description":"The problema jurídico as the relatoría phrases it."},"current_position":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's current doctrinal position."},"contrary_position":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The position it moved away from, when any."},"reiteration":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether and where the position was reiterated."}},"required":["question","current_position","contrary_position","reiteration"]},"description":"Problemas jurídicos and the doctrinal positions on them."},"sections":{"anyOf":[{"type":"object","properties":{"background":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Antecedentes."},"facts":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hechos."},"claims":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pretensiones."},"considerations":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Consideraciones."},"costs":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Costas."},"resolution":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Resuelve."}},"required":["background","facts","claims","considerations","costs","resolution"]},{"type":"null"}],"description":"The sentencia split in its parts, when the relatoría did so."},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The full text of the concepto or sentencia, as the relatoría transcribed it."},"text_length":{"type":"integer","description":"Characters in `text`."},"video_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The recording of an oral ruling, at the source."},"source_url":{"type":"string","description":"The document at the relatoría."}},"required":["id","content_type","title","ruling_title","consecutive","filing_id","case_number","subject","procedure","decided_date","year","legal_basis","modified_date","descriptors","secondary_descriptors","legal_sources","citations","parties","party_document_numbers","questions","sections","text","text_length","video_url","source_url"]},{"type":"null"}]}},"required":["as_of","found","id","document"]},"SupersociedadesRelatoriaDocumentResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesRelatoriaDocumentData"}}},"SupersociedadesRelatoriaHistoricalRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"integer","description":"Matching rows, or the count cap when `total_is_exact` is false."},"total_is_exact":{"type":"boolean","description":"False when `total` is the count cap rather than the exact number of matches."},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer","description":"A floor when `total_is_exact` is false."},"count":{"type":"integer","description":"Rows in this page."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<collection>:<file id at the Superintendencia>`."},"collection":{"type":"string","enum":["insolvency","mercantile"],"description":"`insolvency` (autos and sentencias of the insolvency delegatura, 2012-2021) or `mercantile` (sentencias and autos of the mercantile delegatura, 2012-2019)."},"title":{"type":"string","description":"The file's title at the Superintendencia: the radicado for insolvency, the sentencia's number and date for mercantile."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the Superintendencia says about the file: the parties, or the topics."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's category: `Liquidaciones`, `Reorganización`, `Acuerdos Insolv Ejecución`, `Otros`, or a mercantile topic such as `Régimen de Administradores`."},"dependency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Dependencia de origen, as the Superintendencia prints it."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite, as the Superintendencia prints it."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Asunto."},"case_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case as the Superintendencia names it, e.g. `A contra B`."},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tema, as the Superintendencia numbers it."},"year":{"anyOf":[{"type":"integer"},{"type":"null"}]},"issued_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the ruling, `yyyy-mm-dd`."},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Superintendencia published it, `yyyy-mm-dd`."},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the file was uploaded to the Superintendencia."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of the file."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the PDF."},"source_document_url":{"type":"string","description":"The Superintendencia's own link to the PDF."}},"required":["id","collection","title","description","category","dependency","procedure","subject","case_name","topic","year","issued_date","published_date","created_at","modified_at","bytes","document_url","source_document_url"]}}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","results"]},"SupersociedadesRelatoriaHistoricalRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesRelatoriaHistoricalRulingsSearchData"}}},"SupersociedadesRelatoriaOpinionFilesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"integer","description":"Matching rows, or the count cap when `total_is_exact` is false."},"total_is_exact":{"type":"boolean","description":"False when `total` is the count cap rather than the exact number of matches."},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer","description":"A floor when `total_is_exact` is false."},"count":{"type":"integer","description":"Rows in this page."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<collection>:<file id at the Superintendencia>`."},"collection":{"type":"string","enum":["legal","accounting"],"description":"`legal` (conceptos jurídicos, the Oficina Asesora Jurídica's oficios 220 and 195) or `accounting` (conceptos contables, the oficios 115)."},"title":{"type":"string","description":"The file's title at the Superintendencia, e.g. `OFICIO 220-001087 DE 3 DE ENERO DE 2024`."},"consecutive":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The oficio's consecutivo, `nnn-nnnnnn`, e.g. `220-001087`. The same consecutivo names the concepto in the relatoría's `documents`."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The epígrafe: what the concepto is about, as the Superintendencia prints it."},"issued_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the oficio, `yyyy-mm-dd`."},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Superintendencia published it, `yyyy-mm-dd`."},"year":{"anyOf":[{"type":"integer"},{"type":"null"}]},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Número de radicado the concepto answers, when the Superintendencia notes it."},"dependency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office that issued it, as the Superintendencia prints it."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trámite, as the Superintendencia prints it."},"in_force":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the Superintendencia marks the concepto as vigente; null when it does not say."},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the file was uploaded to the Superintendencia."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the PDF."},"source_document_url":{"type":"string","description":"The Superintendencia's own link to the PDF."}},"required":["id","collection","title","consecutive","subject","issued_date","published_date","year","filing_id","dependency","procedure","in_force","created_at","modified_at","bytes","document_url","source_document_url"]}}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","results"]},"SupersociedadesRelatoriaOpinionFilesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesRelatoriaOpinionFilesSearchData"}}},"SupersociedadesRelatoriaBulletinsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"integer","description":"Matching rows, or the count cap when `total_is_exact` is false."},"total_is_exact":{"type":"boolean","description":"False when `total` is the count cap rather than the exact number of matches."},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer","description":"A floor when `total_is_exact` is false."},"count":{"type":"integer","description":"Rows in this page."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The bulletin's identifier at the Superintendencia; `jurisprudence:<file>` for the mercantile delegatura's compilations."},"series":{"type":"string","enum":["legal_opinions","accounting","jurisprudence"],"description":"`legal_opinions` (Boletín de Conceptos Jurídicos, monthly), `accounting` (Boletín de Conceptos Contables, by semester) or `jurisprudence` (the mercantile delegatura's Boletín de Jurisprudencia volumes and Libros de Jurisprudencia Societaria)."},"title":{"type":"string"},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issue's own date, `yyyy-mm-dd`."},"published_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Superintendencia published it, `yyyy-mm-dd`; null for a compilation the Superintendencia only links elsewhere."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the issue covers, as the Superintendencia summarizes it."},"page_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issue's page at the Superintendencia."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the PDF."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's own link to the PDF, or the external viewer it points to for a compilation it does not host."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","series","title","issue_date","published_date","summary","page_url","document_url","source_document_url","bytes","modified_at"]}}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","results"]},"SupersociedadesRelatoriaBulletinsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesRelatoriaBulletinsSearchData"}}},"SupersociedadesRelatoriaNoticesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"total":{"type":"integer","description":"Matching rows, or the count cap when `total_is_exact` is false."},"total_is_exact":{"type":"boolean","description":"False when `total` is the count cap rather than the exact number of matches."},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer","description":"A floor when `total_is_exact` is false."},"count":{"type":"integer","description":"Rows in this page."},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`notice:<id>` for an aviso, `order:<file id>` for a court order."},"kind":{"type":"string","enum":["intervention","reorganization","judicial_liquidation","mandatory_liquidation","adjudication","special","general","court_order"],"description":"`intervention` (agentes interventores), `reorganization`, `judicial_liquidation`, `mandatory_liquidation`, `adjudication` (liquidación por adjudicación), `special` (procesos especiales), `general` (avisos generales de insolvencia) or `court_order` (autos de juzgados on insolvency processes)."},"title":{"type":"string"},"published_date":{"type":"string","description":"When the Superintendencia published it, `yyyy-mm-dd`."},"expires_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Superintendencia takes it down, `yyyy-mm-dd`, when it says so."},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The aviso's text, as published."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's description of a court order."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the main file."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's own link to the main file."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the source publishes it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the file; null when the source links a file it does not serve."},"source_document_url":{"type":"string","description":"The source's own link to the file."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."}},"required":["name","document_url","source_document_url","bytes"]},"description":"Every file the Superintendencia links from the notice, with our copy of each."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","title","published_date","expires_date","body_text","description","document_url","source_document_url","documents","modified_at"]}}},"required":["as_of","total","total_is_exact","page","per_page","total_pages","count","results"]},"SupersociedadesRelatoriaNoticesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesRelatoriaNoticesSearchData"}}},"SupersociedadesRelatoriaNoticeData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"id":{"type":"string","description":"Echoes the request."},"notice":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"`notice:<id>` for an aviso, `order:<file id>` for a court order."},"kind":{"type":"string","enum":["intervention","reorganization","judicial_liquidation","mandatory_liquidation","adjudication","special","general","court_order"],"description":"`intervention` (agentes interventores), `reorganization`, `judicial_liquidation`, `mandatory_liquidation`, `adjudication` (liquidación por adjudicación), `special` (procesos especiales), `general` (avisos generales de insolvencia) or `court_order` (autos de juzgados on insolvency processes)."},"title":{"type":"string"},"published_date":{"type":"string","description":"When the Superintendencia published it, `yyyy-mm-dd`."},"expires_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Superintendencia takes it down, `yyyy-mm-dd`, when it says so."},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The aviso's text, as published."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's description of a court order."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the main file."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's own link to the main file."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the source publishes it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our copy of the file; null when the source links a file it does not serve."},"source_document_url":{"type":"string","description":"The source's own link to the file."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."}},"required":["name","document_url","source_document_url","bytes"]},"description":"Every file the Superintendencia links from the notice, with our copy of each."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","title","published_date","expires_date","body_text","description","document_url","source_document_url","documents","modified_at"]},{"type":"null"}]}},"required":["as_of","found","id","notice"]},"SupersociedadesRelatoriaNoticeResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SupersociedadesRelatoriaNoticeData"}}},"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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"}}},"SunarpRegistrySearchData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the source returned at least one entry."},"office":{"type":"string","description":"The office searched, as the source names it."},"registry_area":{"type":"string","description":"Echoes the registry searched."},"search_by":{"type":"string","description":"Echoes what `number` was searched as."},"number":{"type":"string","description":"Echoes the number searched (uppercased, without spaces or hyphens)."},"count":{"type":"number","description":"Number of entries returned."},"theft_alert":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A stolen-vehicle notice the source attaches to the result, else null."},"entries":{"type":"array","items":{"type":"object","properties":{"registry_zone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Zona registral, e.g. \"ZONA REGISTRAL IX - SEDE LIMA\"."},"office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Oficina registral that keeps the entry."},"partida_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entry's partida number; pass it to the registry entry endpoint."},"status":{"anyOf":[{"type":"string","enum":["open","closed","extinguished"]},{"type":"null"}],"description":"`open`, `closed` (cerrada) or `extinguished` (extinguida); null for a state the source does not show, e.g. vehicle partidas."},"moved_to_partida":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the source has renumbered the partida, the number to search instead, e.g. `P12345678`."},"plate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Vehicle plate (vehicles only)."},"vehicle_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Vehicle status as the source prints it, e.g. \"EN CIRCULACIÓN\" (vehicles only)."},"ficha_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Older card (ficha) number, when the entry has one."},"volume":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tomo, for entries kept in books."},"folio":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Folio (foja), for entries kept in books."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Book (libro) the entry belongs to."},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registry as the source names it."}},"required":["registry_zone","office","partida_number","status","moved_to_partida","plate","vehicle_status","ficha_number","volume","folio","book","registry"]}}},"required":["found","office","registry_area","search_by","number","count","theft_alert","entries"]},"SunarpRegistrySearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunarpRegistrySearchData"}}},"SunarpRegistryEntryData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the source has the partida in that office and registry."},"office":{"type":"string","description":"The office, as the source names it."},"registry_area":{"type":"string"},"partida_number":{"type":"string"},"registry_zone":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["open","closed","extinguished"]},{"type":"null"}]},"plate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Vehicle plate (vehicles only)."},"vehicle_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Vehicle status (vehicles only)."},"has_images":{"type":"boolean","description":"False when the source shows no pages for the partida (vehicle partidas among them)."},"moved_to_partida":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the source has renumbered the partida, the number to ask for instead."},"page_count":{"type":"number","description":"Pages returned across inscriptions, cards and folios."},"pages_truncated":{"type":"boolean","description":"True when the partida has more pages than one call returns; the source lists the newest inscriptions first, and those are the ones kept."},"inscriptions":{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription (asiento) number as the source prints it, e.g. \"51\" or \"C00002\"."},"act":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act recorded, e.g. \"COMPRA VENTA\"."},"registered_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When it was inscribed, `yyyy-mm-ddThh:mm` (Lima time)."},"title_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the title (título) that produced it."},"year":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Year of that title."},"section":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Section (rubro) letter, when the source gives one."},"section_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Section (rubro) name, e.g. \"DESCRIPCION DEL INMUEBLE\"."},"pages":{"type":"array","items":{"type":"object","properties":{"page":{"type":"number","description":"Page number within its inscription or card."},"document_url":{"type":"string","description":"Our stored copy of the page (PDF), byte-identical to what the source serves."}},"required":["page","document_url"]}}},"required":["number","act","registered_at","title_number","year","section","section_name","pages"]},"description":"Inscriptions (asientos), in the order the source lists them."},"cards":{"type":"array","items":{"type":"object","properties":{"ficha_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"pages":{"type":"array","items":{"type":"object","properties":{"page":{"type":"number","description":"Page number within its inscription or card."},"document_url":{"type":"string","description":"Our stored copy of the page (PDF), byte-identical to what the source serves."}},"required":["page","document_url"]}}},"required":["ficha_number","pages"]},"description":"Older cards (fichas) the partida continues from."},"folios":{"type":"array","items":{"type":"object","properties":{"volume":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tomo."},"folio":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Folio (foja)."},"document_url":{"type":"string","description":"Our stored copy of the folio (PDF)."}},"required":["volume","folio","document_url"]},"description":"Book folios (tomo / folio) the partida continues from."},"checked_at":{"type":"string","description":"When the source was read (ISO 8601)."}},"required":["found","office","registry_area","partida_number","registry_zone","status","plate","vehicle_status","has_images","moved_to_partida","page_count","pages_truncated","inscriptions","cards","folios","checked_at"]},"SunarpRegistryEntryResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunarpRegistryEntryData"}}},"SunarpVehicleData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether SUNARP has a vehicle with that plate."},"plate":{"type":"string","description":"Echoes the plate searched (uppercased, without spaces or hyphens)."},"current_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The plate in force (placa vigente)."},"previous_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The plate it had before, or null when none (\"NINGUNA\")."},"make":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Make (marca), e.g. \"NISSAN\"."},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model (modelo), e.g. \"NP300 FRONTIER\"."},"model_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Model year (año de modelo)."},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Color as SUNARP records it, e.g. \"BLANCO\"."},"engine_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Engine number (número de motor)."},"serial_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Serial number (número de serie)."},"vin":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"VIN."},"vehicle_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Status as SUNARP prints it, e.g. \"EN CIRCULACION\"."},"annotations":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SUNARP's one-line annotations summary (anotaciones), or null when none (\"NINGUNA\")."},"theft_alert":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A stolen-vehicle notice SUNARP attaches to the plate, else null."},"owners":{"type":"array","items":{"type":"string"},"description":"Current owners as SUNARP prints them, \"SURNAMES, GIVEN NAMES\". Names only: SUNARP shows no document numbers here."},"registry_offices":{"type":"array","items":{"type":"object","properties":{"office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registry office that keeps the vehicle's partida, e.g. \"LIMA\"."},"office_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SUNARP's code for that office, zone and office joined by a hyphen, e.g. \"01-01\"."},"partida_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The vehicle's partida number there; pass it to the SUNARP registry entry endpoint."}},"required":["office","office_code","partida_number"]},"description":"Where the vehicle is registered. Usually one office."},"generated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When SUNARP produced the record, ISO 8601 (Lima time, -05:00)."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our stored copy of the record SUNARP returned (PNG), byte-identical; null when not found."},"checked_at":{"type":"string","description":"When SUNARP was read (ISO 8601)."}},"required":["found","plate","current_plate","previous_plate","make","model","model_year","color","engine_number","serial_number","vin","vehicle_status","annotations","theft_alert","owners","registry_offices","generated_at","document_url","checked_at"]},"SunarpVehicleResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunarpVehicleData"}}},"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. \"AGOSTO 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\", \"Vehículo menor urbano\")."},"vehicle_use":{"type":"string","description":"Vehicle use (e.g. \"Particular\", \"Transporte Urbano\")."},"accident_count":{"type":"number","description":"Accidents covered by this policy or certificate."},"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."},"annulment_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was annulled when the comment says (e.g. \"falta de pago\"), else null."},"rectified_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the insurer last rectified the record, when the comment reports one."},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's comment, e.g. an annulment or rectification note."}},"required":["company","vehicle_class","vehicle_use","accident_count","policy_number","certificate_number","start_date","end_date","status","annulled_date","annulment_reason","rectified_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\", \"Vehículo menor urbano\")."},"vehicle_use":{"type":"string","description":"Vehicle use (e.g. \"Particular\", \"Transporte Urbano\")."},"accident_count":{"type":"number","description":"Accidents covered by this policy or certificate."},"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."},"annulment_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was annulled when the comment says (e.g. \"falta de pago\"), else null."},"rectified_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the insurer last rectified the record, when the comment reports one."},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's comment, e.g. an annulment or rectification note."}},"required":["company","vehicle_class","vehicle_use","accident_count","policy_number","certificate_number","start_date","end_date","status","annulled_date","annulment_reason","rectified_date","comment"]},"description":"Policy history, newest first as the source returns it."},"coverages":{"type":"array","items":{"type":"object","properties":{"coverage":{"type":"string","description":"Covered event (e.g. \"Fallecimiento\", \"Gastos médicos\")."},"amount":{"type":"string","description":"Coverage amount as the source states it (e.g. \"Hasta 5 UIT\")."}},"required":["coverage","amount"]},"description":"What a SOAT policy covers, and up to how much."},"vehicle_insurance":{"type":"object","properties":{"found":{"type":"boolean"},"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. \"AGOSTO 2026\"), passthrough."},"accident_count":{"type":"number","description":"Accidents covered in the last 5 years."},"count":{"type":"number"},"has_active_policy":{"type":"boolean","description":"True when a vehicle insurance policy is currently in force."},"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\", \"Vehículo menor urbano\")."},"vehicle_use":{"type":"string","description":"Vehicle use (e.g. \"Particular\", \"Transporte Urbano\")."},"accident_count":{"type":"number","description":"Accidents covered by this policy or certificate."},"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."},"annulment_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was annulled when the comment says (e.g. \"falta de pago\"), else null."},"rectified_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the insurer last rectified the record, when the comment reports one."},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's comment, e.g. an annulment or rectification note."}},"required":["company","vehicle_class","vehicle_use","accident_count","policy_number","certificate_number","start_date","end_date","status","annulled_date","annulment_reason","rectified_date","comment"]},{"type":"null"}],"description":"The current (VIGENTE) policy when present, else null."},"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\", \"Vehículo menor urbano\")."},"vehicle_use":{"type":"string","description":"Vehicle use (e.g. \"Particular\", \"Transporte Urbano\")."},"accident_count":{"type":"number","description":"Accidents covered by this policy or certificate."},"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."},"annulment_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was annulled when the comment says (e.g. \"falta de pago\"), else null."},"rectified_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the insurer last rectified the record, when the comment reports one."},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's comment, e.g. an annulment or rectification note."}},"required":["company","vehicle_class","vehicle_use","accident_count","policy_number","certificate_number","start_date","end_date","status","annulled_date","annulment_reason","rectified_date","comment"]},"description":"Vehicle insurance policies, newest first as the source returns them."}},"required":["found","report_date","data_through","accident_count","count","has_active_policy","active","policies"],"description":"The plate's private vehicle insurance (Seguro Vehicular) report."},"cat":{"type":"object","properties":{"found":{"type":"boolean"},"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. \"AGOSTO 2026\"), passthrough."},"accident_count":{"type":"number","description":"Accidents covered in the last 5 years."},"count":{"type":"number"},"has_active_cat":{"type":"boolean","description":"True when a CAT certificate is currently in force."},"active":{"anyOf":[{"type":"object","properties":{"company":{"type":"string","description":"Issuing AFOCAT (the regional fund that issues CAT certificates)."},"vehicle_class":{"type":"string","description":"Vehicle class (e.g. \"Automóvil\", \"Camioneta Pick up\", \"Vehículo menor urbano\")."},"vehicle_use":{"type":"string","description":"Vehicle use (e.g. \"Particular\", \"Transporte Urbano\")."},"accident_count":{"type":"number","description":"Accidents covered by this policy or certificate."},"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."},"annulment_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was annulled when the comment says (e.g. \"falta de pago\"), else null."},"rectified_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the insurer last rectified the record, when the comment reports one."},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's comment, e.g. an annulment or rectification note."}},"required":["company","vehicle_class","vehicle_use","accident_count","certificate_number","start_date","end_date","status","annulled_date","annulment_reason","rectified_date","comment"]},{"type":"null"}],"description":"The current (VIGENTE) certificate when present, else null."},"certificates":{"type":"array","items":{"type":"object","properties":{"company":{"type":"string","description":"Issuing AFOCAT (the regional fund that issues CAT certificates)."},"vehicle_class":{"type":"string","description":"Vehicle class (e.g. \"Automóvil\", \"Camioneta Pick up\", \"Vehículo menor urbano\")."},"vehicle_use":{"type":"string","description":"Vehicle use (e.g. \"Particular\", \"Transporte Urbano\")."},"accident_count":{"type":"number","description":"Accidents covered by this policy or certificate."},"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."},"annulment_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was annulled when the comment says (e.g. \"falta de pago\"), else null."},"rectified_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the insurer last rectified the record, when the comment reports one."},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source's comment, e.g. an annulment or rectification note."}},"required":["company","vehicle_class","vehicle_use","accident_count","certificate_number","start_date","end_date","status","annulled_date","annulment_reason","rectified_date","comment"]},"description":"CAT certificates, newest first as the source returns them."},"coverages":{"type":"array","items":{"type":"object","properties":{"coverage":{"type":"string","description":"Covered event (e.g. \"Fallecimiento\", \"Gastos médicos\")."},"amount":{"type":"string","description":"Coverage amount as the source states it (e.g. \"Hasta 5 UIT\")."}},"required":["coverage","amount"]},"description":"What a CAT certificate covers, and up to how much."}},"required":["found","report_date","data_through","accident_count","count","has_active_cat","active","certificates","coverages"],"description":"The plate's CAT report: certificates issued by AFOCATs, the regional funds that cover public transport vehicles in place of SOAT."}},"required":["found","plate","report_date","data_through","accident_count","has_active_soat","active","count","policies","coverages","vehicle_insurance","cat"]},"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"}}},"RuntVehicleByVinData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether a vehicle is registered under the VIN. When false, the rest is empty."},"vin":{"type":"string","description":"The queried VIN, uppercased."},"plate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registered plate, or null when not found."},"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","vin","plate","vehicle","soat_policies","inspections","specifications","pledges","ownership_limitations","armoring","civil_liability","dijin_certificate","scrapping_certificate","normalization","scrapping"]},"RuntVehicleByVinResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RuntVehicleByVinData"}}},"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"}]},"service_modality":{"anyOf":[{"type":"string"},{"type":"null"}]},"service_level":{"anyOf":[{"type":"string"},{"type":"null"}]},"operating_radius":{"anyOf":[{"type":"string"},{"type":"null"}]},"traffic_authority":{"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"}]},"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"}]},"restamped_engine_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"restamped_chassis_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"restamped_serial_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"restamped_vin":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plate","brand","line","model_year","body_type","vehicle_class","color","fuel_type","service_type","service_modality","service_level","operating_radius","traffic_authority","engine_displacement","vin","engine_number","chassis_number","serial_number","registration_status","is_imported","clear_of_infractions","has_liens","has_limitations","is_auctioned","engine_restamped","chassis_restamped","serial_restamped","vin_restamped","restamped_engine_number","restamped_chassis_number","restamped_serial_number","restamped_vin"]},{"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"}]},"movable_guarantee":{"anyOf":[{"type":"object","properties":{"pledge_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"vehicle_pledge_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["pledge_id","vehicle_pledge_id","entity","registered_date","status"]},{"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","movable_guarantee","limitation"]},"RuntVehicleHistoryResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RuntVehicleHistoryData"}}},"RuntCitizenData":{"type":"object","properties":{"found":{"type":"boolean"},"document_type":{"type":"string"},"document_number":{"type":"string"},"first_surname":{"anyOf":[{"type":"string"},{"type":"null"}]},"person":{"anyOf":[{"type":"object","properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"person_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"driver_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_licenses":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["full_name","registration_id","registration_date","person_status","driver_status","has_licenses"]},{"type":"null"}]},"licenses":{"type":"array","items":{"type":"object","properties":{"license_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuing_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_retained":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"restrictions":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancellation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"suspension_start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"suspension_end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancelling_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"exam_expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_category":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["category","issue_date","expiry_date","exam_expiry_date","previous_category"]}}},"required":["license_number","issuing_authority","issue_date","status","is_retained","restrictions","cancellation_date","suspension_start_date","suspension_end_date","resolution_number","cancelling_authority","categories"]}},"fines":{"anyOf":[{"type":"object","properties":{"has_fines":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"clearance_number":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["has_fines","clearance_number"]},{"type":"null"}]},"requests":{"type":"array","items":{"type":"object","properties":{"request_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"request_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedures_completed":{"anyOf":[{"type":"number"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"registry":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["request_number","request_date","identifier","status","procedure_status","procedure","procedures_completed","entity","registry","validation_type","validation_description"]}},"aptitude_certificates":{"type":"array","items":{"type":"object","properties":{"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"certificate_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"center_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"request_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"request_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"fua_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"restrictions":{"anyOf":[{"type":"string"},{"type":"null"}]},"limitations":{"anyOf":[{"type":"string"},{"type":"null"}]},"limitation_expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"elements_to_overcome_limitations":{"anyOf":[{"type":"string"},{"type":"null"}]},"traffic_authority":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["certificate_number","certificate_type","status","center_name","issue_date","expiry_date","request_number","request_date","fua_number","procedure","category","restrictions","limitations","limitation_expiry_date","elements_to_overcome_limitations","traffic_authority"]}},"medical_certificates":{"type":"array","items":{"type":"object","properties":{"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"center_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"request_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"request_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"fua_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"restrictions":{"anyOf":[{"type":"string"},{"type":"null"}]},"limitations":{"anyOf":[{"type":"string"},{"type":"null"}]},"limitation_expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"elements_to_overcome_limitations":{"anyOf":[{"type":"string"},{"type":"null"}]},"traffic_authority":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["certificate_number","center_name","issue_date","expiry_date","status","request_number","request_date","fua_number","procedure","category","restrictions","limitations","limitation_expiry_date","elements_to_overcome_limitations","traffic_authority"]}},"cupl_registrations":{"type":"array","items":{"type":"object","properties":{"cupl_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"traffic_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["cupl_number","traffic_authority","issue_date","status"]}},"sicov_validations":{"type":"array","items":{"type":"object","properties":{"validation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"plate":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["validation_date","status","description","plate"]}},"ansv_payments":{"type":"array","items":{"type":"object","properties":{"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"center_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"certificate_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["registration_date","center_name","category","certificate_type","status"]}},"identity_validation":{"anyOf":[{"type":"object","properties":{"user_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlock_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"validations":{"type":"array","items":{"type":"object","properties":{"validation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"plate":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["validation_date","status","description","plate"]}}},"required":["user_status","unlock_date","validations"]},{"type":"null"}]}},"required":["found","document_type","document_number","first_surname","person","licenses","fines","requests","aptitude_certificates","medical_certificates","cupl_registrations","sicov_validations","ansv_payments","identity_validation"]},"RuntCitizenResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RuntCitizenData"}}},"RuntCitizenByPlateData":{"type":"object","properties":{"found":{"type":"boolean"},"plate":{"type":"string"},"owner":{"anyOf":[{"type":"object","properties":{"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["document_type","document_number","name"]},{"type":"null"}]},"citizen":{"anyOf":[{"type":"object","properties":{"found":{"type":"boolean"},"document_type":{"type":"string"},"document_number":{"type":"string"},"first_surname":{"anyOf":[{"type":"string"},{"type":"null"}]},"person":{"anyOf":[{"type":"object","properties":{"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"person_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"driver_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_licenses":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["full_name","registration_id","registration_date","person_status","driver_status","has_licenses"]},{"type":"null"}]},"licenses":{"type":"array","items":{"type":"object","properties":{"license_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuing_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_retained":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"restrictions":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancellation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"suspension_start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"suspension_end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancelling_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"exam_expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"previous_category":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["category","issue_date","expiry_date","exam_expiry_date","previous_category"]}}},"required":["license_number","issuing_authority","issue_date","status","is_retained","restrictions","cancellation_date","suspension_start_date","suspension_end_date","resolution_number","cancelling_authority","categories"]}},"fines":{"anyOf":[{"type":"object","properties":{"has_fines":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"clearance_number":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["has_fines","clearance_number"]},{"type":"null"}]},"requests":{"type":"array","items":{"type":"object","properties":{"request_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"request_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedures_completed":{"anyOf":[{"type":"number"},{"type":"null"}]},"entity":{"anyOf":[{"type":"string"},{"type":"null"}]},"registry":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["request_number","request_date","identifier","status","procedure_status","procedure","procedures_completed","entity","registry","validation_type","validation_description"]}},"aptitude_certificates":{"type":"array","items":{"type":"object","properties":{"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"certificate_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"center_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"request_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"request_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"fua_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"restrictions":{"anyOf":[{"type":"string"},{"type":"null"}]},"limitations":{"anyOf":[{"type":"string"},{"type":"null"}]},"limitation_expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"elements_to_overcome_limitations":{"anyOf":[{"type":"string"},{"type":"null"}]},"traffic_authority":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["certificate_number","certificate_type","status","center_name","issue_date","expiry_date","request_number","request_date","fua_number","procedure","category","restrictions","limitations","limitation_expiry_date","elements_to_overcome_limitations","traffic_authority"]}},"medical_certificates":{"type":"array","items":{"type":"object","properties":{"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"center_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"request_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"request_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"fua_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"restrictions":{"anyOf":[{"type":"string"},{"type":"null"}]},"limitations":{"anyOf":[{"type":"string"},{"type":"null"}]},"limitation_expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"elements_to_overcome_limitations":{"anyOf":[{"type":"string"},{"type":"null"}]},"traffic_authority":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["certificate_number","center_name","issue_date","expiry_date","status","request_number","request_date","fua_number","procedure","category","restrictions","limitations","limitation_expiry_date","elements_to_overcome_limitations","traffic_authority"]}},"cupl_registrations":{"type":"array","items":{"type":"object","properties":{"cupl_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"traffic_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["cupl_number","traffic_authority","issue_date","status"]}},"sicov_validations":{"type":"array","items":{"type":"object","properties":{"validation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"plate":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["validation_date","status","description","plate"]}},"ansv_payments":{"type":"array","items":{"type":"object","properties":{"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"center_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"certificate_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["registration_date","center_name","category","certificate_type","status"]}},"identity_validation":{"anyOf":[{"type":"object","properties":{"user_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlock_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"validations":{"type":"array","items":{"type":"object","properties":{"validation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"plate":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["validation_date","status","description","plate"]}}},"required":["user_status","unlock_date","validations"]},{"type":"null"}]}},"required":["found","document_type","document_number","first_surname","person","licenses","fines","requests","aptitude_certificates","medical_certificates","cupl_registrations","sicov_validations","ansv_payments","identity_validation"]},{"type":"null"}]}},"required":["found","plate","owner","citizen"]},"RuntCitizenByPlateResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RuntCitizenByPlateData"}}},"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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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"}}},"TribunalConstitucionalRulingsSearchData":{"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"}]},"proceeding_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The document's permanent identifier: its path on the court's site, e.g. \"2026/05005-2025-HC.pdf\" or \"2021/04841-2019-HC Aclaracion.pdf\". One case can have several documents, so the case file number is not unique."},"registration_number":{"type":"string","description":"The case file number (expediente) as the court prints it, e.g. \"05005-2025-HC\"."},"proceeding_type_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of proceeding as the court's code, read off the case file number: `AA` amparo, `HC` hábeas corpus, `HD` hábeas data, `AC` cumplimiento, `AI` or `PI` inconstitucionalidad, `CC` competencial, `Q` queja."},"proceeding_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of proceeding by name: \"Amparo\", \"Hábeas corpus\", \"Hábeas data\", \"Cumplimiento\", \"Inconstitucionalidad\", \"Competencial\" or \"Queja\". Null for a code outside that list."},"type":{"anyOf":[{"type":"string","enum":["sentencia","auto","sentencia_interlocutoria"]},{"type":"null"}],"description":"The kind of resolution: `sentencia`, `auto` (autos and decretos) or `sentencia_interlocutoria`."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number the court gives a sentencia, e.g. \"181/2026\". Null on autos and on many older sentencias."},"publication_date":{"type":"string","description":"`yyyy-mm-dd` the court published the resolution on its site."},"year":{"type":"number","description":"The year of publication."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"Pleno\", \"Sala Primera\" or \"Sala Segunda\". Null when the court records none."},"judicial_district":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judicial district the case came from, e.g. \"Distrito Judicial de Lima\". Recorded for about half the resolutions."},"case_id":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The court's own identifier for the case, shared by every document of that case."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the court published the resolution as an image with no text in it; `missing` when it published no readable document."},"official_url":{"type":"string","description":"The resolution's document on the Tribunal Constitucional's own site."},"case_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's page on the Tribunal Constitucional's own site."}},"required":["id","registration_number","proceeding_type_code","proceeding_type","type","number","publication_date","year","chamber","judicial_district","case_id","text_status","official_url","case_url"]}}},"required":["as_of","query","type","proceeding_type","chamber","registration_number","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"TribunalConstitucionalRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TribunalConstitucionalRulingsSearchData"}}},"TribunalConstitucionalRulingData":{"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 document's permanent identifier: its path on the court's site, e.g. \"2026/05005-2025-HC.pdf\" or \"2021/04841-2019-HC Aclaracion.pdf\". One case can have several documents, so the case file number is not unique."},"registration_number":{"type":"string","description":"The case file number (expediente) as the court prints it, e.g. \"05005-2025-HC\"."},"proceeding_type_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of proceeding as the court's code, read off the case file number: `AA` amparo, `HC` hábeas corpus, `HD` hábeas data, `AC` cumplimiento, `AI` or `PI` inconstitucionalidad, `CC` competencial, `Q` queja."},"proceeding_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of proceeding by name: \"Amparo\", \"Hábeas corpus\", \"Hábeas data\", \"Cumplimiento\", \"Inconstitucionalidad\", \"Competencial\" or \"Queja\". Null for a code outside that list."},"type":{"anyOf":[{"type":"string","enum":["sentencia","auto","sentencia_interlocutoria"]},{"type":"null"}],"description":"The kind of resolution: `sentencia`, `auto` (autos and decretos) or `sentencia_interlocutoria`."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number the court gives a sentencia, e.g. \"181/2026\". Null on autos and on many older sentencias."},"publication_date":{"type":"string","description":"`yyyy-mm-dd` the court published the resolution on its site."},"year":{"type":"number","description":"The year of publication."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"Pleno\", \"Sala Primera\" or \"Sala Segunda\". Null when the court records none."},"judicial_district":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judicial district the case came from, e.g. \"Distrito Judicial de Lima\". Recorded for about half the resolutions."},"case_id":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The court's own identifier for the case, shared by every document of that case."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the court published the resolution as an image with no text in it; `missing` when it published no readable document."},"official_url":{"type":"string","description":"The resolution's document on the Tribunal Constitucional's own site."},"case_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's page on the Tribunal Constitucional's own site."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the resolution'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 resolution's text, or null when `text_status` is not `ok`."}},"required":["id","registration_number","proceeding_type_code","proceeding_type","type","number","publication_date","year","chamber","judicial_district","case_id","text_status","official_url","case_url","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"TribunalConstitucionalRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TribunalConstitucionalRulingData"}}},"ServirTscResolutionsSearchData":{"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"}]},"resolution_number":{"anyOf":[{"type":"number"},{"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The resolution's permanent identifier, e.g. \"7586381\"."},"resolution_number":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The resolution's number, without leading zeros. Null when the tribunal published it under a title that carries none."},"resolution_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year the resolution's number belongs to, which is not always the year it was published in."},"chamber":{"type":"string","enum":["primera_sala","segunda_sala"],"description":"The chamber that issued it: `primera_sala` or `segunda_sala`."},"resolution_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the resolution is cited: number, year and chamber, e.g. \"5763-2025-primera_sala\"."},"title":{"type":"string","description":"The resolution's title as the tribunal publishes it."},"resolution_date":{"type":"string","description":"`yyyy-mm-dd` of the session the resolution belongs to."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The public entity the case is against, as the resolution's own heading gives it. Null when the document carries no text."},"expediente":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number the tribunal assigned. Null when the document carries no text."},"regime":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The employment regime the case falls under, e.g. \"Decreto Legislativo 276\". Null when the document carries no text."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the appeal is about, e.g. \"Régimen disciplinario\". Null when the document carries no text."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The tribunal's own one-paragraph summary (sumilla). Null when the document carries no text."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the tribunal published the resolution as an image with no text in it; `missing` when it published no readable document."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The resolution's document, as published. Null when none is linked."},"page_url":{"type":"string","description":"The resolution's page, as published."},"uploaded_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the document was last published, which can be days after the session it belongs to."}},"required":["id","resolution_number","resolution_year","chamber","resolution_key","title","resolution_date","entity","expediente","regime","subject","summary","text_status","document_url","page_url","uploaded_at"]}}},"required":["as_of","query","chamber","resolution_number","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"ServirTscResolutionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ServirTscResolutionsSearchData"}}},"ServirTscResolutionData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"resolution_id":{"type":"string"},"resolution":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The resolution's permanent identifier, e.g. \"7586381\"."},"resolution_number":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The resolution's number, without leading zeros. Null when the tribunal published it under a title that carries none."},"resolution_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year the resolution's number belongs to, which is not always the year it was published in."},"chamber":{"type":"string","enum":["primera_sala","segunda_sala"],"description":"The chamber that issued it: `primera_sala` or `segunda_sala`."},"resolution_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the resolution is cited: number, year and chamber, e.g. \"5763-2025-primera_sala\"."},"title":{"type":"string","description":"The resolution's title as the tribunal publishes it."},"resolution_date":{"type":"string","description":"`yyyy-mm-dd` of the session the resolution belongs to."},"entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The public entity the case is against, as the resolution's own heading gives it. Null when the document carries no text."},"expediente":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number the tribunal assigned. Null when the document carries no text."},"regime":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The employment regime the case falls under, e.g. \"Decreto Legislativo 276\". Null when the document carries no text."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the appeal is about, e.g. \"Régimen disciplinario\". Null when the document carries no text."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The tribunal's own one-paragraph summary (sumilla). Null when the document carries no text."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the tribunal published the resolution as an image with no text in it; `missing` when it published no readable document."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The resolution's document, as published. Null when none is linked."},"page_url":{"type":"string","description":"The resolution's page, as published."},"uploaded_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the document was last published, which can be days after the session it belongs to."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the resolution'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 resolution's text, or null when `text_status` is not `ok`."}},"required":["id","resolution_number","resolution_year","chamber","resolution_key","title","resolution_date","entity","expediente","regime","subject","summary","text_status","document_url","page_url","uploaded_at","content"]},{"type":"null"}]}},"required":["as_of","found","resolution_id","resolution"]},"ServirTscResolutionResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ServirTscResolutionData"}}},"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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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"}]},"fictitious_names":{"type":"array","items":{"type":"object","properties":{"document_number":{"type":"string","description":"The registration's number, `G` and eleven digits. The key."},"name":{"type":"string","description":"The fictitious name as registered."},"county":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The county the business operates in, upper-cased; `MULTIPLE` for more than one."},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"],"description":"The business's address under the fictitious name."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration was filed (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration expires unless renewed: December 31 of its fifth year (yyyy-mm-dd)."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration was cancelled, as its own record states (yyyy-mm-dd)."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The status on the registration's own record: `A` active, `C` cancelled, `E` expired."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"owner_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"more_than_ten_owners":{"type":"boolean","description":"The registration has more owners than the ten the record carries."},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The FEI number on the registration; returned only when every owner is a company."},"owners":{"type":"array","items":{"type":"object","properties":{"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's name: the company's, or the person's first, middle and last name and suffix."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's own Sunbiz document number, when the owner is an entity on the registry: the join to `sunbiz-entity`."},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's FEI number; returned for a company owner 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"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","city","state","zip","country"]}},"required":["kind","name","first_name","middle_name","last_name","suffix","document_number","fei_number","address"]}},"owner_names":{"type":"array","items":{"type":"string"},"description":"Every owner's name."},"owner_document_numbers":{"type":"array","items":{"type":"string"},"description":"The Sunbiz document numbers of the owners that are entities on the registry."},"person_owned":{"type":"boolean","description":"At least one owner is a person."},"listed_on":{"type":"string","description":"The day of the newest publication that lists the registration: the quarterly register or a day's filings (yyyy-mm-dd)."},"updated_at":{"type":"string","description":"When the registry published the state this record reflects."},"status":{"type":"string","enum":["active","inactive","cancelled"],"description":"`active` while the Division's register lists it; `inactive` once it no longer does (expired or cancelled); `cancelled` when a cancellation was filed."}},"required":["document_number","name","county","address","filed_on","expires_on","cancelled_on","status_code","pages","owner_count","more_than_ten_owners","fei_number","owners","owner_names","owner_document_numbers","person_owned","listed_on","updated_at","status"]},"description":"Up to 20 fictitious names (DBAs) the entity owns, newest first."},"fictitious_names_total":{"type":"number"},"marks":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string","description":"The mark's registration number, e.g. `T26000123456`. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The mark as the register names it."},"cross_reference_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A second name the register keeps for the mark."},"status":{"type":"string","enum":["active","inactive"],"description":"`active` or `inactive`."},"classes":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","code"]},"description":"The classes of goods or services the mark is registered in."},"class_codes":{"type":"array","items":{"type":"string"},"description":"The class codes, as the register writes them."},"disclaimers":{"type":"array","items":{"type":"string"}},"used_for":{"type":"array","items":{"type":"string"},"description":"The goods or services the mark is used for, as the registrant describes them."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the mark was filed (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration expires (yyyy-mm-dd)."},"first_used_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the mark was first used anywhere (yyyy-mm-dd)."},"first_used_in_florida_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the mark was first used in Florida (yyyy-mm-dd)."},"owners":{"type":"array","items":{"type":"object","properties":{"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's Sunbiz document number, when the owner is an entity on the registry."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]}},"required":["document_number","name","address"]}},"owner_names":{"type":"array","items":{"type":"string"}},"owner_document_numbers":{"type":"array","items":{"type":"string"},"description":"The Sunbiz document numbers of the owners that are entities on the registry."},"last_event_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_event_filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the last event was filed (yyyy-mm-dd)."},"event_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"type":"string","description":"When the registry published the state this record reflects."}},"required":["number","name","cross_reference_name","status","classes","class_codes","disclaimers","used_for","filed_on","expires_on","first_used_on","first_used_in_florida_on","owners","owner_names","owner_document_numbers","last_event_code","last_event_filed_on","event_sequence","updated_at"]},"description":"Up to 20 trademarks and service marks the entity owns, newest first."},"marks_total":{"type":"number"},"general_partnerships":{"type":"array","items":{"type":"object","properties":{"document_number":{"type":"string","description":"The partnership's document number, `GP` or `LLP` and digits. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The partnership's name."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The status as the registry writes it: one letter."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the partnership was filed (yyyy-mm-dd)."},"effective_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing took effect (yyyy-mm-dd)."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing was cancelled (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing expires (yyyy-mm-dd)."},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"fei_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"principal_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"mailing_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"converted":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The conversion flag as the registry writes it."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"florida_partners":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_partners":{"anyOf":[{"type":"number"},{"type":"null"}]},"cancel_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"partners":{"type":"array","items":{"type":"object","properties":{"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`P` partner or `A` authorized person."},"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The partner's Sunbiz document number, when the partner is an entity on the registry."},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]}},"required":["sequence","type","kind","name","document_number","address"]}},"partner_names":{"type":"array","items":{"type":"string"}},"partner_document_numbers":{"type":"array","items":{"type":"string"},"description":"The Sunbiz document numbers of the partners that are entities on the registry."},"events":{"type":"array","items":{"type":"object","properties":{"event_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the event was filed (yyyy-mm-dd)."},"effective_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When it took effect (yyyy-mm-dd)."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A cancellation date the event records (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An expiration date the event records (yyyy-mm-dd)."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"notes":{"type":"array","items":{"type":"string"}},"merger_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A name the event records."},"name_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"principal_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"mailing_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"dissociated":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]}},"required":["name","address"]},{"type":"null"}],"description":"A partner the event dissociates."},"affected_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancel_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["event_document_number","sequence","code","description","filed_on","effective_on","cancelled_on","expires_on","pages","notes","merger_document_number","name","name_sequence","principal_address","mailing_address","dissociated","affected_document_number","cancel_document_number"]},"description":"Every event filed against the partnership, oldest first."},"listed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The day of the newest publication that lists the filing."}},"required":["document_number","name","status_code","filed_on","effective_on","cancelled_on","expires_on","fei_number","fei_status","jurisdiction","principal_address","mailing_address","converted","pages","total_pages","florida_partners","total_partners","cancel_document_number","partners","partner_names","partner_document_numbers","events","listed_on"]},"description":"Up to 20 general partnerships the entity is a partner in, newest first."},"general_partnerships_total":{"type":"number"}},"required":["found","document_number","as_of","entity","fictitious_names","fictitious_names_total","marks","marks_total","general_partnerships","general_partnerships_total"]},"SunbizEntityResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunbizEntityData"}}},"SunbizFictitiousNamesSearchData":{"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"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}]},"owner_document_number":{"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"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"fictitious_names":{"type":"array","items":{"type":"object","properties":{"document_number":{"type":"string","description":"The registration's number, `G` and eleven digits. The key."},"name":{"type":"string","description":"The fictitious name as registered."},"county":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The county the business operates in, upper-cased; `MULTIPLE` for more than one."},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"],"description":"The business's address under the fictitious name."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration was filed (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration expires unless renewed: December 31 of its fifth year (yyyy-mm-dd)."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration was cancelled, as its own record states (yyyy-mm-dd)."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The status on the registration's own record: `A` active, `C` cancelled, `E` expired."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"owner_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"more_than_ten_owners":{"type":"boolean","description":"The registration has more owners than the ten the record carries."},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The FEI number on the registration; returned only when every owner is a company."},"owners":{"type":"array","items":{"type":"object","properties":{"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's name: the company's, or the person's first, middle and last name and suffix."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's own Sunbiz document number, when the owner is an entity on the registry: the join to `sunbiz-entity`."},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's FEI number; returned for a company owner 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"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","city","state","zip","country"]}},"required":["kind","name","first_name","middle_name","last_name","suffix","document_number","fei_number","address"]}},"owner_names":{"type":"array","items":{"type":"string"},"description":"Every owner's name."},"owner_document_numbers":{"type":"array","items":{"type":"string"},"description":"The Sunbiz document numbers of the owners that are entities on the registry."},"person_owned":{"type":"boolean","description":"At least one owner is a person."},"listed_on":{"type":"string","description":"The day of the newest publication that lists the registration: the quarterly register or a day's filings (yyyy-mm-dd)."},"updated_at":{"type":"string","description":"When the registry published the state this record reflects."},"status":{"type":"string","enum":["active","inactive","cancelled"],"description":"`active` while the Division's register lists it; `inactive` once it no longer does (expired or cancelled); `cancelled` when a cancellation was filed."}},"required":["document_number","name","county","address","filed_on","expires_on","cancelled_on","status_code","pages","owner_count","more_than_ten_owners","fei_number","owners","owner_names","owner_document_numbers","person_owned","listed_on","updated_at","status"]}}},"required":["as_of","query","status","county","owner_document_number","fei_number","filed_from","filed_to","total","total_is_exact","page","per_page","total_pages","count","fictitious_names"]},"SunbizFictitiousNamesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunbizFictitiousNamesSearchData"}}},"SunbizFictitiousNameData":{"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."},"fictitious_name":{"anyOf":[{"type":"object","properties":{"document_number":{"type":"string","description":"The registration's number, `G` and eleven digits. The key."},"name":{"type":"string","description":"The fictitious name as registered."},"county":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The county the business operates in, upper-cased; `MULTIPLE` for more than one."},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"],"description":"The business's address under the fictitious name."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration was filed (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration expires unless renewed: December 31 of its fifth year (yyyy-mm-dd)."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration was cancelled, as its own record states (yyyy-mm-dd)."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The status on the registration's own record: `A` active, `C` cancelled, `E` expired."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"owner_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"more_than_ten_owners":{"type":"boolean","description":"The registration has more owners than the ten the record carries."},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The FEI number on the registration; returned only when every owner is a company."},"owners":{"type":"array","items":{"type":"object","properties":{"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's name: the company's, or the person's first, middle and last name and suffix."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Persons only."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's own Sunbiz document number, when the owner is an entity on the registry: the join to `sunbiz-entity`."},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's FEI number; returned for a company owner 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"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","city","state","zip","country"]}},"required":["kind","name","first_name","middle_name","last_name","suffix","document_number","fei_number","address"]}},"owner_names":{"type":"array","items":{"type":"string"},"description":"Every owner's name."},"owner_document_numbers":{"type":"array","items":{"type":"string"},"description":"The Sunbiz document numbers of the owners that are entities on the registry."},"person_owned":{"type":"boolean","description":"At least one owner is a person."},"listed_on":{"type":"string","description":"The day of the newest publication that lists the registration: the quarterly register or a day's filings (yyyy-mm-dd)."},"updated_at":{"type":"string","description":"When the registry published the state this record reflects."},"status":{"type":"string","enum":["active","inactive","cancelled"],"description":"`active` while the Division's register lists it; `inactive` once it no longer does (expired or cancelled); `cancelled` when a cancellation was filed."}},"required":["document_number","name","county","address","filed_on","expires_on","cancelled_on","status_code","pages","owner_count","more_than_ten_owners","fei_number","owners","owner_names","owner_document_numbers","person_owned","listed_on","updated_at","status"]},{"type":"null"}]},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The event's document number and its action sequence. The key."},"event_document_number":{"type":"string"},"document_number":{"type":"string","description":"The registration the event is filed against."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The fictitious name as the event states it."},"action_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`REN` renewal, `CHF` change of address, `CHO` change of owner, `ADD` owner added, `DEL` owner removed, `CAN` cancellation, `AME` amendment."},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The action as the registry words it."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the event was filed (yyyy-mm-dd)."},"action_counter":{"anyOf":[{"type":"number"},{"type":"null"}]},"event_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"action_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous":{"anyOf":[{"type":"object","properties":{"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]}},"required":["fei_number","county","address"]},{"type":"null"}],"description":"What a change replaced: FEI number, county and address."},"current":{"anyOf":[{"type":"object","properties":{"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]}},"required":["fei_number","county","address"]},{"type":"null"}],"description":"What a change set."},"owner":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"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":["name","document_number","fei_number","address"]},{"type":"null"}],"description":"The owner an owner event names."},"previous_name_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"new_name_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","event_document_number","document_number","name","action_code","action","filed_on","action_counter","event_sequence","action_sequence","pages","previous","current","owner","previous_name_sequence","new_name_sequence"]},"description":"Every event filed against the registration, oldest first."}},"required":["found","document_number","as_of","fictitious_name","events"]},"SunbizFictitiousNameResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunbizFictitiousNameData"}}},"SunbizFederalLiensSearchData":{"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"}]},"filed_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"federal_liens":{"type":"array","items":{"type":"object","properties":{"document_number":{"type":"string","description":"The lien's document number, e.g. `08FLR0012050`. The key."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien was filed (yyyy-mm-dd)."},"assessed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The assessment date the notice states (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing expires (yyyy-mm-dd)."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing was cancelled (yyyy-mm-dd)."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"On the filing's own record: `A` active, `L` lapsed, `T` terminated."},"type_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`F` federal lien registration."},"transmitting_utility":{"anyOf":[{"type":"string"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"event_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"debtors_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"secured_parties_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"debtors_current":{"anyOf":[{"type":"number"},{"type":"null"}]},"secured_parties_current":{"anyOf":[{"type":"number"},{"type":"null"}]},"debtors":{"type":"array","items":{"type":"object","properties":{"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},"relation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`C` current."},"original":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the party was on the original filing, as the registry marks it."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`A` active, `L` lapsed, `T` terminated."},"listed_on":{"type":"string","description":"The day of the newest publication that lists the party."}},"required":["sequence","kind","name","address","relation","original","status_code","listed_on"]}},"secured_parties":{"type":"array","items":{"type":"object","properties":{"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},"relation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`C` current."},"original":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the party was on the original filing, as the registry marks it."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`A` active, `L` lapsed, `T` terminated."},"listed_on":{"type":"string","description":"The day of the newest publication that lists the party."}},"required":["sequence","kind","name","address","relation","original","status_code","listed_on"]},"description":"The lienholder, usually the Internal Revenue Service."},"events":{"type":"array","items":{"type":"object","properties":{"event_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"action_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `COR` certificate of release, `AGI`, `RNL`, `RNC`, `COD`, `CHA`."},"action":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the event was filed (yyyy-mm-dd)."},"created_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registry recorded it (yyyy-mm-dd)."},"event_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registry's tracking number for the event."},"action_counter":{"anyOf":[{"type":"number"},{"type":"null"}]},"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"action_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"name_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`D` debtor or `S` secured party, for an event that changes a name."},"previous_name_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"new_name_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["event_document_number","action_code","action","filed_on","created_on","event_number","action_counter","sequence","action_sequence","pages","name_type","previous_name_sequence","new_name_sequence"]},"description":"Every event filed against the lien, oldest first."},"debtor_names":{"type":"array","items":{"type":"string"}},"secured_party_names":{"type":"array","items":{"type":"string"}},"released":{"type":"boolean","description":"A certificate of release (`COR`) was filed."},"released_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the release was filed (yyyy-mm-dd)."},"listed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The day of the newest publication that lists the filing; null for a lien known only from its events."},"status":{"type":"string","enum":["active","released","inactive"],"description":"`released` once a certificate of release was filed; `active` while the Division's register lists it; `inactive` once it no longer does."}},"required":["document_number","filed_on","assessed_on","expires_on","cancelled_on","status_code","type_code","transmitting_utility","pages","total_pages","event_count","debtors_total","secured_parties_total","debtors_current","secured_parties_current","debtors","secured_parties","events","debtor_names","secured_party_names","released","released_on","listed_on","status"]}}},"required":["as_of","query","status","filed_from","filed_to","total","total_is_exact","page","per_page","total_pages","count","federal_liens"]},"SunbizFederalLiensSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunbizFederalLiensSearchData"}}},"SunbizFederalLienData":{"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."},"federal_lien":{"anyOf":[{"type":"object","properties":{"document_number":{"type":"string","description":"The lien's document number, e.g. `08FLR0012050`. The key."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien was filed (yyyy-mm-dd)."},"assessed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The assessment date the notice states (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing expires (yyyy-mm-dd)."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing was cancelled (yyyy-mm-dd)."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"On the filing's own record: `A` active, `L` lapsed, `T` terminated."},"type_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`F` federal lien registration."},"transmitting_utility":{"anyOf":[{"type":"string"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"event_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"debtors_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"secured_parties_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"debtors_current":{"anyOf":[{"type":"number"},{"type":"null"}]},"secured_parties_current":{"anyOf":[{"type":"number"},{"type":"null"}]},"debtors":{"type":"array","items":{"type":"object","properties":{"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},"relation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`C` current."},"original":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the party was on the original filing, as the registry marks it."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`A` active, `L` lapsed, `T` terminated."},"listed_on":{"type":"string","description":"The day of the newest publication that lists the party."}},"required":["sequence","kind","name","address","relation","original","status_code","listed_on"]}},"secured_parties":{"type":"array","items":{"type":"object","properties":{"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},"relation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`C` current."},"original":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the party was on the original filing, as the registry marks it."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`A` active, `L` lapsed, `T` terminated."},"listed_on":{"type":"string","description":"The day of the newest publication that lists the party."}},"required":["sequence","kind","name","address","relation","original","status_code","listed_on"]},"description":"The lienholder, usually the Internal Revenue Service."},"events":{"type":"array","items":{"type":"object","properties":{"event_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"action_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `COR` certificate of release, `AGI`, `RNL`, `RNC`, `COD`, `CHA`."},"action":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the event was filed (yyyy-mm-dd)."},"created_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registry recorded it (yyyy-mm-dd)."},"event_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registry's tracking number for the event."},"action_counter":{"anyOf":[{"type":"number"},{"type":"null"}]},"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"action_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"name_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`D` debtor or `S` secured party, for an event that changes a name."},"previous_name_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"new_name_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["event_document_number","action_code","action","filed_on","created_on","event_number","action_counter","sequence","action_sequence","pages","name_type","previous_name_sequence","new_name_sequence"]},"description":"Every event filed against the lien, oldest first."},"debtor_names":{"type":"array","items":{"type":"string"}},"secured_party_names":{"type":"array","items":{"type":"string"}},"released":{"type":"boolean","description":"A certificate of release (`COR`) was filed."},"released_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the release was filed (yyyy-mm-dd)."},"listed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The day of the newest publication that lists the filing; null for a lien known only from its events."},"status":{"type":"string","enum":["active","released","inactive"],"description":"`released` once a certificate of release was filed; `active` while the Division's register lists it; `inactive` once it no longer does."}},"required":["document_number","filed_on","assessed_on","expires_on","cancelled_on","status_code","type_code","transmitting_utility","pages","total_pages","event_count","debtors_total","secured_parties_total","debtors_current","secured_parties_current","debtors","secured_parties","events","debtor_names","secured_party_names","released","released_on","listed_on","status"]},{"type":"null"}]}},"required":["found","document_number","as_of","federal_lien"]},"SunbizFederalLienResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunbizFederalLienData"}}},"SunbizMarksSearchData":{"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"}]},"class_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"owner_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"marks":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string","description":"The mark's registration number, e.g. `T26000123456`. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The mark as the register names it."},"cross_reference_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A second name the register keeps for the mark."},"status":{"type":"string","enum":["active","inactive"],"description":"`active` or `inactive`."},"classes":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","code"]},"description":"The classes of goods or services the mark is registered in."},"class_codes":{"type":"array","items":{"type":"string"},"description":"The class codes, as the register writes them."},"disclaimers":{"type":"array","items":{"type":"string"}},"used_for":{"type":"array","items":{"type":"string"},"description":"The goods or services the mark is used for, as the registrant describes them."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the mark was filed (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration expires (yyyy-mm-dd)."},"first_used_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the mark was first used anywhere (yyyy-mm-dd)."},"first_used_in_florida_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the mark was first used in Florida (yyyy-mm-dd)."},"owners":{"type":"array","items":{"type":"object","properties":{"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's Sunbiz document number, when the owner is an entity on the registry."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]}},"required":["document_number","name","address"]}},"owner_names":{"type":"array","items":{"type":"string"}},"owner_document_numbers":{"type":"array","items":{"type":"string"},"description":"The Sunbiz document numbers of the owners that are entities on the registry."},"last_event_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_event_filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the last event was filed (yyyy-mm-dd)."},"event_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"type":"string","description":"When the registry published the state this record reflects."}},"required":["number","name","cross_reference_name","status","classes","class_codes","disclaimers","used_for","filed_on","expires_on","first_used_on","first_used_in_florida_on","owners","owner_names","owner_document_numbers","last_event_code","last_event_filed_on","event_sequence","updated_at"]}}},"required":["as_of","query","status","class_code","owner_document_number","filed_from","filed_to","total","total_is_exact","page","per_page","total_pages","count","marks"]},"SunbizMarksSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunbizMarksSearchData"}}},"SunbizMarkData":{"type":"object","properties":{"found":{"type":"boolean"},"number":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"mark":{"anyOf":[{"type":"object","properties":{"number":{"type":"string","description":"The mark's registration number, e.g. `T26000123456`. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The mark as the register names it."},"cross_reference_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A second name the register keeps for the mark."},"status":{"type":"string","enum":["active","inactive"],"description":"`active` or `inactive`."},"classes":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","code"]},"description":"The classes of goods or services the mark is registered in."},"class_codes":{"type":"array","items":{"type":"string"},"description":"The class codes, as the register writes them."},"disclaimers":{"type":"array","items":{"type":"string"}},"used_for":{"type":"array","items":{"type":"string"},"description":"The goods or services the mark is used for, as the registrant describes them."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the mark was filed (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration expires (yyyy-mm-dd)."},"first_used_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the mark was first used anywhere (yyyy-mm-dd)."},"first_used_in_florida_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the mark was first used in Florida (yyyy-mm-dd)."},"owners":{"type":"array","items":{"type":"object","properties":{"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The owner's Sunbiz document number, when the owner is an entity on the registry."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]}},"required":["document_number","name","address"]}},"owner_names":{"type":"array","items":{"type":"string"}},"owner_document_numbers":{"type":"array","items":{"type":"string"},"description":"The Sunbiz document numbers of the owners that are entities on the registry."},"last_event_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_event_filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the last event was filed (yyyy-mm-dd)."},"event_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"updated_at":{"type":"string","description":"When the registry published the state this record reflects."}},"required":["number","name","cross_reference_name","status","classes","class_codes","disclaimers","used_for","filed_on","expires_on","first_used_on","first_used_in_florida_on","owners","owner_names","owner_document_numbers","last_event_code","last_event_filed_on","event_sequence","updated_at"]},{"type":"null"}]}},"required":["found","number","as_of","mark"]},"SunbizMarkResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunbizMarkData"}}},"SunbizGeneralPartnershipsSearchData":{"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"}]},"partner_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"general_partnerships":{"type":"array","items":{"type":"object","properties":{"document_number":{"type":"string","description":"The partnership's document number, `GP` or `LLP` and digits. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The partnership's name."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The status as the registry writes it: one letter."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the partnership was filed (yyyy-mm-dd)."},"effective_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing took effect (yyyy-mm-dd)."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing was cancelled (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing expires (yyyy-mm-dd)."},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"fei_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"principal_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"mailing_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"converted":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The conversion flag as the registry writes it."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"florida_partners":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_partners":{"anyOf":[{"type":"number"},{"type":"null"}]},"cancel_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"partners":{"type":"array","items":{"type":"object","properties":{"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`P` partner or `A` authorized person."},"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The partner's Sunbiz document number, when the partner is an entity on the registry."},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]}},"required":["sequence","type","kind","name","document_number","address"]}},"partner_names":{"type":"array","items":{"type":"string"}},"partner_document_numbers":{"type":"array","items":{"type":"string"},"description":"The Sunbiz document numbers of the partners that are entities on the registry."},"events":{"type":"array","items":{"type":"object","properties":{"event_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the event was filed (yyyy-mm-dd)."},"effective_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When it took effect (yyyy-mm-dd)."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A cancellation date the event records (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An expiration date the event records (yyyy-mm-dd)."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"notes":{"type":"array","items":{"type":"string"}},"merger_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A name the event records."},"name_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"principal_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"mailing_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"dissociated":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]}},"required":["name","address"]},{"type":"null"}],"description":"A partner the event dissociates."},"affected_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancel_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["event_document_number","sequence","code","description","filed_on","effective_on","cancelled_on","expires_on","pages","notes","merger_document_number","name","name_sequence","principal_address","mailing_address","dissociated","affected_document_number","cancel_document_number"]},"description":"Every event filed against the partnership, oldest first."},"listed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The day of the newest publication that lists the filing."}},"required":["document_number","name","status_code","filed_on","effective_on","cancelled_on","expires_on","fei_number","fei_status","jurisdiction","principal_address","mailing_address","converted","pages","total_pages","florida_partners","total_partners","cancel_document_number","partners","partner_names","partner_document_numbers","events","listed_on"]}}},"required":["as_of","query","status","partner_document_number","filed_from","filed_to","total","total_is_exact","page","per_page","total_pages","count","general_partnerships"]},"SunbizGeneralPartnershipsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunbizGeneralPartnershipsSearchData"}}},"SunbizGeneralPartnershipData":{"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."},"general_partnership":{"anyOf":[{"type":"object","properties":{"document_number":{"type":"string","description":"The partnership's document number, `GP` or `LLP` and digits. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The partnership's name."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The status as the registry writes it: one letter."},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the partnership was filed (yyyy-mm-dd)."},"effective_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing took effect (yyyy-mm-dd)."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing was cancelled (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing expires (yyyy-mm-dd)."},"fei_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"fei_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"principal_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"mailing_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"converted":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The conversion flag as the registry writes it."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"florida_partners":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_partners":{"anyOf":[{"type":"number"},{"type":"null"}]},"cancel_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"partners":{"type":"array","items":{"type":"object","properties":{"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`P` partner or `A` authorized person."},"kind":{"anyOf":[{"type":"string","enum":["person","company"]},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The partner's Sunbiz document number, when the partner is an entity on the registry."},"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]}},"required":["sequence","type","kind","name","document_number","address"]}},"partner_names":{"type":"array","items":{"type":"string"}},"partner_document_numbers":{"type":"array","items":{"type":"string"},"description":"The Sunbiz document numbers of the partners that are entities on the registry."},"events":{"type":"array","items":{"type":"object","properties":{"event_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the event was filed (yyyy-mm-dd)."},"effective_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When it took effect (yyyy-mm-dd)."},"cancelled_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A cancellation date the event records (yyyy-mm-dd)."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An expiration date the event records (yyyy-mm-dd)."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"notes":{"type":"array","items":{"type":"string"}},"merger_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A name the event records."},"name_sequence":{"anyOf":[{"type":"number"},{"type":"null"}]},"principal_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"mailing_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"dissociated":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]}},"required":["name","address"]},{"type":"null"}],"description":"A partner the event dissociates."},"affected_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancel_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["event_document_number","sequence","code","description","filed_on","effective_on","cancelled_on","expires_on","pages","notes","merger_document_number","name","name_sequence","principal_address","mailing_address","dissociated","affected_document_number","cancel_document_number"]},"description":"Every event filed against the partnership, oldest first."},"listed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The day of the newest publication that lists the filing."}},"required":["document_number","name","status_code","filed_on","effective_on","cancelled_on","expires_on","fei_number","fei_status","jurisdiction","principal_address","mailing_address","converted","pages","total_pages","florida_partners","total_partners","cancel_document_number","partners","partner_names","partner_document_numbers","events","listed_on"]},{"type":"null"}]}},"required":["found","document_number","as_of","general_partnership"]},"SunbizGeneralPartnershipResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SunbizGeneralPartnershipData"}}},"SecCompaniesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"ein":{"anyOf":[{"type":"string"},{"type":"null"}]},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}]},"exchange":{"anyOf":[{"type":"string"},{"type":"null"}]},"sic":{"anyOf":[{"type":"string"},{"type":"null"}]},"state_of_incorporation":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Filers matching the filters, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"companies":{"type":"array","items":{"type":"object","properties":{"cik":{"type":"string","description":"EDGAR's Central Index Key, without leading zeros: `320193` is Apple."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filer's name as EDGAR holds it today; null for the few filers EDGAR holds without one."},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`operating` (a company that files periodic reports), `investment` (a registered fund), or `other`: persons, trusts, funds and companies that file other forms."},"sic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Standard Industrial Classification code EDGAR assigns, e.g. `3571`."},"sic_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"owner_org":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC office that reviews the filer, e.g. `06 Technology`."},"insider_transactions_as_owner":{"type":"boolean","description":"The filer has reported insider transactions as an owner (Forms 3, 4, 5)."},"insider_transactions_as_issuer":{"type":"boolean","description":"Insiders have reported transactions in the filer's own securities."},"tickers":{"type":"array","items":{"type":"string"},"description":"The filer's tickers, when it is listed."},"exchanges":{"type":"array","items":{"type":"string"},"description":"Where those tickers trade: `NYSE`, `Nasdaq`, `OTC`, `CBOE`."},"ein":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IRS Employer Identification Number, nine digits, as the filer gave it to EDGAR. Null when EDGAR has none (it holds `000000000` for many filers, which is served as null)."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Legal Entity Identifier, rarely given."},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"investor_website":{"anyOf":[{"type":"string"},{"type":"null"}]},"filer_categories":{"type":"array","items":{"type":"string"},"description":"The filer status EDGAR records: `Large accelerated filer`, `Smaller reporting company`, `Emerging growth company`, ..."},"fiscal_year_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`MMDD` the filer's fiscal year ends, e.g. `1231`."},"state_of_incorporation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"EDGAR's code for the state or country of incorporation: `DE`, `NV`, `E9` (Cayman Islands), ..."},"state_of_incorporation_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"EDGAR's code for the state or country of the business address."},"state_or_country_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the code stands for, as EDGAR spells it."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_foreign_location":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"foreign_state_territory":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","state_or_country_description","zip_code","is_foreign_location","foreign_state_territory","country","country_code"]},"mailing_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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"EDGAR's code: a two-letter US state, or a code for a country or province (`E9` is the Cayman Islands, `A6` Ontario)."},"state_or_country_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the code stands for, as EDGAR spells it."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_foreign_location":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"foreign_state_territory":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","state_or_country_description","zip_code","is_foreign_location","foreign_state_territory","country","country_code"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What EDGAR flags on the filer, e.g. `REVOKED` when the SEC revoked its registration."},"former_names":{"type":"array","items":{"type":"string"},"description":"Every name the filer used before, for search."},"name_history":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"from":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the name was first used on EDGAR."},"to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the name was last used."}},"required":["name","from","to"]},"description":"The former names with the dates each was in use."},"filing_count":{"type":"integer","description":"Filings of every form EDGAR lists for the filer."},"first_filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the filer's first filing on EDGAR."},"last_filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of its latest filing."},"edgar_url":{"type":"string","description":"The filer's page on EDGAR."},"updated_at":{"type":"string","description":"When this record was last brought up to date from EDGAR."}},"required":["cik","name","entity_type","sic","sic_description","owner_org","insider_transactions_as_owner","insider_transactions_as_issuer","tickers","exchanges","ein","lei","description","website","investor_website","filer_categories","fiscal_year_end","state_of_incorporation","state_of_incorporation_description","business_address","mailing_address","phone","flags","former_names","name_history","filing_count","first_filed_on","last_filed_on","edgar_url","updated_at"]}}},"required":["as_of","query","ein","ticker","exchange","sic","state_of_incorporation","state","entity_type","total","total_is_exact","page","per_page","total_pages","count","companies"]},"SecCompaniesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecCompaniesSearchData"}}},"SecCompanyData":{"type":"object","properties":{"found":{"type":"boolean"},"cik":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"company":{"anyOf":[{"type":"object","properties":{"cik":{"type":"string","description":"EDGAR's Central Index Key, without leading zeros: `320193` is Apple."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filer's name as EDGAR holds it today; null for the few filers EDGAR holds without one."},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`operating` (a company that files periodic reports), `investment` (a registered fund), or `other`: persons, trusts, funds and companies that file other forms."},"sic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Standard Industrial Classification code EDGAR assigns, e.g. `3571`."},"sic_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"owner_org":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC office that reviews the filer, e.g. `06 Technology`."},"insider_transactions_as_owner":{"type":"boolean","description":"The filer has reported insider transactions as an owner (Forms 3, 4, 5)."},"insider_transactions_as_issuer":{"type":"boolean","description":"Insiders have reported transactions in the filer's own securities."},"tickers":{"type":"array","items":{"type":"string"},"description":"The filer's tickers, when it is listed."},"exchanges":{"type":"array","items":{"type":"string"},"description":"Where those tickers trade: `NYSE`, `Nasdaq`, `OTC`, `CBOE`."},"ein":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IRS Employer Identification Number, nine digits, as the filer gave it to EDGAR. Null when EDGAR has none (it holds `000000000` for many filers, which is served as null)."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Legal Entity Identifier, rarely given."},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"investor_website":{"anyOf":[{"type":"string"},{"type":"null"}]},"filer_categories":{"type":"array","items":{"type":"string"},"description":"The filer status EDGAR records: `Large accelerated filer`, `Smaller reporting company`, `Emerging growth company`, ..."},"fiscal_year_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`MMDD` the filer's fiscal year ends, e.g. `1231`."},"state_of_incorporation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"EDGAR's code for the state or country of incorporation: `DE`, `NV`, `E9` (Cayman Islands), ..."},"state_of_incorporation_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"EDGAR's code for the state or country of the business address."},"state_or_country_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the code stands for, as EDGAR spells it."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_foreign_location":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"foreign_state_territory":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","state_or_country_description","zip_code","is_foreign_location","foreign_state_territory","country","country_code"]},"mailing_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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"EDGAR's code: a two-letter US state, or a code for a country or province (`E9` is the Cayman Islands, `A6` Ontario)."},"state_or_country_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the code stands for, as EDGAR spells it."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_foreign_location":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"foreign_state_territory":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","state_or_country_description","zip_code","is_foreign_location","foreign_state_territory","country","country_code"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What EDGAR flags on the filer, e.g. `REVOKED` when the SEC revoked its registration."},"former_names":{"type":"array","items":{"type":"string"},"description":"Every name the filer used before, for search."},"name_history":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"from":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the name was first used on EDGAR."},"to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the name was last used."}},"required":["name","from","to"]},"description":"The former names with the dates each was in use."},"filing_count":{"type":"integer","description":"Filings of every form EDGAR lists for the filer."},"first_filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the filer's first filing on EDGAR."},"last_filed_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of its latest filing."},"edgar_url":{"type":"string","description":"The filer's page on EDGAR."},"updated_at":{"type":"string","description":"When this record was last brought up to date from EDGAR."}},"required":["cik","name","entity_type","sic","sic_description","owner_org","insider_transactions_as_owner","insider_transactions_as_issuer","tickers","exchanges","ein","lei","description","website","investor_website","filer_categories","fiscal_year_end","state_of_incorporation","state_of_incorporation_description","business_address","mailing_address","phone","flags","former_names","name_history","filing_count","first_filed_on","last_filed_on","edgar_url","updated_at"]},{"type":"null"}]},"filing_events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<accession_number>:<cik>`: the filing, for one of its filers."},"accession_number":{"type":"string","description":"EDGAR's accession number of the filing, e.g. `0001193125-26-012345`."},"cik":{"type":"string","description":"The filer this row is for, without leading zeros."},"form":{"type":"string","description":"The form type exactly as EDGAR spells it: `8-K`, `8-K/A`, `S-4`, `425`, `25-NSE`, `15-12B`, `SC 13D`, `SCHEDULE 13D`, `NT 10-K`, ..."},"event_type":{"type":"string","enum":["current_report","merger_or_acquisition","delisting_or_deregistration","registration","late_filing_notice","beneficial_ownership"],"description":"What kind of event the form is."},"filed_on":{"type":"string","description":"`yyyy-mm-dd`, the filing's official date."},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the event reported, when the form gives one."},"accepted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When EDGAR accepted the filing."},"act":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The securities act the filing is under, e.g. `34`, `33`."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC file number the filing is under for this filer, e.g. `001-36743`."},"film_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"string"},"description":"For an 8-K, the items reported: `1.01` material agreement, `1.03` bankruptcy, `2.01` acquisition completed, `2.02` results, `3.01` delisting notice, `5.02` officer or director change, `9.01` exhibits, ..."},"core_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The filing's size in bytes."},"is_xbrl":{"type":"boolean"},"is_inline_xbrl":{"type":"boolean"},"primary_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name of the filing's main document."},"primary_document_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_url":{"type":"string","description":"The filing's index page on EDGAR."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing's main document on EDGAR."}},"required":["id","accession_number","cik","form","event_type","filed_on","report_date","accepted_at","act","file_number","film_number","items","core_type","size","is_xbrl","is_inline_xbrl","primary_document","primary_document_description","filing_url","source_document_url"]},"description":"The filer's latest event filings since 2020, newest first, up to 20."},"filing_events_total":{"type":"number","description":"Every event filing of the filer since 2020."}},"required":["found","cik","as_of","company","filing_events","filing_events_total"]},"SecCompanyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecCompanyData"}}},"SecFilingEventsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"event_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"form":{"anyOf":[{"type":"string"},{"type":"null"}]},"item":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Event filings matching the filters, across every page (one per filer on a filing), counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"filing_events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<accession_number>:<cik>`: the filing, for one of its filers."},"accession_number":{"type":"string","description":"EDGAR's accession number of the filing, e.g. `0001193125-26-012345`."},"cik":{"type":"string","description":"The filer this row is for, without leading zeros."},"form":{"type":"string","description":"The form type exactly as EDGAR spells it: `8-K`, `8-K/A`, `S-4`, `425`, `25-NSE`, `15-12B`, `SC 13D`, `SCHEDULE 13D`, `NT 10-K`, ..."},"event_type":{"type":"string","enum":["current_report","merger_or_acquisition","delisting_or_deregistration","registration","late_filing_notice","beneficial_ownership"],"description":"What kind of event the form is."},"filed_on":{"type":"string","description":"`yyyy-mm-dd`, the filing's official date."},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the event reported, when the form gives one."},"accepted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When EDGAR accepted the filing."},"act":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The securities act the filing is under, e.g. `34`, `33`."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC file number the filing is under for this filer, e.g. `001-36743`."},"film_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"string"},"description":"For an 8-K, the items reported: `1.01` material agreement, `1.03` bankruptcy, `2.01` acquisition completed, `2.02` results, `3.01` delisting notice, `5.02` officer or director change, `9.01` exhibits, ..."},"core_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The filing's size in bytes."},"is_xbrl":{"type":"boolean"},"is_inline_xbrl":{"type":"boolean"},"primary_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name of the filing's main document."},"primary_document_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_url":{"type":"string","description":"The filing's index page on EDGAR."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing's main document on EDGAR."},"company":{"anyOf":[{"type":"object","properties":{"cik":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"ein":{"anyOf":[{"type":"string"},{"type":"null"}]},"state_of_incorporation":{"anyOf":[{"type":"string"},{"type":"null"}]},"sic":{"anyOf":[{"type":"string"},{"type":"null"}]},"sic_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"tickers":{"type":"array","items":{"type":"string"}},"exchanges":{"type":"array","items":{"type":"string"}}},"required":["cik","name","entity_type","ein","state_of_incorporation","sic","sic_description","tickers","exchanges"]},{"type":"null"}],"description":"The filer as EDGAR holds it today: name, EIN, state of incorporation, tickers."}},"required":["id","accession_number","cik","form","event_type","filed_on","report_date","accepted_at","act","file_number","film_number","items","core_type","size","is_xbrl","is_inline_xbrl","primary_document","primary_document_description","filing_url","source_document_url","company"]}}},"required":["as_of","query","cik","event_type","form","item","filed_from","filed_to","total","total_is_exact","page","per_page","total_pages","count","filing_events"]},"SecFilingEventsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecFilingEventsSearchData"}}},"SecFilingEventData":{"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_events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<accession_number>:<cik>`: the filing, for one of its filers."},"accession_number":{"type":"string","description":"EDGAR's accession number of the filing, e.g. `0001193125-26-012345`."},"cik":{"type":"string","description":"The filer this row is for, without leading zeros."},"form":{"type":"string","description":"The form type exactly as EDGAR spells it: `8-K`, `8-K/A`, `S-4`, `425`, `25-NSE`, `15-12B`, `SC 13D`, `SCHEDULE 13D`, `NT 10-K`, ..."},"event_type":{"type":"string","enum":["current_report","merger_or_acquisition","delisting_or_deregistration","registration","late_filing_notice","beneficial_ownership"],"description":"What kind of event the form is."},"filed_on":{"type":"string","description":"`yyyy-mm-dd`, the filing's official date."},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the event reported, when the form gives one."},"accepted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When EDGAR accepted the filing."},"act":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The securities act the filing is under, e.g. `34`, `33`."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC file number the filing is under for this filer, e.g. `001-36743`."},"film_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"string"},"description":"For an 8-K, the items reported: `1.01` material agreement, `1.03` bankruptcy, `2.01` acquisition completed, `2.02` results, `3.01` delisting notice, `5.02` officer or director change, `9.01` exhibits, ..."},"core_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The filing's size in bytes."},"is_xbrl":{"type":"boolean"},"is_inline_xbrl":{"type":"boolean"},"primary_document":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name of the filing's main document."},"primary_document_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_url":{"type":"string","description":"The filing's index page on EDGAR."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing's main document on EDGAR."},"company":{"anyOf":[{"type":"object","properties":{"cik":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"ein":{"anyOf":[{"type":"string"},{"type":"null"}]},"state_of_incorporation":{"anyOf":[{"type":"string"},{"type":"null"}]},"sic":{"anyOf":[{"type":"string"},{"type":"null"}]},"sic_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"tickers":{"type":"array","items":{"type":"string"}},"exchanges":{"type":"array","items":{"type":"string"}}},"required":["cik","name","entity_type","ein","state_of_incorporation","sic","sic_description","tickers","exchanges"]},{"type":"null"}],"description":"The filer as EDGAR holds it today: name, EIN, state of incorporation, tickers."}},"required":["id","accession_number","cik","form","event_type","filed_on","report_date","accepted_at","act","file_number","film_number","items","core_type","size","is_xbrl","is_inline_xbrl","primary_document","primary_document_description","filing_url","source_document_url","company"]},"description":"The filing once per filer on it: a 13D's filer and its subject, a merger's two sides."}},"required":["found","accession_number","as_of","filing_events"]},"SecFilingEventResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecFilingEventData"}}},"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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","page","per_page","total_pages","count","holdings"]},"Sec13fHoldingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Sec13fHoldingsSearchData"}}},"DolOflcLcaSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"employer_fein":{"anyOf":[{"type":"string"},{"type":"null"}]},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_year":{"anyOf":[{"type":"number"},{"type":"null"}]},"visa_class":{"anyOf":[{"type":"string"},{"type":"null"}]},"case_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"soc_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"worksite_state":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_wage":{"anyOf":[{"type":"number"},{"type":"null"}]},"decided_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"decided_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"cases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<fiscal_year>:<case_number>`: a case decided again in a later fiscal year (a certification withdrawn) is a row of its own, and a second, different filing a year's file lists under the same number is `<fiscal_year>:<case_number>~2`."},"fiscal_year":{"type":"integer","description":"The federal fiscal year (October to September) DOL published the determination under."},"case_number":{"type":"string","description":"DOL's case number, e.g. `I-200-25267-332158`."},"case_status":{"type":"string","description":"`Certified`, `Certified - Withdrawn`, `Withdrawn` or `Denied`."},"received_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"decision_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"original_cert_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a certification later withdrawn, when it was first certified."},"visa_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`H-1B`, `H-1B1 Chile`, `H-1B1 Singapore` or `E-3 Australian`."},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"soc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Standard Occupational Classification code, e.g. `15-1252.00`."},"soc_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_time_position":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"begin_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total_worker_positions":{"anyOf":[{"type":"integer"},{"type":"null"}]},"new_employment":{"anyOf":[{"type":"integer"},{"type":"null"}]},"continued_employment":{"anyOf":[{"type":"integer"},{"type":"null"}]},"change_previous_employment":{"anyOf":[{"type":"integer"},{"type":"null"}]},"new_concurrent_employment":{"anyOf":[{"type":"integer"},{"type":"null"}]},"change_employer":{"anyOf":[{"type":"integer"},{"type":"null"}]},"amended_petition":{"anyOf":[{"type":"integer"},{"type":"null"}]},"employer":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"trade_name_dba":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"fein":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The employer's Federal Employer Identification Number, nine digits (published from fiscal year 2024)."},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","trade_name_dba","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","fein","naics_code"]},"employer_contact":{"type":"object","properties":{"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["last_name","first_name","middle_name","job_title","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","email"],"description":"The employer's point of contact for the filing."},"agent_representing_employer":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"agent_attorney":{"type":"object","properties":{"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["last_name","first_name","middle_name","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","email"]},"law_firm":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fein":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","fein"]},"state_of_highest_court":{"anyOf":[{"type":"string"},{"type":"null"}]},"name_of_highest_state_court":{"anyOf":[{"type":"string"},{"type":"null"}]},"worksite":{"type":"object","properties":{"workers":{"anyOf":[{"type":"integer"},{"type":"null"}]},"secondary_entity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The worker is placed with another company."},"secondary_entity_business_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The primary worksite's state."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["workers","secondary_entity","secondary_entity_business_name","address_1","address_2","city","county","state","postal_code"],"description":"The primary worksite; every worksite is in `lca-worksites`."},"wage":{"type":"object","properties":{"rate_from":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The offered wage, US dollars per `unit`."},"rate_to":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Year`, `Month`, `Bi-Weekly`, `Week` or `Hour`."},"prevailing_wage":{"anyOf":[{"type":"number"},{"type":"null"}]},"prevailing_wage_unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_tracking_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`I` to `IV`."},"prevailing_wage_oes_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_other_source":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_other_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_survey_publisher":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_survey_name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["rate_from","rate_to","unit","prevailing_wage","prevailing_wage_unit","prevailing_wage_tracking_number","prevailing_wage_level","prevailing_wage_oes_year","prevailing_wage_other_source","prevailing_wage_other_year","prevailing_wage_survey_publisher","prevailing_wage_survey_name"]},"total_worksite_locations":{"anyOf":[{"type":"integer"},{"type":"null"}]},"agree_to_lc_statement":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"h1b_dependent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The employer is H-1B dependent."},"willful_violator":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"support_h1b":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"statutory_basis":{"anyOf":[{"type":"string"},{"type":"null"}]},"appendix_a_attached":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"public_disclosure":{"anyOf":[{"type":"string"},{"type":"null"}]},"preparer":{"type":"object","properties":{"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_initial":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["last_name","first_name","middle_initial","business_name","email"]},"appendix_a":{"type":"array","items":{"type":"object","properties":{"exempt_workers":{"anyOf":[{"type":"integer"},{"type":"null"}]},"institution":{"anyOf":[{"type":"string"},{"type":"null"}]},"field_of_study":{"anyOf":[{"type":"string"},{"type":"null"}]},"degree_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["exempt_workers","institution","field_of_study","degree_date"]},"description":"Appendix A: the exempt workers' highest degree, when the employer claims the exemption."},"answers":{"default":{},"description":"Columns only files before fiscal year 2020 carry, under their name in lower case (`withdrawn`, `job_code`, `agent_attorney_name`), as filed; empty for later years.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}},"source_file":{"type":"string","description":"The DOL disclosure file the row was read from."}},"required":["id","fiscal_year","case_number","case_status","received_date","decision_date","original_cert_date","visa_class","job_title","soc_code","soc_title","full_time_position","begin_date","end_date","total_worker_positions","new_employment","continued_employment","change_previous_employment","new_concurrent_employment","change_employer","amended_petition","employer","employer_contact","agent_representing_employer","agent_attorney","law_firm","state_of_highest_court","name_of_highest_state_court","worksite","wage","total_worksite_locations","agree_to_lc_statement","h1b_dependent","willful_violator","support_h1b","statutory_basis","appendix_a_attached","public_disclosure","preparer","appendix_a","source_file"]}}},"required":["as_of","query","employer_fein","case_number","fiscal_year","visa_class","case_status","soc_code","worksite_state","min_wage","decided_from","decided_to","total","total_is_exact","page","per_page","total_pages","count","cases"]},"DolOflcLcaSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DolOflcLcaSearchData"}}},"DolOflcLcaCaseData":{"type":"object","properties":{"found":{"type":"boolean"},"case_number":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"determinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<fiscal_year>:<case_number>`: a case decided again in a later fiscal year (a certification withdrawn) is a row of its own, and a second, different filing a year's file lists under the same number is `<fiscal_year>:<case_number>~2`."},"fiscal_year":{"type":"integer","description":"The federal fiscal year (October to September) DOL published the determination under."},"case_number":{"type":"string","description":"DOL's case number, e.g. `I-200-25267-332158`."},"case_status":{"type":"string","description":"`Certified`, `Certified - Withdrawn`, `Withdrawn` or `Denied`."},"received_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"decision_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"original_cert_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a certification later withdrawn, when it was first certified."},"visa_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`H-1B`, `H-1B1 Chile`, `H-1B1 Singapore` or `E-3 Australian`."},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"soc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Standard Occupational Classification code, e.g. `15-1252.00`."},"soc_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_time_position":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"begin_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total_worker_positions":{"anyOf":[{"type":"integer"},{"type":"null"}]},"new_employment":{"anyOf":[{"type":"integer"},{"type":"null"}]},"continued_employment":{"anyOf":[{"type":"integer"},{"type":"null"}]},"change_previous_employment":{"anyOf":[{"type":"integer"},{"type":"null"}]},"new_concurrent_employment":{"anyOf":[{"type":"integer"},{"type":"null"}]},"change_employer":{"anyOf":[{"type":"integer"},{"type":"null"}]},"amended_petition":{"anyOf":[{"type":"integer"},{"type":"null"}]},"employer":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"trade_name_dba":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"fein":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The employer's Federal Employer Identification Number, nine digits (published from fiscal year 2024)."},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","trade_name_dba","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","fein","naics_code"]},"employer_contact":{"type":"object","properties":{"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["last_name","first_name","middle_name","job_title","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","email"],"description":"The employer's point of contact for the filing."},"agent_representing_employer":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"agent_attorney":{"type":"object","properties":{"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["last_name","first_name","middle_name","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","email"]},"law_firm":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fein":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","fein"]},"state_of_highest_court":{"anyOf":[{"type":"string"},{"type":"null"}]},"name_of_highest_state_court":{"anyOf":[{"type":"string"},{"type":"null"}]},"worksite":{"type":"object","properties":{"workers":{"anyOf":[{"type":"integer"},{"type":"null"}]},"secondary_entity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The worker is placed with another company."},"secondary_entity_business_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The primary worksite's state."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["workers","secondary_entity","secondary_entity_business_name","address_1","address_2","city","county","state","postal_code"],"description":"The primary worksite; every worksite is in `lca-worksites`."},"wage":{"type":"object","properties":{"rate_from":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The offered wage, US dollars per `unit`."},"rate_to":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Year`, `Month`, `Bi-Weekly`, `Week` or `Hour`."},"prevailing_wage":{"anyOf":[{"type":"number"},{"type":"null"}]},"prevailing_wage_unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_tracking_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`I` to `IV`."},"prevailing_wage_oes_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_other_source":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_other_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_survey_publisher":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_survey_name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["rate_from","rate_to","unit","prevailing_wage","prevailing_wage_unit","prevailing_wage_tracking_number","prevailing_wage_level","prevailing_wage_oes_year","prevailing_wage_other_source","prevailing_wage_other_year","prevailing_wage_survey_publisher","prevailing_wage_survey_name"]},"total_worksite_locations":{"anyOf":[{"type":"integer"},{"type":"null"}]},"agree_to_lc_statement":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"h1b_dependent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The employer is H-1B dependent."},"willful_violator":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"support_h1b":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"statutory_basis":{"anyOf":[{"type":"string"},{"type":"null"}]},"appendix_a_attached":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"public_disclosure":{"anyOf":[{"type":"string"},{"type":"null"}]},"preparer":{"type":"object","properties":{"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_initial":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["last_name","first_name","middle_initial","business_name","email"]},"appendix_a":{"type":"array","items":{"type":"object","properties":{"exempt_workers":{"anyOf":[{"type":"integer"},{"type":"null"}]},"institution":{"anyOf":[{"type":"string"},{"type":"null"}]},"field_of_study":{"anyOf":[{"type":"string"},{"type":"null"}]},"degree_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["exempt_workers","institution","field_of_study","degree_date"]},"description":"Appendix A: the exempt workers' highest degree, when the employer claims the exemption."},"answers":{"default":{},"description":"Columns only files before fiscal year 2020 carry, under their name in lower case (`withdrawn`, `job_code`, `agent_attorney_name`), as filed; empty for later years.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}},"source_file":{"type":"string","description":"The DOL disclosure file the row was read from."}},"required":["id","fiscal_year","case_number","case_status","received_date","decision_date","original_cert_date","visa_class","job_title","soc_code","soc_title","full_time_position","begin_date","end_date","total_worker_positions","new_employment","continued_employment","change_previous_employment","new_concurrent_employment","change_employer","amended_petition","employer","employer_contact","agent_representing_employer","agent_attorney","law_firm","state_of_highest_court","name_of_highest_state_court","worksite","wage","total_worksite_locations","agree_to_lc_statement","h1b_dependent","willful_violator","support_h1b","statutory_basis","appendix_a_attached","public_disclosure","preparer","appendix_a","source_file"]},"description":"Every determination of the case, newest fiscal year first: a certification later withdrawn appears once per year."},"worksites":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<fiscal_year>:<case_number>:<n>` (the case's own `id`, then `n`), `n` the worksite's order in the case."},"fiscal_year":{"type":"integer"},"case_number":{"type":"string"},"n":{"type":"integer"},"workers":{"anyOf":[{"type":"integer"},{"type":"null"}]},"secondary_entity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The worker is placed with another company."},"secondary_entity_business_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter code."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"city_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`city` as matched: upper case, without a trailing state, periods or doubled spaces (`AUSTIN` for `Austin, TX`)."},"rate_from":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars per `unit`."},"rate_to":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Year`, `Month`, `Bi-Weekly`, `Week` or `Hour`."},"prevailing_wage":{"anyOf":[{"type":"number"},{"type":"null"}]},"prevailing_wage_unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_tracking_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`I` to `IV`."},"prevailing_wage_oes_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_other_source":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_other_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_survey_publisher":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_survey_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"employer_fein":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's employer FEIN, copied from the case for search."},"employer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"answers":{"default":{},"description":"Columns only files before fiscal year 2020 carry for a worksite (`part_time`, `wage_source`, `yr_source_pub`, `pw_source`), as filed; empty for later years.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}},"source_file":{"type":"string"}},"required":["id","fiscal_year","case_number","n","workers","secondary_entity","secondary_entity_business_name","address_1","address_2","city","county","state","postal_code","city_key","rate_from","rate_to","unit","prevailing_wage","prevailing_wage_unit","prevailing_wage_tracking_number","prevailing_wage_level","prevailing_wage_oes_year","prevailing_wage_other_source","prevailing_wage_other_year","prevailing_wage_survey_publisher","prevailing_wage_survey_name","employer_fein","employer_name","source_file"]},"description":"Every worksite of the newest determination."}},"required":["found","case_number","as_of","determinations","worksites"]},"DolOflcLcaCaseResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DolOflcLcaCaseData"}}},"DolOflcLcaWorksitesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"employer_fein":{"anyOf":[{"type":"string"},{"type":"null"}]},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_year":{"anyOf":[{"type":"number"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"worksites":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<fiscal_year>:<case_number>:<n>` (the case's own `id`, then `n`), `n` the worksite's order in the case."},"fiscal_year":{"type":"integer"},"case_number":{"type":"string"},"n":{"type":"integer"},"workers":{"anyOf":[{"type":"integer"},{"type":"null"}]},"secondary_entity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The worker is placed with another company."},"secondary_entity_business_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter code."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"city_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`city` as matched: upper case, without a trailing state, periods or doubled spaces (`AUSTIN` for `Austin, TX`)."},"rate_from":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars per `unit`."},"rate_to":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Year`, `Month`, `Bi-Weekly`, `Week` or `Hour`."},"prevailing_wage":{"anyOf":[{"type":"number"},{"type":"null"}]},"prevailing_wage_unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_tracking_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`I` to `IV`."},"prevailing_wage_oes_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_other_source":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_other_year":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_survey_publisher":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_survey_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"employer_fein":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's employer FEIN, copied from the case for search."},"employer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"answers":{"default":{},"description":"Columns only files before fiscal year 2020 carry for a worksite (`part_time`, `wage_source`, `yr_source_pub`, `pw_source`), as filed; empty for later years.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}},"source_file":{"type":"string"}},"required":["id","fiscal_year","case_number","n","workers","secondary_entity","secondary_entity_business_name","address_1","address_2","city","county","state","postal_code","city_key","rate_from","rate_to","unit","prevailing_wage","prevailing_wage_unit","prevailing_wage_tracking_number","prevailing_wage_level","prevailing_wage_oes_year","prevailing_wage_other_source","prevailing_wage_other_year","prevailing_wage_survey_publisher","prevailing_wage_survey_name","employer_fein","employer_name","source_file"]}}},"required":["as_of","employer_fein","case_number","fiscal_year","state","city","postal_code","total","total_is_exact","page","per_page","total_pages","count","worksites"]},"DolOflcLcaWorksitesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DolOflcLcaWorksitesSearchData"}}},"DolOflcPermSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"employer_fein":{"anyOf":[{"type":"string"},{"type":"null"}]},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_year":{"anyOf":[{"type":"number"},{"type":"null"}]},"case_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"soc_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"worksite_state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country_of_citizenship":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_wage":{"anyOf":[{"type":"number"},{"type":"null"}]},"decided_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"decided_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"cases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<fiscal_year>:<case_number>`."},"fiscal_year":{"type":"integer","description":"The federal fiscal year (October to September) DOL published the determination under."},"case_number":{"type":"string","description":"DOL's case number: `A-23043-00641` on the form used until 2023, `G-100-25273-349207` on the revised one."},"form":{"type":"string","enum":["9089","9089_2023"],"description":"`9089` for the ETA-9089 used until 2023 (fiscal years 2008 to 2024), `9089_2023` for the revised form filed from June 2023."},"case_status":{"type":"string","description":"`Certified`, `Certified - Expired`, `Withdrawn` or `Denied`."},"received_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"decision_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"decision_dates":{"type":"array","items":{"type":"string"},"description":"Every decision date DOL's file lists for the case, oldest first: two only for a few cases DOL lists twice."},"employer":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"trade_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter code where the filing names a US state."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"fein":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nine digits (published from fiscal year 2024)."},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"employees":{"anyOf":[{"type":"integer"},{"type":"null"}]},"year_commenced":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The year the employer began business."},"worker_ownership_interest":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The worker has an ownership interest in the employer."},"relationship_to_worker":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"A familial relationship between the owners and the worker (revised form)."}},"required":["name","trade_name","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","fein","naics_code","employees","year_commenced","worker_ownership_interest","relationship_to_worker"]},"employer_contact":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The form used until 2023 gives one name field."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","last_name","first_name","middle_name","job_title","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","email"]},"agent_attorney":{"type":"object","properties":{"representative_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Attorney`, `Agent` or `None` (revised form)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The form used until 2023 gives one name field."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"law_firm":{"anyOf":[{"type":"string"},{"type":"null"}]},"law_firm_fein":{"anyOf":[{"type":"string"},{"type":"null"}]},"state_bar_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"good_standing_state":{"anyOf":[{"type":"string"},{"type":"null"}]},"good_standing_court":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["representative_type","name","last_name","first_name","middle_name","law_firm","law_firm_fein","state_bar_number","good_standing_state","good_standing_court","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","email"]},"job":{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"soc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The occupation's SOC code, e.g. `15-1252.00`."},"soc_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"occupation_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Professional occupation`, `Non-professional`, `College/University Teacher`, `Schedule A` and others (revised form)."}},"required":["title","soc_code","soc_title","occupation_type"]},"wage":{"type":"object","properties":{"offer_from":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The offered wage, US dollars per `offer_unit`."},"offer_to":{"anyOf":[{"type":"number"},{"type":"null"}]},"offer_unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"offer_conditions":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage":{"anyOf":[{"type":"number"},{"type":"null"}]},"prevailing_wage_unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_level":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_source":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_source_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_tracking_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_determined_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_expires_on":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["offer_from","offer_to","offer_unit","offer_conditions","prevailing_wage","prevailing_wage_unit","prevailing_wage_level","prevailing_wage_source","prevailing_wage_source_other","prevailing_wage_tracking_number","prevailing_wage_determined_on","prevailing_wage_expires_on"]},"worksite":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter code where the filing names a US state."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"bls_area":{"anyOf":[{"type":"string"},{"type":"null"}]},"multiple_locations":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["type","address_1","address_2","city","county","state","postal_code","bls_area","multiple_locations"]},"worker":{"type":"object","properties":{"country_of_citizenship":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As DOL writes it, e.g. `INDIA`."},"birth_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"class_of_admission":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's current visa, e.g. `H-1B`."},"education":{"anyOf":[{"type":"string"},{"type":"null"}]},"education_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"major":{"anyOf":[{"type":"string"},{"type":"null"}]},"education_completed_year":{"anyOf":[{"type":"integer"},{"type":"null"}]},"institution":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_city":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_state":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"currently_employed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The worker already works for the employer."}},"required":["country_of_citizenship","birth_country","class_of_admission","education","education_other","major","education_completed_year","institution","institution_address_1","institution_address_2","institution_city","institution_state","institution_country","institution_postal_code","currently_employed"],"description":"The foreign worker, on the form used until 2023; the revised form moved the worker to an appendix DOL does not publish, so every field is null there."},"preparer":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"law_firm":{"anyOf":[{"type":"string"},{"type":"null"}]},"law_firm_fein":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","title","last_name","first_name","middle_name","email","law_firm","law_firm_fein"]},"answers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]},"description":"Every other answer on the form, under DOL's column name in lower case (`recr_info_newspaper_name`, `other_req_emp_layoff`): requirements, recruitment, notices and declarations. Text as filed (`Y`, `N`, `N/A`), numbers as numbers, dates as `yyyy-mm-dd`; a question left blank is absent."},"source_file":{"type":"string","description":"The DOL disclosure file the row was read from."}},"required":["id","fiscal_year","case_number","form","case_status","received_date","decision_date","decision_dates","employer","employer_contact","agent_attorney","job","wage","worksite","worker","preparer","answers","source_file"]}}},"required":["as_of","query","employer_fein","case_number","fiscal_year","case_status","soc_code","worksite_state","country_of_citizenship","min_wage","decided_from","decided_to","total","total_is_exact","page","per_page","total_pages","count","cases"]},"DolOflcPermSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DolOflcPermSearchData"}}},"DolOflcPermCaseData":{"type":"object","properties":{"found":{"type":"boolean"},"case_number":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"determinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<fiscal_year>:<case_number>`."},"fiscal_year":{"type":"integer","description":"The federal fiscal year (October to September) DOL published the determination under."},"case_number":{"type":"string","description":"DOL's case number: `A-23043-00641` on the form used until 2023, `G-100-25273-349207` on the revised one."},"form":{"type":"string","enum":["9089","9089_2023"],"description":"`9089` for the ETA-9089 used until 2023 (fiscal years 2008 to 2024), `9089_2023` for the revised form filed from June 2023."},"case_status":{"type":"string","description":"`Certified`, `Certified - Expired`, `Withdrawn` or `Denied`."},"received_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"decision_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"decision_dates":{"type":"array","items":{"type":"string"},"description":"Every decision date DOL's file lists for the case, oldest first: two only for a few cases DOL lists twice."},"employer":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"trade_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter code where the filing names a US state."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"fein":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nine digits (published from fiscal year 2024)."},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"employees":{"anyOf":[{"type":"integer"},{"type":"null"}]},"year_commenced":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The year the employer began business."},"worker_ownership_interest":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The worker has an ownership interest in the employer."},"relationship_to_worker":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"A familial relationship between the owners and the worker (revised form)."}},"required":["name","trade_name","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","fein","naics_code","employees","year_commenced","worker_ownership_interest","relationship_to_worker"]},"employer_contact":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The form used until 2023 gives one name field."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","last_name","first_name","middle_name","job_title","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","email"]},"agent_attorney":{"type":"object","properties":{"representative_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Attorney`, `Agent` or `None` (revised form)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The form used until 2023 gives one name field."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"law_firm":{"anyOf":[{"type":"string"},{"type":"null"}]},"law_firm_fein":{"anyOf":[{"type":"string"},{"type":"null"}]},"state_bar_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"good_standing_state":{"anyOf":[{"type":"string"},{"type":"null"}]},"good_standing_court":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone_ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["representative_type","name","last_name","first_name","middle_name","law_firm","law_firm_fein","state_bar_number","good_standing_state","good_standing_court","address_1","address_2","city","state","postal_code","country","province","phone","phone_ext","email"]},"job":{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"soc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The occupation's SOC code, e.g. `15-1252.00`."},"soc_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"occupation_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Professional occupation`, `Non-professional`, `College/University Teacher`, `Schedule A` and others (revised form)."}},"required":["title","soc_code","soc_title","occupation_type"]},"wage":{"type":"object","properties":{"offer_from":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The offered wage, US dollars per `offer_unit`."},"offer_to":{"anyOf":[{"type":"number"},{"type":"null"}]},"offer_unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"offer_conditions":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage":{"anyOf":[{"type":"number"},{"type":"null"}]},"prevailing_wage_unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_level":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_source":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_source_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_tracking_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_determined_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"prevailing_wage_expires_on":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["offer_from","offer_to","offer_unit","offer_conditions","prevailing_wage","prevailing_wage_unit","prevailing_wage_level","prevailing_wage_source","prevailing_wage_source_other","prevailing_wage_tracking_number","prevailing_wage_determined_on","prevailing_wage_expires_on"]},"worksite":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Two-letter code where the filing names a US state."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"bls_area":{"anyOf":[{"type":"string"},{"type":"null"}]},"multiple_locations":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["type","address_1","address_2","city","county","state","postal_code","bls_area","multiple_locations"]},"worker":{"type":"object","properties":{"country_of_citizenship":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As DOL writes it, e.g. `INDIA`."},"birth_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"class_of_admission":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The worker's current visa, e.g. `H-1B`."},"education":{"anyOf":[{"type":"string"},{"type":"null"}]},"education_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"major":{"anyOf":[{"type":"string"},{"type":"null"}]},"education_completed_year":{"anyOf":[{"type":"integer"},{"type":"null"}]},"institution":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_city":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_state":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"institution_postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"currently_employed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The worker already works for the employer."}},"required":["country_of_citizenship","birth_country","class_of_admission","education","education_other","major","education_completed_year","institution","institution_address_1","institution_address_2","institution_city","institution_state","institution_country","institution_postal_code","currently_employed"],"description":"The foreign worker, on the form used until 2023; the revised form moved the worker to an appendix DOL does not publish, so every field is null there."},"preparer":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"law_firm":{"anyOf":[{"type":"string"},{"type":"null"}]},"law_firm_fein":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","title","last_name","first_name","middle_name","email","law_firm","law_firm_fein"]},"answers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]},"description":"Every other answer on the form, under DOL's column name in lower case (`recr_info_newspaper_name`, `other_req_emp_layoff`): requirements, recruitment, notices and declarations. Text as filed (`Y`, `N`, `N/A`), numbers as numbers, dates as `yyyy-mm-dd`; a question left blank is absent."},"source_file":{"type":"string","description":"The DOL disclosure file the row was read from."}},"required":["id","fiscal_year","case_number","form","case_status","received_date","decision_date","decision_dates","employer","employer_contact","agent_attorney","job","wage","worksite","worker","preparer","answers","source_file"]},"description":"Every determination of the case, newest fiscal year first: a case decided again in a later fiscal year is a determination of its own."}},"required":["found","case_number","as_of","determinations"]},"DolOflcPermCaseResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DolOflcPermCaseData"}}},"SecCrowdfundingSearchData":{"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"}]},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"form_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"intermediary_cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"min_target_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"filed_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"filings":{"type":"array","items":{"type":"object","properties":{"accession_number":{"type":"string","description":"EDGAR's accession number, the key of the filing."},"form_type":{"type":"string","description":"`C` (an offering), `C/A` (its amendment), `C-U` (a progress update), `C-AR` (an annual report), `C-AR/A`, `C-TR` (termination of reporting), or a withdrawal (`C-W`, `C/A-W`, `C-U-W`, `C-AR-W`, `C-TR-W`)."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an annual report, the last day of the fiscal year it covers."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The offering's SEC file number (`020-`): every filing of one offering shares it; an annual report is filed under one of the issuer's."},"issuer_cik":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer's EDGAR CIK, without leading zeros."},"issuer":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Corporation`, `Limited Liability Company`, `Limited Partnership`, ..."},"legal_status_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the issuer is organized, as EDGAR codes it."},"incorporated_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`."},"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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or country of the issuer's address, as EDGAR codes it."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","zip_code"]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","legal_status","legal_status_other","jurisdiction","incorporated_on","address","website"]},"has_co_issuers":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The offering has co-issuers (reported since 2021); null on filings before."},"co_issuers":{"type":"array","items":{"type":"object","properties":{"is_edgar_filer":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_status_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"incorporated_on":{"anyOf":[{"type":"string"},{"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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"EDGAR's code: a two-letter US state, or a code for a country or province."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","zip_code"]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["is_edgar_filer","cik","name","legal_status","legal_status_other","jurisdiction","incorporated_on","address","website"]}},"co_issuer_names":{"type":"array","items":{"type":"string"},"description":"Every co-issuer's name, for search."},"intermediary":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The funding portal or broker-dealer the offering runs through."},"cik":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The intermediary's EDGAR CIK."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string","enum":["funding_portal","broker_dealer"]},{"type":"null"}],"description":"From its file number: `007-` a funding portal, `008-` a broker-dealer."}},"required":["name","cik","file_number","crd_number","kind"]},"is_material_amendment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"An amendment investors must reconfirm their commitments for."},"amendment_nature":{"anyOf":[{"type":"string"},{"type":"null"}]},"progress_update":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"On a C-U: how the offering is going, in the issuer's words."},"offering":{"type":"object","properties":{"compensation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the intermediary is paid."},"financial_interest":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Any interest the intermediary holds in the issuer."},"security_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Common Stock`, `Preferred Stock`, `Debt`, or `Other` (SAFEs, convertible notes)."},"security_type_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"securities_offered":{"anyOf":[{"type":"number"},{"type":"null"}]},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars per security."},"price_method":{"anyOf":[{"type":"string"},{"type":"null"}]},"target_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The target offering amount, US dollars."},"oversubscription_accepted":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"oversubscription_allocation":{"anyOf":[{"type":"string"},{"type":"null"}]},"oversubscription_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"maximum_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The most the offering will accept, US dollars."},"deadline_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the offering must reach its target by."}},"required":["compensation","financial_interest","security_type","security_type_other","securities_offered","price","price_method","target_amount","oversubscription_accepted","oversubscription_allocation","oversubscription_description","maximum_amount","deadline_on"]},"financials":{"type":"object","properties":{"employees":{"anyOf":[{"type":"number"},{"type":"null"}]},"most_recent":{"type":"object","properties":{"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_receivable":{"anyOf":[{"type":"number"},{"type":"null"}]},"short_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"long_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Revenue in the most recent fiscal year, US dollars."},"cost_of_goods_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"taxes_paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["total_assets","cash","accounts_receivable","short_term_debt","long_term_debt","revenue","cost_of_goods_sold","taxes_paid","net_income"]},"prior":{"type":"object","properties":{"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_receivable":{"anyOf":[{"type":"number"},{"type":"null"}]},"short_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"long_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_of_goods_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"taxes_paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["total_assets","cash","accounts_receivable","short_term_debt","long_term_debt","revenue","cost_of_goods_sold","taxes_paid","net_income"]}},"required":["employees","most_recent","prior"]},"jurisdictions":{"type":"array","items":{"type":"string"},"description":"The states and countries the securities are offered in."},"issuer_signature":{"anyOf":[{"type":"object","properties":{"issuer":{"anyOf":[{"type":"string"},{"type":"null"}]},"signer":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["issuer","signer","title"]},{"type":"null"}]},"signers":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"signed_on":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","title","signed_on"]},"description":"The officers and directors who signed."},"signer_names":{"type":"array","items":{"type":"string"},"description":"Every signer's name, for search."},"filing_url":{"type":"string","description":"The filing on EDGAR."},"documents_status":{"type":"string","enum":["stored","partial","unavailable","pending"],"description":"`stored` (every document is kept), `partial` or `unavailable` (EDGAR has not served every one yet; the next read retries), `pending` (not read yet)."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name EDGAR gives it."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When EDGAR last wrote the file, as EDGAR lists it (`yyyy-mm-dd hh:mm:ss`, Eastern time)."},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the file is, read from its bytes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our byte-identical copy; null while it could not be read."},"source_document_url":{"type":"string","description":"The file on EDGAR."}},"required":["name","bytes","modified_at","content_type","document_url","source_document_url"]},"description":"Every document of the filing: our byte-identical copy (`document_url`) and EDGAR's (`source_document_url`)."}},"required":["accession_number","form_type","filed_on","period","file_number","issuer_cik","issuer","has_co_issuers","co_issuers","co_issuer_names","intermediary","is_material_amendment","amendment_nature","progress_update","offering","financials","jurisdictions","issuer_signature","signers","signer_names","filing_url","documents_status","documents"]}}},"required":["as_of","query","issuer_cik","file_number","form_type","state","intermediary_cik","min_revenue","min_target_amount","filed_from","filed_to","total","total_is_exact","page","per_page","total_pages","count","filings"]},"SecCrowdfundingSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecCrowdfundingSearchData"}}},"SecCrowdfundingFilingData":{"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, the key of the filing."},"form_type":{"type":"string","description":"`C` (an offering), `C/A` (its amendment), `C-U` (a progress update), `C-AR` (an annual report), `C-AR/A`, `C-TR` (termination of reporting), or a withdrawal (`C-W`, `C/A-W`, `C-U-W`, `C-AR-W`, `C-TR-W`)."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an annual report, the last day of the fiscal year it covers."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The offering's SEC file number (`020-`): every filing of one offering shares it; an annual report is filed under one of the issuer's."},"issuer_cik":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer's EDGAR CIK, without leading zeros."},"issuer":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Corporation`, `Limited Liability Company`, `Limited Partnership`, ..."},"legal_status_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the issuer is organized, as EDGAR codes it."},"incorporated_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`."},"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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or country of the issuer's address, as EDGAR codes it."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","zip_code"]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","legal_status","legal_status_other","jurisdiction","incorporated_on","address","website"]},"has_co_issuers":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The offering has co-issuers (reported since 2021); null on filings before."},"co_issuers":{"type":"array","items":{"type":"object","properties":{"is_edgar_filer":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_status_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"incorporated_on":{"anyOf":[{"type":"string"},{"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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"EDGAR's code: a two-letter US state, or a code for a country or province."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","zip_code"]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["is_edgar_filer","cik","name","legal_status","legal_status_other","jurisdiction","incorporated_on","address","website"]}},"co_issuer_names":{"type":"array","items":{"type":"string"},"description":"Every co-issuer's name, for search."},"intermediary":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The funding portal or broker-dealer the offering runs through."},"cik":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The intermediary's EDGAR CIK."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string","enum":["funding_portal","broker_dealer"]},{"type":"null"}],"description":"From its file number: `007-` a funding portal, `008-` a broker-dealer."}},"required":["name","cik","file_number","crd_number","kind"]},"is_material_amendment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"An amendment investors must reconfirm their commitments for."},"amendment_nature":{"anyOf":[{"type":"string"},{"type":"null"}]},"progress_update":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"On a C-U: how the offering is going, in the issuer's words."},"offering":{"type":"object","properties":{"compensation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the intermediary is paid."},"financial_interest":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Any interest the intermediary holds in the issuer."},"security_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Common Stock`, `Preferred Stock`, `Debt`, or `Other` (SAFEs, convertible notes)."},"security_type_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"securities_offered":{"anyOf":[{"type":"number"},{"type":"null"}]},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars per security."},"price_method":{"anyOf":[{"type":"string"},{"type":"null"}]},"target_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The target offering amount, US dollars."},"oversubscription_accepted":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"oversubscription_allocation":{"anyOf":[{"type":"string"},{"type":"null"}]},"oversubscription_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"maximum_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The most the offering will accept, US dollars."},"deadline_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the offering must reach its target by."}},"required":["compensation","financial_interest","security_type","security_type_other","securities_offered","price","price_method","target_amount","oversubscription_accepted","oversubscription_allocation","oversubscription_description","maximum_amount","deadline_on"]},"financials":{"type":"object","properties":{"employees":{"anyOf":[{"type":"number"},{"type":"null"}]},"most_recent":{"type":"object","properties":{"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_receivable":{"anyOf":[{"type":"number"},{"type":"null"}]},"short_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"long_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Revenue in the most recent fiscal year, US dollars."},"cost_of_goods_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"taxes_paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["total_assets","cash","accounts_receivable","short_term_debt","long_term_debt","revenue","cost_of_goods_sold","taxes_paid","net_income"]},"prior":{"type":"object","properties":{"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_receivable":{"anyOf":[{"type":"number"},{"type":"null"}]},"short_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"long_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_of_goods_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"taxes_paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["total_assets","cash","accounts_receivable","short_term_debt","long_term_debt","revenue","cost_of_goods_sold","taxes_paid","net_income"]}},"required":["employees","most_recent","prior"]},"jurisdictions":{"type":"array","items":{"type":"string"},"description":"The states and countries the securities are offered in."},"issuer_signature":{"anyOf":[{"type":"object","properties":{"issuer":{"anyOf":[{"type":"string"},{"type":"null"}]},"signer":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["issuer","signer","title"]},{"type":"null"}]},"signers":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"signed_on":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","title","signed_on"]},"description":"The officers and directors who signed."},"signer_names":{"type":"array","items":{"type":"string"},"description":"Every signer's name, for search."},"filing_url":{"type":"string","description":"The filing on EDGAR."},"documents_status":{"type":"string","enum":["stored","partial","unavailable","pending"],"description":"`stored` (every document is kept), `partial` or `unavailable` (EDGAR has not served every one yet; the next read retries), `pending` (not read yet)."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name EDGAR gives it."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When EDGAR last wrote the file, as EDGAR lists it (`yyyy-mm-dd hh:mm:ss`, Eastern time)."},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the file is, read from its bytes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our byte-identical copy; null while it could not be read."},"source_document_url":{"type":"string","description":"The file on EDGAR."}},"required":["name","bytes","modified_at","content_type","document_url","source_document_url"]},"description":"Every document of the filing: our byte-identical copy (`document_url`) and EDGAR's (`source_document_url`)."}},"required":["accession_number","form_type","filed_on","period","file_number","issuer_cik","issuer","has_co_issuers","co_issuers","co_issuer_names","intermediary","is_material_amendment","amendment_nature","progress_update","offering","financials","jurisdictions","issuer_signature","signers","signer_names","filing_url","documents_status","documents"]},{"type":"null"}]}},"required":["found","accession_number","as_of","filing"]},"SecCrowdfundingFilingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecCrowdfundingFilingData"}}},"SecCrowdfundingOfferingData":{"type":"object","properties":{"found":{"type":"boolean"},"file_number":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"filings":{"type":"array","items":{"type":"object","properties":{"accession_number":{"type":"string","description":"EDGAR's accession number, the key of the filing."},"form_type":{"type":"string","description":"`C` (an offering), `C/A` (its amendment), `C-U` (a progress update), `C-AR` (an annual report), `C-AR/A`, `C-TR` (termination of reporting), or a withdrawal (`C-W`, `C/A-W`, `C-U-W`, `C-AR-W`, `C-TR-W`)."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an annual report, the last day of the fiscal year it covers."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The offering's SEC file number (`020-`): every filing of one offering shares it; an annual report is filed under one of the issuer's."},"issuer_cik":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer's EDGAR CIK, without leading zeros."},"issuer":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Corporation`, `Limited Liability Company`, `Limited Partnership`, ..."},"legal_status_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the issuer is organized, as EDGAR codes it."},"incorporated_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd`."},"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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or country of the issuer's address, as EDGAR codes it."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","zip_code"]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","legal_status","legal_status_other","jurisdiction","incorporated_on","address","website"]},"has_co_issuers":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The offering has co-issuers (reported since 2021); null on filings before."},"co_issuers":{"type":"array","items":{"type":"object","properties":{"is_edgar_filer":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_status_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"incorporated_on":{"anyOf":[{"type":"string"},{"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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"EDGAR's code: a two-letter US state, or a code for a country or province."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","zip_code"]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["is_edgar_filer","cik","name","legal_status","legal_status_other","jurisdiction","incorporated_on","address","website"]}},"co_issuer_names":{"type":"array","items":{"type":"string"},"description":"Every co-issuer's name, for search."},"intermediary":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The funding portal or broker-dealer the offering runs through."},"cik":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The intermediary's EDGAR CIK."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string","enum":["funding_portal","broker_dealer"]},{"type":"null"}],"description":"From its file number: `007-` a funding portal, `008-` a broker-dealer."}},"required":["name","cik","file_number","crd_number","kind"]},"is_material_amendment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"An amendment investors must reconfirm their commitments for."},"amendment_nature":{"anyOf":[{"type":"string"},{"type":"null"}]},"progress_update":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"On a C-U: how the offering is going, in the issuer's words."},"offering":{"type":"object","properties":{"compensation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the intermediary is paid."},"financial_interest":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Any interest the intermediary holds in the issuer."},"security_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Common Stock`, `Preferred Stock`, `Debt`, or `Other` (SAFEs, convertible notes)."},"security_type_other":{"anyOf":[{"type":"string"},{"type":"null"}]},"securities_offered":{"anyOf":[{"type":"number"},{"type":"null"}]},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"US dollars per security."},"price_method":{"anyOf":[{"type":"string"},{"type":"null"}]},"target_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The target offering amount, US dollars."},"oversubscription_accepted":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"oversubscription_allocation":{"anyOf":[{"type":"string"},{"type":"null"}]},"oversubscription_description":{"anyOf":[{"type":"string"},{"type":"null"}]},"maximum_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The most the offering will accept, US dollars."},"deadline_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the offering must reach its target by."}},"required":["compensation","financial_interest","security_type","security_type_other","securities_offered","price","price_method","target_amount","oversubscription_accepted","oversubscription_allocation","oversubscription_description","maximum_amount","deadline_on"]},"financials":{"type":"object","properties":{"employees":{"anyOf":[{"type":"number"},{"type":"null"}]},"most_recent":{"type":"object","properties":{"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_receivable":{"anyOf":[{"type":"number"},{"type":"null"}]},"short_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"long_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Revenue in the most recent fiscal year, US dollars."},"cost_of_goods_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"taxes_paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["total_assets","cash","accounts_receivable","short_term_debt","long_term_debt","revenue","cost_of_goods_sold","taxes_paid","net_income"]},"prior":{"type":"object","properties":{"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"cash":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_receivable":{"anyOf":[{"type":"number"},{"type":"null"}]},"short_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"long_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_of_goods_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"taxes_paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["total_assets","cash","accounts_receivable","short_term_debt","long_term_debt","revenue","cost_of_goods_sold","taxes_paid","net_income"]}},"required":["employees","most_recent","prior"]},"jurisdictions":{"type":"array","items":{"type":"string"},"description":"The states and countries the securities are offered in."},"issuer_signature":{"anyOf":[{"type":"object","properties":{"issuer":{"anyOf":[{"type":"string"},{"type":"null"}]},"signer":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["issuer","signer","title"]},{"type":"null"}]},"signers":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"signed_on":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","title","signed_on"]},"description":"The officers and directors who signed."},"signer_names":{"type":"array","items":{"type":"string"},"description":"Every signer's name, for search."},"filing_url":{"type":"string","description":"The filing on EDGAR."},"documents_status":{"type":"string","enum":["stored","partial","unavailable","pending"],"description":"`stored` (every document is kept), `partial` or `unavailable` (EDGAR has not served every one yet; the next read retries), `pending` (not read yet)."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name EDGAR gives it."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When EDGAR last wrote the file, as EDGAR lists it (`yyyy-mm-dd hh:mm:ss`, Eastern time)."},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the file is, read from its bytes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our byte-identical copy; null while it could not be read."},"source_document_url":{"type":"string","description":"The file on EDGAR."}},"required":["name","bytes","modified_at","content_type","document_url","source_document_url"]},"description":"Every document of the filing: our byte-identical copy (`document_url`) and EDGAR's (`source_document_url`)."}},"required":["accession_number","form_type","filed_on","period","file_number","issuer_cik","issuer","has_co_issuers","co_issuers","co_issuer_names","intermediary","is_material_amendment","amendment_nature","progress_update","offering","financials","jurisdictions","issuer_signature","signers","signer_names","filing_url","documents_status","documents"]},"description":"Every filing of the offering, oldest first: the offering, its amendments, progress updates, annual reports, termination."}},"required":["found","file_number","as_of","filings"]},"SecCrowdfundingOfferingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecCrowdfundingOfferingData"}}},"SecRegASearchData":{"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"}]},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"form_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"anyOf":[{"type":"string"},{"type":"null"}]},"min_total_offering":{"anyOf":[{"type":"number"},{"type":"null"}]},"filed_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"filings":{"type":"array","items":{"type":"object","properties":{"accession_number":{"type":"string","description":"EDGAR's accession number, the key of the filing."},"form_type":{"type":"string","description":"`1-A`, `1-A/A`, `1-A POS`, `1-K`, `1-K/A`, `1-Z` or `1-Z/A`."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC file number it is filed under: the offering's (`024-`) for an offering statement, the issuer's reporting number (`24R-`) for a report."},"offering_file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The offering's file number (`024-`) as the filing states it: on amendments and post-qualification amendments; empty on the original 1-A, whose `file_number` carries it."},"draft_file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The draft offering statement's file number, when there was one."},"issuer_cik":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer's EDGAR CIK, without leading zeros."},"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_shell_company":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_successor":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"reporting_period":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuers":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"year_incorporated":{"anyOf":[{"type":"number"},{"type":"null"}]},"sic_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_time_employees":{"anyOf":[{"type":"number"},{"type":"null"}]},"part_time_employees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","cik","jurisdiction","year_incorporated","sic_code","full_time_employees","part_time_employees"]},"description":"The issuer and its co-issuers."},"issuer_names":{"type":"array","items":{"type":"string"},"description":"Every issuer's name, for search."},"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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or country of the issuer's address, as EDGAR codes it."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","zip_code"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who the SEC's staff should contact about the filing."},"industry_group":{"anyOf":[{"type":"string"},{"type":"null"}]},"financials":{"type":"object","properties":{"cash_equivalents":{"anyOf":[{"type":"number"},{"type":"null"}]},"investment_securities":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_investments":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_receivable":{"anyOf":[{"type":"number"},{"type":"null"}]},"loans":{"anyOf":[{"type":"number"},{"type":"null"}]},"property_plant_equipment":{"anyOf":[{"type":"number"},{"type":"null"}]},"property_and_equipment":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_payable":{"anyOf":[{"type":"number"},{"type":"null"}]},"policy_liabilities_and_accruals":{"anyOf":[{"type":"number"},{"type":"null"}]},"deposits":{"anyOf":[{"type":"number"},{"type":"null"}]},"long_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_stockholder_equity":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities_and_equity":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_revenues":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_interest_income":{"anyOf":[{"type":"number"},{"type":"null"}]},"costs_applicable_to_revenues":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_interest_expenses":{"anyOf":[{"type":"number"},{"type":"null"}]},"depreciation_and_amortization":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}]},"earnings_per_share_basic":{"anyOf":[{"type":"number"},{"type":"null"}]},"earnings_per_share_diluted":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["cash_equivalents","investment_securities","total_investments","accounts_receivable","loans","property_plant_equipment","property_and_equipment","total_assets","accounts_payable","policy_liabilities_and_accruals","deposits","long_term_debt","total_liabilities","total_stockholder_equity","total_liabilities_and_equity","total_revenues","total_interest_income","costs_applicable_to_revenues","total_interest_expenses","depreciation_and_amortization","net_income","earnings_per_share_basic","earnings_per_share_diluted"],"description":"From the offering statement's balance sheet and income statement, US dollars."},"auditor":{"anyOf":[{"type":"string"},{"type":"null"}]},"certifications":{"type":"object","properties":{"eligible":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"not_disqualified":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"bad_actor_disclosure":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"no_jurisdictions":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"same_jurisdictions":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"no_unregistered_sales":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"securities_act_exemption":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["eligible","not_disqualified","bad_actor_disclosure","no_jurisdictions","same_jurisdictions","no_unregistered_sales","securities_act_exemption"]},"offering":{"type":"object","properties":{"tier":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Tier1` or `Tier2`."},"audit_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"delayed_or_continuous":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"within_one_year":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"after_qualification":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"best_efforts":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"solicitation_proposed":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"resale_by_affiliates":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"securities_offered":{"anyOf":[{"type":"number"},{"type":"null"}]},"outstanding_securities":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_per_security":{"anyOf":[{"type":"number"},{"type":"null"}]},"issuer_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"security_holder_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"qualification_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"concurrent_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The whole offering, US dollars."},"providers":{"type":"object","properties":{"underwriter":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"sales_commissions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"finders":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"auditor":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"legal":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"promoters":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"blue_sky":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]}},"required":["underwriter","sales_commissions","finders","auditor","legal","promoters","blue_sky"]},"broker_dealer_crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"estimated_net_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"clarification":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["tier","audit_status","delayed_or_continuous","within_one_year","after_qualification","best_efforts","solicitation_proposed","resale_by_affiliates","securities_offered","outstanding_securities","price_per_security","issuer_aggregate","security_holder_aggregate","qualification_aggregate","concurrent_aggregate","total_aggregate","providers","broker_dealer_crd_number","estimated_net_amount","clarification"]},"securities_offered_types":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"other_description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","other_description"]}},"securities_outstanding":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"outstanding":{"anyOf":[{"type":"number"},{"type":"null"}]},"cusip":{"anyOf":[{"type":"string"},{"type":"null"}]},"publicly_traded":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","name","outstanding","cusip","publicly_traded"]}},"unregistered_sales":{"type":"array","items":{"type":"object","properties":{"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"total_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"principal_holders_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"aggregate_amount":{"anyOf":[{"type":"string"},{"type":"null"}]},"consideration_basis":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["issuer_name","title","total_amount","principal_holders_amount","aggregate_amount","consideration_basis"]},"description":"Securities sold in the past year without registration."},"issue_jurisdictions":{"type":"array","items":{"type":"string"}},"dealer_jurisdictions":{"type":"array","items":{"type":"string"}},"report":{"anyOf":[{"type":"object","properties":{"form_indication":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_year_end":{"anyOf":[{"type":"string"},{"type":"null"}]},"rule_257":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["form_indication","fiscal_year_end","rule_257"]},{"type":"null"}],"description":"On a 1-K or 1-Z."},"securities_reported":{"type":"array","items":{"type":"string"},"description":"On a 1-K: the securities it reports on."},"offerings_reported":{"type":"array","items":{"type":"object","properties":{"commission_file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualified_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"commenced_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"commenced_on_as_filed":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualified_securities_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"offering_securities_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"sold_by_issuer":{"anyOf":[{"type":"number"},{"type":"null"}]},"sold_by_security_holders":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_per_security":{"anyOf":[{"type":"number"},{"type":"null"}]},"aggregate_price":{"anyOf":[{"type":"number"},{"type":"null"}]},"aggregate_price_security_holders":{"anyOf":[{"type":"number"},{"type":"null"}]},"fees":{"type":"object","properties":{"underwriter":{"anyOf":[{"type":"number"},{"type":"null"}]},"sales_commissions":{"anyOf":[{"type":"number"},{"type":"null"}]},"finders":{"anyOf":[{"type":"number"},{"type":"null"}]},"auditor":{"anyOf":[{"type":"number"},{"type":"null"}]},"legal":{"anyOf":[{"type":"number"},{"type":"null"}]},"promoters":{"anyOf":[{"type":"number"},{"type":"null"}]},"blue_sky":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["underwriter","sales_commissions","finders","auditor","legal","promoters","blue_sky"]},"broker_dealer_crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer_net_proceeds":{"anyOf":[{"type":"number"},{"type":"null"}]},"clarification":{"anyOf":[{"type":"string"},{"type":"null"}]},"service_providers":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","name"]}}},"required":["commission_file_number","qualified_on","commenced_on","commenced_on_as_filed","qualified_securities_sold","offering_securities_sold","sold_by_issuer","sold_by_security_holders","price_per_security","aggregate_price","aggregate_price_security_holders","fees","broker_dealer_crd_number","issuer_net_proceeds","clarification","service_providers"]},"description":"On a 1-K or 1-Z: what each offering sold and raised."},"reported_offering_file_numbers":{"type":"array","items":{"type":"string"},"description":"The offerings (`024-`) a report covers."},"suspension_certifications":{"type":"array","items":{"type":"object","properties":{"class_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"approximate_record_holders":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["class_title","file_number","approximate_record_holders"]}},"signatures":{"type":"array","items":{"type":"object","properties":{"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer_name_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"signed_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"signed_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["cik","issuer_name","issuer_name_2","signed_by","signed_on","title"]}},"filing_url":{"type":"string","description":"The filing on EDGAR."},"documents_status":{"type":"string","enum":["stored","partial","unavailable","pending"],"description":"`stored` (every document is kept), `partial` or `unavailable` (EDGAR has not served every one yet; the next read retries), `pending` (not read yet)."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name EDGAR gives it."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When EDGAR last wrote the file, as EDGAR lists it (`yyyy-mm-dd hh:mm:ss`, Eastern time)."},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the file is, read from its bytes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our byte-identical copy; null while it could not be read."},"source_document_url":{"type":"string","description":"The file on EDGAR."}},"required":["name","bytes","modified_at","content_type","document_url","source_document_url"]},"description":"Every document of the filing: our byte-identical copy (`document_url`) and EDGAR's (`source_document_url`)."}},"required":["accession_number","form_type","filed_on","file_number","offering_file_number","draft_file_number","issuer_cik","issuer_name","is_shell_company","is_successor","reporting_period","issuers","issuer_names","address","phone","contact_name","industry_group","financials","auditor","certifications","offering","securities_offered_types","securities_outstanding","unregistered_sales","issue_jurisdictions","dealer_jurisdictions","report","securities_reported","offerings_reported","reported_offering_file_numbers","suspension_certifications","signatures","filing_url","documents_status","documents"]}}},"required":["as_of","query","issuer_cik","file_number","form_type","state","tier","min_total_offering","filed_from","filed_to","total","total_is_exact","page","per_page","total_pages","count","filings"]},"SecRegASearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecRegASearchData"}}},"SecRegAFilingData":{"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, the key of the filing."},"form_type":{"type":"string","description":"`1-A`, `1-A/A`, `1-A POS`, `1-K`, `1-K/A`, `1-Z` or `1-Z/A`."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC file number it is filed under: the offering's (`024-`) for an offering statement, the issuer's reporting number (`24R-`) for a report."},"offering_file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The offering's file number (`024-`) as the filing states it: on amendments and post-qualification amendments; empty on the original 1-A, whose `file_number` carries it."},"draft_file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The draft offering statement's file number, when there was one."},"issuer_cik":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer's EDGAR CIK, without leading zeros."},"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_shell_company":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_successor":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"reporting_period":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuers":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"year_incorporated":{"anyOf":[{"type":"number"},{"type":"null"}]},"sic_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_time_employees":{"anyOf":[{"type":"number"},{"type":"null"}]},"part_time_employees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","cik","jurisdiction","year_incorporated","sic_code","full_time_employees","part_time_employees"]},"description":"The issuer and its co-issuers."},"issuer_names":{"type":"array","items":{"type":"string"},"description":"Every issuer's name, for search."},"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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or country of the issuer's address, as EDGAR codes it."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","zip_code"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who the SEC's staff should contact about the filing."},"industry_group":{"anyOf":[{"type":"string"},{"type":"null"}]},"financials":{"type":"object","properties":{"cash_equivalents":{"anyOf":[{"type":"number"},{"type":"null"}]},"investment_securities":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_investments":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_receivable":{"anyOf":[{"type":"number"},{"type":"null"}]},"loans":{"anyOf":[{"type":"number"},{"type":"null"}]},"property_plant_equipment":{"anyOf":[{"type":"number"},{"type":"null"}]},"property_and_equipment":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_payable":{"anyOf":[{"type":"number"},{"type":"null"}]},"policy_liabilities_and_accruals":{"anyOf":[{"type":"number"},{"type":"null"}]},"deposits":{"anyOf":[{"type":"number"},{"type":"null"}]},"long_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_stockholder_equity":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities_and_equity":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_revenues":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_interest_income":{"anyOf":[{"type":"number"},{"type":"null"}]},"costs_applicable_to_revenues":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_interest_expenses":{"anyOf":[{"type":"number"},{"type":"null"}]},"depreciation_and_amortization":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}]},"earnings_per_share_basic":{"anyOf":[{"type":"number"},{"type":"null"}]},"earnings_per_share_diluted":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["cash_equivalents","investment_securities","total_investments","accounts_receivable","loans","property_plant_equipment","property_and_equipment","total_assets","accounts_payable","policy_liabilities_and_accruals","deposits","long_term_debt","total_liabilities","total_stockholder_equity","total_liabilities_and_equity","total_revenues","total_interest_income","costs_applicable_to_revenues","total_interest_expenses","depreciation_and_amortization","net_income","earnings_per_share_basic","earnings_per_share_diluted"],"description":"From the offering statement's balance sheet and income statement, US dollars."},"auditor":{"anyOf":[{"type":"string"},{"type":"null"}]},"certifications":{"type":"object","properties":{"eligible":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"not_disqualified":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"bad_actor_disclosure":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"no_jurisdictions":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"same_jurisdictions":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"no_unregistered_sales":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"securities_act_exemption":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["eligible","not_disqualified","bad_actor_disclosure","no_jurisdictions","same_jurisdictions","no_unregistered_sales","securities_act_exemption"]},"offering":{"type":"object","properties":{"tier":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Tier1` or `Tier2`."},"audit_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"delayed_or_continuous":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"within_one_year":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"after_qualification":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"best_efforts":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"solicitation_proposed":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"resale_by_affiliates":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"securities_offered":{"anyOf":[{"type":"number"},{"type":"null"}]},"outstanding_securities":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_per_security":{"anyOf":[{"type":"number"},{"type":"null"}]},"issuer_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"security_holder_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"qualification_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"concurrent_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The whole offering, US dollars."},"providers":{"type":"object","properties":{"underwriter":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"sales_commissions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"finders":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"auditor":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"legal":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"promoters":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"blue_sky":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]}},"required":["underwriter","sales_commissions","finders","auditor","legal","promoters","blue_sky"]},"broker_dealer_crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"estimated_net_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"clarification":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["tier","audit_status","delayed_or_continuous","within_one_year","after_qualification","best_efforts","solicitation_proposed","resale_by_affiliates","securities_offered","outstanding_securities","price_per_security","issuer_aggregate","security_holder_aggregate","qualification_aggregate","concurrent_aggregate","total_aggregate","providers","broker_dealer_crd_number","estimated_net_amount","clarification"]},"securities_offered_types":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"other_description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","other_description"]}},"securities_outstanding":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"outstanding":{"anyOf":[{"type":"number"},{"type":"null"}]},"cusip":{"anyOf":[{"type":"string"},{"type":"null"}]},"publicly_traded":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","name","outstanding","cusip","publicly_traded"]}},"unregistered_sales":{"type":"array","items":{"type":"object","properties":{"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"total_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"principal_holders_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"aggregate_amount":{"anyOf":[{"type":"string"},{"type":"null"}]},"consideration_basis":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["issuer_name","title","total_amount","principal_holders_amount","aggregate_amount","consideration_basis"]},"description":"Securities sold in the past year without registration."},"issue_jurisdictions":{"type":"array","items":{"type":"string"}},"dealer_jurisdictions":{"type":"array","items":{"type":"string"}},"report":{"anyOf":[{"type":"object","properties":{"form_indication":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_year_end":{"anyOf":[{"type":"string"},{"type":"null"}]},"rule_257":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["form_indication","fiscal_year_end","rule_257"]},{"type":"null"}],"description":"On a 1-K or 1-Z."},"securities_reported":{"type":"array","items":{"type":"string"},"description":"On a 1-K: the securities it reports on."},"offerings_reported":{"type":"array","items":{"type":"object","properties":{"commission_file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualified_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"commenced_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"commenced_on_as_filed":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualified_securities_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"offering_securities_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"sold_by_issuer":{"anyOf":[{"type":"number"},{"type":"null"}]},"sold_by_security_holders":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_per_security":{"anyOf":[{"type":"number"},{"type":"null"}]},"aggregate_price":{"anyOf":[{"type":"number"},{"type":"null"}]},"aggregate_price_security_holders":{"anyOf":[{"type":"number"},{"type":"null"}]},"fees":{"type":"object","properties":{"underwriter":{"anyOf":[{"type":"number"},{"type":"null"}]},"sales_commissions":{"anyOf":[{"type":"number"},{"type":"null"}]},"finders":{"anyOf":[{"type":"number"},{"type":"null"}]},"auditor":{"anyOf":[{"type":"number"},{"type":"null"}]},"legal":{"anyOf":[{"type":"number"},{"type":"null"}]},"promoters":{"anyOf":[{"type":"number"},{"type":"null"}]},"blue_sky":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["underwriter","sales_commissions","finders","auditor","legal","promoters","blue_sky"]},"broker_dealer_crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer_net_proceeds":{"anyOf":[{"type":"number"},{"type":"null"}]},"clarification":{"anyOf":[{"type":"string"},{"type":"null"}]},"service_providers":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","name"]}}},"required":["commission_file_number","qualified_on","commenced_on","commenced_on_as_filed","qualified_securities_sold","offering_securities_sold","sold_by_issuer","sold_by_security_holders","price_per_security","aggregate_price","aggregate_price_security_holders","fees","broker_dealer_crd_number","issuer_net_proceeds","clarification","service_providers"]},"description":"On a 1-K or 1-Z: what each offering sold and raised."},"reported_offering_file_numbers":{"type":"array","items":{"type":"string"},"description":"The offerings (`024-`) a report covers."},"suspension_certifications":{"type":"array","items":{"type":"object","properties":{"class_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"approximate_record_holders":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["class_title","file_number","approximate_record_holders"]}},"signatures":{"type":"array","items":{"type":"object","properties":{"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer_name_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"signed_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"signed_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["cik","issuer_name","issuer_name_2","signed_by","signed_on","title"]}},"filing_url":{"type":"string","description":"The filing on EDGAR."},"documents_status":{"type":"string","enum":["stored","partial","unavailable","pending"],"description":"`stored` (every document is kept), `partial` or `unavailable` (EDGAR has not served every one yet; the next read retries), `pending` (not read yet)."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name EDGAR gives it."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When EDGAR last wrote the file, as EDGAR lists it (`yyyy-mm-dd hh:mm:ss`, Eastern time)."},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the file is, read from its bytes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our byte-identical copy; null while it could not be read."},"source_document_url":{"type":"string","description":"The file on EDGAR."}},"required":["name","bytes","modified_at","content_type","document_url","source_document_url"]},"description":"Every document of the filing: our byte-identical copy (`document_url`) and EDGAR's (`source_document_url`)."}},"required":["accession_number","form_type","filed_on","file_number","offering_file_number","draft_file_number","issuer_cik","issuer_name","is_shell_company","is_successor","reporting_period","issuers","issuer_names","address","phone","contact_name","industry_group","financials","auditor","certifications","offering","securities_offered_types","securities_outstanding","unregistered_sales","issue_jurisdictions","dealer_jurisdictions","report","securities_reported","offerings_reported","reported_offering_file_numbers","suspension_certifications","signatures","filing_url","documents_status","documents"]},{"type":"null"}]}},"required":["found","accession_number","as_of","filing"]},"SecRegAFilingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecRegAFilingData"}}},"SecRegAOfferingData":{"type":"object","properties":{"found":{"type":"boolean"},"file_number":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"filings":{"type":"array","items":{"type":"object","properties":{"accession_number":{"type":"string","description":"EDGAR's accession number, the key of the filing."},"form_type":{"type":"string","description":"`1-A`, `1-A/A`, `1-A POS`, `1-K`, `1-K/A`, `1-Z` or `1-Z/A`."},"filed_on":{"type":"string","description":"`yyyy-mm-dd` EDGAR accepted the filing."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC file number it is filed under: the offering's (`024-`) for an offering statement, the issuer's reporting number (`24R-`) for a report."},"offering_file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The offering's file number (`024-`) as the filing states it: on amendments and post-qualification amendments; empty on the original 1-A, whose `file_number` carries it."},"draft_file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The draft offering statement's file number, when there was one."},"issuer_cik":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer's EDGAR CIK, without leading zeros."},"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_shell_company":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_successor":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"reporting_period":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuers":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"year_incorporated":{"anyOf":[{"type":"number"},{"type":"null"}]},"sic_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_time_employees":{"anyOf":[{"type":"number"},{"type":"null"}]},"part_time_employees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","cik","jurisdiction","year_incorporated","sic_code","full_time_employees","part_time_employees"]},"description":"The issuer and its co-issuers."},"issuer_names":{"type":"array","items":{"type":"string"},"description":"Every issuer's name, for search."},"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_or_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or country of the issuer's address, as EDGAR codes it."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state_or_country","zip_code"]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who the SEC's staff should contact about the filing."},"industry_group":{"anyOf":[{"type":"string"},{"type":"null"}]},"financials":{"type":"object","properties":{"cash_equivalents":{"anyOf":[{"type":"number"},{"type":"null"}]},"investment_securities":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_investments":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_receivable":{"anyOf":[{"type":"number"},{"type":"null"}]},"loans":{"anyOf":[{"type":"number"},{"type":"null"}]},"property_plant_equipment":{"anyOf":[{"type":"number"},{"type":"null"}]},"property_and_equipment":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_assets":{"anyOf":[{"type":"number"},{"type":"null"}]},"accounts_payable":{"anyOf":[{"type":"number"},{"type":"null"}]},"policy_liabilities_and_accruals":{"anyOf":[{"type":"number"},{"type":"null"}]},"deposits":{"anyOf":[{"type":"number"},{"type":"null"}]},"long_term_debt":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_stockholder_equity":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_liabilities_and_equity":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_revenues":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_interest_income":{"anyOf":[{"type":"number"},{"type":"null"}]},"costs_applicable_to_revenues":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_interest_expenses":{"anyOf":[{"type":"number"},{"type":"null"}]},"depreciation_and_amortization":{"anyOf":[{"type":"number"},{"type":"null"}]},"net_income":{"anyOf":[{"type":"number"},{"type":"null"}]},"earnings_per_share_basic":{"anyOf":[{"type":"number"},{"type":"null"}]},"earnings_per_share_diluted":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["cash_equivalents","investment_securities","total_investments","accounts_receivable","loans","property_plant_equipment","property_and_equipment","total_assets","accounts_payable","policy_liabilities_and_accruals","deposits","long_term_debt","total_liabilities","total_stockholder_equity","total_liabilities_and_equity","total_revenues","total_interest_income","costs_applicable_to_revenues","total_interest_expenses","depreciation_and_amortization","net_income","earnings_per_share_basic","earnings_per_share_diluted"],"description":"From the offering statement's balance sheet and income statement, US dollars."},"auditor":{"anyOf":[{"type":"string"},{"type":"null"}]},"certifications":{"type":"object","properties":{"eligible":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"not_disqualified":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"bad_actor_disclosure":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"no_jurisdictions":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"same_jurisdictions":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"no_unregistered_sales":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"securities_act_exemption":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["eligible","not_disqualified","bad_actor_disclosure","no_jurisdictions","same_jurisdictions","no_unregistered_sales","securities_act_exemption"]},"offering":{"type":"object","properties":{"tier":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Tier1` or `Tier2`."},"audit_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"delayed_or_continuous":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"within_one_year":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"after_qualification":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"best_efforts":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"solicitation_proposed":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"resale_by_affiliates":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"securities_offered":{"anyOf":[{"type":"number"},{"type":"null"}]},"outstanding_securities":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_per_security":{"anyOf":[{"type":"number"},{"type":"null"}]},"issuer_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"security_holder_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"qualification_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"concurrent_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_aggregate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The whole offering, US dollars."},"providers":{"type":"object","properties":{"underwriter":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"sales_commissions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"finders":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"auditor":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"legal":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"promoters":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]},"blue_sky":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","fees"]}},"required":["underwriter","sales_commissions","finders","auditor","legal","promoters","blue_sky"]},"broker_dealer_crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"estimated_net_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"clarification":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["tier","audit_status","delayed_or_continuous","within_one_year","after_qualification","best_efforts","solicitation_proposed","resale_by_affiliates","securities_offered","outstanding_securities","price_per_security","issuer_aggregate","security_holder_aggregate","qualification_aggregate","concurrent_aggregate","total_aggregate","providers","broker_dealer_crd_number","estimated_net_amount","clarification"]},"securities_offered_types":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"other_description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","other_description"]}},"securities_outstanding":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"outstanding":{"anyOf":[{"type":"number"},{"type":"null"}]},"cusip":{"anyOf":[{"type":"string"},{"type":"null"}]},"publicly_traded":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","name","outstanding","cusip","publicly_traded"]}},"unregistered_sales":{"type":"array","items":{"type":"object","properties":{"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"total_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"principal_holders_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"aggregate_amount":{"anyOf":[{"type":"string"},{"type":"null"}]},"consideration_basis":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["issuer_name","title","total_amount","principal_holders_amount","aggregate_amount","consideration_basis"]},"description":"Securities sold in the past year without registration."},"issue_jurisdictions":{"type":"array","items":{"type":"string"}},"dealer_jurisdictions":{"type":"array","items":{"type":"string"}},"report":{"anyOf":[{"type":"object","properties":{"form_indication":{"anyOf":[{"type":"string"},{"type":"null"}]},"fiscal_year_end":{"anyOf":[{"type":"string"},{"type":"null"}]},"rule_257":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["form_indication","fiscal_year_end","rule_257"]},{"type":"null"}],"description":"On a 1-K or 1-Z."},"securities_reported":{"type":"array","items":{"type":"string"},"description":"On a 1-K: the securities it reports on."},"offerings_reported":{"type":"array","items":{"type":"object","properties":{"commission_file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualified_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"commenced_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"commenced_on_as_filed":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualified_securities_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"offering_securities_sold":{"anyOf":[{"type":"number"},{"type":"null"}]},"sold_by_issuer":{"anyOf":[{"type":"number"},{"type":"null"}]},"sold_by_security_holders":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_per_security":{"anyOf":[{"type":"number"},{"type":"null"}]},"aggregate_price":{"anyOf":[{"type":"number"},{"type":"null"}]},"aggregate_price_security_holders":{"anyOf":[{"type":"number"},{"type":"null"}]},"fees":{"type":"object","properties":{"underwriter":{"anyOf":[{"type":"number"},{"type":"null"}]},"sales_commissions":{"anyOf":[{"type":"number"},{"type":"null"}]},"finders":{"anyOf":[{"type":"number"},{"type":"null"}]},"auditor":{"anyOf":[{"type":"number"},{"type":"null"}]},"legal":{"anyOf":[{"type":"number"},{"type":"null"}]},"promoters":{"anyOf":[{"type":"number"},{"type":"null"}]},"blue_sky":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["underwriter","sales_commissions","finders","auditor","legal","promoters","blue_sky"]},"broker_dealer_crd_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer_net_proceeds":{"anyOf":[{"type":"number"},{"type":"null"}]},"clarification":{"anyOf":[{"type":"string"},{"type":"null"}]},"service_providers":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","name"]}}},"required":["commission_file_number","qualified_on","commenced_on","commenced_on_as_filed","qualified_securities_sold","offering_securities_sold","sold_by_issuer","sold_by_security_holders","price_per_security","aggregate_price","aggregate_price_security_holders","fees","broker_dealer_crd_number","issuer_net_proceeds","clarification","service_providers"]},"description":"On a 1-K or 1-Z: what each offering sold and raised."},"reported_offering_file_numbers":{"type":"array","items":{"type":"string"},"description":"The offerings (`024-`) a report covers."},"suspension_certifications":{"type":"array","items":{"type":"object","properties":{"class_title":{"anyOf":[{"type":"string"},{"type":"null"}]},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"approximate_record_holders":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["class_title","file_number","approximate_record_holders"]}},"signatures":{"type":"array","items":{"type":"object","properties":{"cik":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"issuer_name_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"signed_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"signed_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["cik","issuer_name","issuer_name_2","signed_by","signed_on","title"]}},"filing_url":{"type":"string","description":"The filing on EDGAR."},"documents_status":{"type":"string","enum":["stored","partial","unavailable","pending"],"description":"`stored` (every document is kept), `partial` or `unavailable` (EDGAR has not served every one yet; the next read retries), `pending` (not read yet)."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name EDGAR gives it."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When EDGAR last wrote the file, as EDGAR lists it (`yyyy-mm-dd hh:mm:ss`, Eastern time)."},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the file is, read from its bytes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our byte-identical copy; null while it could not be read."},"source_document_url":{"type":"string","description":"The file on EDGAR."}},"required":["name","bytes","modified_at","content_type","document_url","source_document_url"]},"description":"Every document of the filing: our byte-identical copy (`document_url`) and EDGAR's (`source_document_url`)."}},"required":["accession_number","form_type","filed_on","file_number","offering_file_number","draft_file_number","issuer_cik","issuer_name","is_shell_company","is_successor","reporting_period","issuers","issuer_names","address","phone","contact_name","industry_group","financials","auditor","certifications","offering","securities_offered_types","securities_outstanding","unregistered_sales","issue_jurisdictions","dealer_jurisdictions","report","securities_reported","offerings_reported","reported_offering_file_numbers","suspension_certifications","signatures","filing_url","documents_status","documents"]},"description":"The offering statement and its amendments, and every annual or exit report that names the offering, oldest first."}},"required":["found","file_number","as_of","filings"]},"SecRegAOfferingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SecRegAOfferingData"}}},"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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","page","per_page","total_pages","count","parties"]},"OfacSanctionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/OfacSanctionsSearchData"}}},"OfacSanctionsScreenData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"object","properties":{"name":{"type":"string"},"birth_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"id_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"party_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"list":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","birth_date","country","id_number","party_type","list"]},"threshold":{"type":"number","description":"The score a party had to reach to be returned."},"matched":{"type":"boolean","description":"Whether any party reached the threshold."},"count":{"type":"number"},"hits":{"type":"array","items":{"type":"object","properties":{"score":{"type":"number","description":"How closely the party matches the subject, 0 to 100."},"matched_name":{"type":"string","description":"The name of the party's that matched best: its primary name or one of its aliases, as OFAC writes it."},"matched_on":{"type":"string","enum":["name","alias"],"description":"Whether `matched_name` is the party's primary name or an alias."},"breakdown":{"type":"object","properties":{"name":{"type":"object","properties":{"score":{"type":"number","description":"How alike the names are, 0 to 100."},"weight":{"type":"number","description":"The name's share of the score, 0 to 1."}},"required":["score","weight"]},"birth_date":{"type":"object","properties":{"result":{"type":"string","enum":["match","partial","mismatch","not_compared"],"description":"`match`, `partial` (same year, another day), `mismatch`, or `not_compared` when the subject or the record has none."},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"100 for a match, 50 for a partial one, -100 for a mismatch; null when not compared."},"weight":{"type":"number","description":"The date of birth's share of the score, 0 to 1; 0 when not compared."},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date of birth OFAC records that was compared, as it writes it."}},"required":["result","score","weight","value"]},"country":{"type":"object","properties":{"result":{"type":"string","enum":["match","mismatch","not_compared"],"description":"`match`, `mismatch`, or `not_compared` when the subject or the record has none."},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"100 for a match, -50 for a mismatch; null when not compared."},"weight":{"type":"number","description":"The country's share of the score, 0 to 1; 0 when not compared."},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's country that matched, or one it has when none did, as OFAC writes it."}},"required":["result","score","weight","value"]},"id_number":{"type":"object","properties":{"result":{"type":"string","enum":["match","no_match","not_compared"],"description":"`match` sets the score to 100 whatever the rest says; `no_match` changes nothing, since the party may hold other documents."},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number OFAC records that matched."}},"required":["result","value"]}},"required":["name","birth_date","country","id_number"],"description":"What decided the score."},"party":{"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":["score","matched_name","matched_on","breakdown","party"]},"description":"The parties that reached the threshold, closest first."}},"required":["as_of","query","threshold","matched","count","hits"]},"OfacSanctionsScreenResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/OfacSanctionsScreenData"}}},"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"}}},"CslPartiesSearchData":{"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"}]},"agency":{"anyOf":[{"type":"string"},{"type":"null"}]},"party_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"program":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Parties matching the filters, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The list and the entry's number joined by a hyphen: OFAC's entity number on a Treasury list (`sdn-36`), the entry's own id on a Commerce or State list (`el-…`). The key."},"list":{"type":"string","enum":["sdn","ssi","plc","ns_mbs","cmic","cap","fse","el","dpl","uvl","meu","isn","dtc"],"description":"The list, by its abbreviation: `sdn`, `ssi`, `plc`, `ns_mbs`, `cmic`, `cap`, `fse` (Treasury), `el`, `dpl`, `uvl`, `meu` (Commerce), `isn`, `dtc` (State)."},"list_name":{"type":"string","description":"The list's full name, e.g. `Entity List (EL)`."},"agency":{"type":"string","enum":["treasury","commerce","state"],"description":"Who publishes the list: `treasury` (OFAC), `commerce` (the Bureau of Industry and Security) or `state` (the State Department)."},"entity_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"OFAC's own number for the party, on a Treasury list; null on the others."},"name":{"type":"string","description":"The party's name as the list writes it."},"alt_names":{"type":"array","items":{"type":"string"},"description":"Every other name the list records for the party."},"party_type":{"anyOf":[{"type":"string","enum":["individual","entity","vessel","aircraft"]},{"type":"null"}],"description":"`individual`, `entity`, `vessel` or `aircraft` on a Treasury list; null on the Commerce and State lists, which do not say."},"programs":{"type":"array","items":{"type":"string"},"description":"The sanctions programs or statutes the listing is under, as the list writes them, e.g. `SDGT`, `CMIC-EO13959`, `Chemical and Biological Weapons Act`."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The person's title or role, when recorded."},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The list's own note."},"addresses":{"type":"array","items":{"type":"object","properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A two-letter country code for most addresses; a few carry a region as the list writes it."}},"required":["address","city","state","postal_code","country"]},"description":"Every address the list records for the party."},"countries":{"type":"array","items":{"type":"string"},"description":"The distinct countries of the party's addresses (and, on the nonproliferation list, of the party itself), mostly as two-letter codes."},"identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"What the number is, as the list names it, e.g. `Tax ID No.`, `Passport`, `NIT #`, `Unified Social Credit Code (USCC)`, `SWIFT/BIC`."},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The two-letter code of the country that issued it, when recorded."},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As the list writes it, e.g. `18 Jan 1984`."},"expiration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As the list writes it."}},"required":["type","number","country","issue_date","expiration_date"]},"description":"The identifying numbers and facts the list records: tax and registration numbers, passports, national ids, SWIFT codes, vessel IMO numbers, digital currency addresses, websites, and OFAC's own notes such as gender or secondary sanctions risk."},"identifier_numbers":{"type":"array","items":{"type":"string"},"description":"The identifying numbers alone, upper-cased without spaces or punctuation, for matching."},"dates_of_birth":{"type":"array","items":{"type":"string"},"description":"As the list writes them: a date, a year, `circa 1960`, or a range."},"places_of_birth":{"type":"array","items":{"type":"string"}},"nationalities":{"type":"array","items":{"type":"string"},"description":"Two-letter country codes."},"citizenships":{"type":"array","items":{"type":"string"},"description":"Two-letter country codes."},"federal_register_notice":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Federal Register notice or notices that published the listing, e.g. `85 FR 34495`."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the listing took effect (yyyy-mm-dd), on the lists that record it: the Entity List, the Denied Persons List, the Military End User List and the nonproliferation sanctions."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When a denial order ends (yyyy-mm-dd), when recorded."},"standard_order":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"On the Denied Persons List: whether the denial is a standard order."},"license_requirement":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"On the Commerce lists: which items need a license to export to the party."},"license_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"On the Commerce lists: how a license application is reviewed, e.g. `Presumption of denial`."},"vessel":{"anyOf":[{"type":"object","properties":{"call_sign":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"gross_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","gross_tonnage","gross_registered_tonnage","flag","owner"]},{"type":"null"}],"description":"Set only for a vessel."},"source_list_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agency's page for the list."},"source_information_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agency's guidance on the list."}},"required":["id","list","list_name","agency","entity_number","name","alt_names","party_type","programs","title","remarks","addresses","countries","identifiers","identifier_numbers","dates_of_birth","places_of_birth","nationalities","citizenships","federal_register_notice","start_date","end_date","standard_order","license_requirement","license_policy","vessel","source_list_url","source_information_url"]}}},"required":["as_of","query","list","agency","party_type","program","country","identifier","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","parties"]},"CslPartiesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CslPartiesSearchData"}}},"CslPartyData":{"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 the entry's number joined by a hyphen: OFAC's entity number on a Treasury list (`sdn-36`), the entry's own id on a Commerce or State list (`el-…`). The key."},"list":{"type":"string","enum":["sdn","ssi","plc","ns_mbs","cmic","cap","fse","el","dpl","uvl","meu","isn","dtc"],"description":"The list, by its abbreviation: `sdn`, `ssi`, `plc`, `ns_mbs`, `cmic`, `cap`, `fse` (Treasury), `el`, `dpl`, `uvl`, `meu` (Commerce), `isn`, `dtc` (State)."},"list_name":{"type":"string","description":"The list's full name, e.g. `Entity List (EL)`."},"agency":{"type":"string","enum":["treasury","commerce","state"],"description":"Who publishes the list: `treasury` (OFAC), `commerce` (the Bureau of Industry and Security) or `state` (the State Department)."},"entity_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"OFAC's own number for the party, on a Treasury list; null on the others."},"name":{"type":"string","description":"The party's name as the list writes it."},"alt_names":{"type":"array","items":{"type":"string"},"description":"Every other name the list records for the party."},"party_type":{"anyOf":[{"type":"string","enum":["individual","entity","vessel","aircraft"]},{"type":"null"}],"description":"`individual`, `entity`, `vessel` or `aircraft` on a Treasury list; null on the Commerce and State lists, which do not say."},"programs":{"type":"array","items":{"type":"string"},"description":"The sanctions programs or statutes the listing is under, as the list writes them, e.g. `SDGT`, `CMIC-EO13959`, `Chemical and Biological Weapons Act`."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The person's title or role, when recorded."},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The list's own note."},"addresses":{"type":"array","items":{"type":"object","properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A two-letter country code for most addresses; a few carry a region as the list writes it."}},"required":["address","city","state","postal_code","country"]},"description":"Every address the list records for the party."},"countries":{"type":"array","items":{"type":"string"},"description":"The distinct countries of the party's addresses (and, on the nonproliferation list, of the party itself), mostly as two-letter codes."},"identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"What the number is, as the list names it, e.g. `Tax ID No.`, `Passport`, `NIT #`, `Unified Social Credit Code (USCC)`, `SWIFT/BIC`."},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The two-letter code of the country that issued it, when recorded."},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As the list writes it, e.g. `18 Jan 1984`."},"expiration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As the list writes it."}},"required":["type","number","country","issue_date","expiration_date"]},"description":"The identifying numbers and facts the list records: tax and registration numbers, passports, national ids, SWIFT codes, vessel IMO numbers, digital currency addresses, websites, and OFAC's own notes such as gender or secondary sanctions risk."},"identifier_numbers":{"type":"array","items":{"type":"string"},"description":"The identifying numbers alone, upper-cased without spaces or punctuation, for matching."},"dates_of_birth":{"type":"array","items":{"type":"string"},"description":"As the list writes them: a date, a year, `circa 1960`, or a range."},"places_of_birth":{"type":"array","items":{"type":"string"}},"nationalities":{"type":"array","items":{"type":"string"},"description":"Two-letter country codes."},"citizenships":{"type":"array","items":{"type":"string"},"description":"Two-letter country codes."},"federal_register_notice":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Federal Register notice or notices that published the listing, e.g. `85 FR 34495`."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the listing took effect (yyyy-mm-dd), on the lists that record it: the Entity List, the Denied Persons List, the Military End User List and the nonproliferation sanctions."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When a denial order ends (yyyy-mm-dd), when recorded."},"standard_order":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"On the Denied Persons List: whether the denial is a standard order."},"license_requirement":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"On the Commerce lists: which items need a license to export to the party."},"license_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"On the Commerce lists: how a license application is reviewed, e.g. `Presumption of denial`."},"vessel":{"anyOf":[{"type":"object","properties":{"call_sign":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"gross_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","gross_tonnage","gross_registered_tonnage","flag","owner"]},{"type":"null"}],"description":"Set only for a vessel."},"source_list_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agency's page for the list."},"source_information_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agency's guidance on the list."}},"required":["id","list","list_name","agency","entity_number","name","alt_names","party_type","programs","title","remarks","addresses","countries","identifiers","identifier_numbers","dates_of_birth","places_of_birth","nationalities","citizenships","federal_register_notice","start_date","end_date","standard_order","license_requirement","license_policy","vessel","source_list_url","source_information_url"]},{"type":"null"}]}},"required":["found","id","as_of","party"]},"CslPartyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CslPartyData"}}},"SamExclusionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"classification":{"anyOf":[{"type":"string"},{"type":"null"}]},"agency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exclusion_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"uei":{"anyOf":[{"type":"string"},{"type":"null"}]},"cage":{"anyOf":[{"type":"string"},{"type":"null"}]},"npi":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Exclusions matching the filters, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"exclusions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"SAM.gov's number for the exclusion record (a UUID), stable across the record's changes. The key."},"classification":{"type":"string","enum":["individual","firm","special_entity_designation","vessel"],"description":"`individual`, `firm`, `special_entity_designation` (an entity other than a firm, e.g. a clinic or pharmacy excluded by name) or `vessel`."},"name":{"type":"string","description":"The excluded party's name: the entity's name, or a person's first, middle and last name and suffix."},"prefix":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A person's prefix, e.g. `Dr.`"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The street address. SAM.gov publishes none for a person."},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or province: the two-letter code for a US state."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A three-letter country code, e.g. `USA`, `CAN`, `MEX`."},"uei":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's Unique Entity ID in SAM.gov, when it has one."},"cage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's CAGE code, when it has one."},"npi":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A health care provider's National Provider Identifier, when recorded."},"exclusion_program":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Reciprocal` (excluded from both procurement and non-procurement awards), `Procurement` or `NonProcurement`."},"excluding_agency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agency that excluded the party, by its code, e.g. `HHS`, `OPM`, `DOJ`, `EPA`, `DLA`; `OFAC` for SAM.gov's copy of the Treasury's sanctions list."},"ct_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cause and treatment code SAM.gov records for the exclusion, e.g. `Z1`, `R`."},"exclusion_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Prohibition/Restriction`, `Ineligible (Proceedings Completed)`, `Ineligible (Proceedings Pending)` or `Voluntary Exclusion`."},"comments":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The excluding agency's note: the authority, the scope, sometimes the names the party also traded under."},"cross_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Other names and related parties the agency links to the exclusion."},"active_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the exclusion took effect (yyyy-mm-dd)."},"termination_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the exclusion ends (yyyy-mm-dd); null when it is indefinite."},"indefinite":{"type":"boolean","description":"Whether the exclusion has no end date."},"record_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When SAM.gov last created or changed the record (yyyy-mm-dd)."}},"required":["id","classification","name","prefix","first_name","middle_name","last_name","suffix","address_1","address_2","city","state","zip_code","country","uei","cage","npi","exclusion_program","excluding_agency","ct_code","exclusion_type","comments","cross_reference","active_date","termination_date","indefinite","record_status","updated_date"]}}},"required":["as_of","query","classification","agency","exclusion_type","state","uei","cage","npi","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","exclusions"]},"SamExclusionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SamExclusionsSearchData"}}},"SamExclusionData":{"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."},"exclusion":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"SAM.gov's number for the exclusion record (a UUID), stable across the record's changes. The key."},"classification":{"type":"string","enum":["individual","firm","special_entity_designation","vessel"],"description":"`individual`, `firm`, `special_entity_designation` (an entity other than a firm, e.g. a clinic or pharmacy excluded by name) or `vessel`."},"name":{"type":"string","description":"The excluded party's name: the entity's name, or a person's first, middle and last name and suffix."},"prefix":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A person's prefix, e.g. `Dr.`"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The street address. SAM.gov publishes none for a person."},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or province: the two-letter code for a US state."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A three-letter country code, e.g. `USA`, `CAN`, `MEX`."},"uei":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's Unique Entity ID in SAM.gov, when it has one."},"cage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's CAGE code, when it has one."},"npi":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A health care provider's National Provider Identifier, when recorded."},"exclusion_program":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Reciprocal` (excluded from both procurement and non-procurement awards), `Procurement` or `NonProcurement`."},"excluding_agency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agency that excluded the party, by its code, e.g. `HHS`, `OPM`, `DOJ`, `EPA`, `DLA`; `OFAC` for SAM.gov's copy of the Treasury's sanctions list."},"ct_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cause and treatment code SAM.gov records for the exclusion, e.g. `Z1`, `R`."},"exclusion_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Prohibition/Restriction`, `Ineligible (Proceedings Completed)`, `Ineligible (Proceedings Pending)` or `Voluntary Exclusion`."},"comments":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The excluding agency's note: the authority, the scope, sometimes the names the party also traded under."},"cross_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Other names and related parties the agency links to the exclusion."},"active_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the exclusion took effect (yyyy-mm-dd)."},"termination_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the exclusion ends (yyyy-mm-dd); null when it is indefinite."},"indefinite":{"type":"boolean","description":"Whether the exclusion has no end date."},"record_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When SAM.gov last created or changed the record (yyyy-mm-dd)."}},"required":["id","classification","name","prefix","first_name","middle_name","last_name","suffix","address_1","address_2","city","state","zip_code","country","uei","cage","npi","exclusion_program","excluding_agency","ct_code","exclusion_type","comments","cross_reference","active_date","termination_date","indefinite","record_status","updated_date"]},{"type":"null"}]}},"required":["found","id","as_of","exclusion"]},"SamExclusionResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SamExclusionData"}}},"SamOpportunitiesSearchData":{"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"}]},"solicitation_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"sub_tier":{"anyOf":[{"type":"string"},{"type":"null"}]},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"classification_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"set_aside":{"anyOf":[{"type":"string"},{"type":"null"}]},"performance_state":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_state":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"deadline_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"deadline_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"sort":{"type":"string"},"total":{"type":"number","description":"Notices matching the filters, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"opportunities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"SAM.gov's id for the notice, 32 hex characters, stable across the notice's updates. The key."},"title":{"type":"string"},"solicitation_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The solicitation number the agency assigned, upper-cased, e.g. `W912HN25B0012`. Null on a notice that has none yet."},"type":{"type":"string","description":"The kind of notice as SAM.gov words it: `Solicitation`, `Combined Synopsis/Solicitation`, `Presolicitation`, `Sources Sought`, `Special Notice`, `Award Notice`, `Justification`, `Justification and Approval (J&A)`, `Modification/Amendment/Cancel`, `Sale of Surplus Property` or `Consolidate/(Substantially) Bundle`."},"base_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of notice it was first posted as. `type` is what it is now: a solicitation that was awarded carries `Award Notice` there and `Solicitation` here."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department or independent agency, as SAM.gov writes it, e.g. `DEPT OF DEFENSE`, `VETERANS AFFAIRS, DEPARTMENT OF`."},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department's three-digit CGAC code, e.g. `097`."},"sub_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agency within the department, as SAM.gov writes it, e.g. `DEPT OF THE ARMY`, `DEFENSE LOGISTICS AGENCY`, `FOREST SERVICE`."},"agency_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agency's FPDS code, e.g. `2100`, `97AS`."},"office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting office, as the notice names it."},"office_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office's activity address code (AAC)."},"organization_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The level of the organization that posted: `OFFICE`, `SUB COMMAND`, `MAJOR COMMAND`, `AGENCY` or `DEPARTMENT`."},"posted_date":{"type":"string","description":"When the notice was posted (yyyy-mm-dd)."},"posted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the notice was posted, to the second, as SAM.gov writes it (`yyyy-mm-dd hh:mm:ss`, no time zone stated)."},"response_deadline":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When responses are due, as SAM.gov writes it: usually an ISO 8601 timestamp with the office's UTC offset (`2026-10-20T12:00:00-04:00`), sometimes a date alone."},"response_deadline_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The day responses are due (yyyy-mm-dd); null when the notice sets no deadline."},"archive_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the notice archives: `auto15` or `auto30` (that many days after the deadline), `autocustom` (on `archive_date`) or `manual`."},"archive_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the notice is set to archive (yyyy-mm-dd)."},"set_aside_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The set-aside code, upper-cased: `SBA` (total small business), `SBP` (partial), `SDVOSBC`, `WOSB`, `EDWOSB`, `8A`, `8AN`, `HZC`, `HZS`, `VSA`, `ISBEE`, `BICIV` and so on; `NONE` when the notice states there is none; null when it says nothing."},"set_aside":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The set-aside spelled out, as SAM.gov writes it, e.g. `Small Business Set Aside - Total`."},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The NAICS code of the work, usually six digits, e.g. `541512`."},"classification_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The product service code (PSC), e.g. `D302`, `7030`, `Y1AA`."},"performance_street":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The place of performance, when the notice states one."},"performance_city":{"anyOf":[{"type":"string"},{"type":"null"}]},"performance_state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The two-letter state of the place of performance."},"performance_zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"performance_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A three-letter country code, e.g. `USA`, `DEU`, `JPN`."},"award_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an award: the contract or order number."},"award_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an award: when it was made (yyyy-mm-dd)."},"award_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"column":"number","description":"For an award: the amount in US dollars, when the agency wrote a number."},"awardee":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an award: the winning contractor, as the agency wrote it, often with its UEI and address."},"primary_contact":{"anyOf":[{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contact's role, when the notice gives one, e.g. `Contract Specialist`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As the agency wrote it: digits alone, or with dashes, dots or parentheses."},"fax":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","name","email","phone","fax"]},{"type":"null"}],"description":"The contracting officer or point of contact the notice names."},"secondary_contact":{"anyOf":[{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contact's role, when the notice gives one, e.g. `Contract Specialist`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As the agency wrote it: digits alone, or with dashes, dots or parentheses."},"fax":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","name","email","phone","fax"]},{"type":"null"}]},"office_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting office's address."},"office_state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The two-letter state of the contracting office."},"office_zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A three-letter country code, usually `USA`."},"active":{"type":"boolean","description":"Whether SAM.gov lists the notice as active. The copy carries the active list."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The notice's text, as the agency wrote it. SAM.gov cuts it at about 32,000 characters."},"additional_info_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A link the agency added for more information, when any."},"source_url":{"type":"string","description":"The notice's page on SAM.gov."}},"required":["id","title","solicitation_number","type","base_type","department","department_code","sub_tier","agency_code","office","office_code","organization_type","posted_date","posted_at","response_deadline","response_deadline_date","archive_type","archive_date","set_aside_code","set_aside","naics_code","classification_code","performance_street","performance_city","performance_state","performance_zip","performance_country","award_number","award_date","award_amount","awardee","primary_contact","secondary_contact","office_city","office_state","office_zip","office_country","active","description","additional_info_url","source_url"]}}},"required":["as_of","query","type","solicitation_number","department","sub_tier","naics_code","classification_code","set_aside","performance_state","office_state","from_date","to_date","deadline_from","deadline_to","sort","total","total_is_exact","page","per_page","total_pages","count","opportunities"]},"SamOpportunitiesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SamOpportunitiesSearchData"}}},"SamOpportunityData":{"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."},"opportunity":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"SAM.gov's id for the notice, 32 hex characters, stable across the notice's updates. The key."},"title":{"type":"string"},"solicitation_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The solicitation number the agency assigned, upper-cased, e.g. `W912HN25B0012`. Null on a notice that has none yet."},"type":{"type":"string","description":"The kind of notice as SAM.gov words it: `Solicitation`, `Combined Synopsis/Solicitation`, `Presolicitation`, `Sources Sought`, `Special Notice`, `Award Notice`, `Justification`, `Justification and Approval (J&A)`, `Modification/Amendment/Cancel`, `Sale of Surplus Property` or `Consolidate/(Substantially) Bundle`."},"base_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of notice it was first posted as. `type` is what it is now: a solicitation that was awarded carries `Award Notice` there and `Solicitation` here."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department or independent agency, as SAM.gov writes it, e.g. `DEPT OF DEFENSE`, `VETERANS AFFAIRS, DEPARTMENT OF`."},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department's three-digit CGAC code, e.g. `097`."},"sub_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agency within the department, as SAM.gov writes it, e.g. `DEPT OF THE ARMY`, `DEFENSE LOGISTICS AGENCY`, `FOREST SERVICE`."},"agency_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agency's FPDS code, e.g. `2100`, `97AS`."},"office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting office, as the notice names it."},"office_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office's activity address code (AAC)."},"organization_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The level of the organization that posted: `OFFICE`, `SUB COMMAND`, `MAJOR COMMAND`, `AGENCY` or `DEPARTMENT`."},"posted_date":{"type":"string","description":"When the notice was posted (yyyy-mm-dd)."},"posted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the notice was posted, to the second, as SAM.gov writes it (`yyyy-mm-dd hh:mm:ss`, no time zone stated)."},"response_deadline":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When responses are due, as SAM.gov writes it: usually an ISO 8601 timestamp with the office's UTC offset (`2026-10-20T12:00:00-04:00`), sometimes a date alone."},"response_deadline_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The day responses are due (yyyy-mm-dd); null when the notice sets no deadline."},"archive_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the notice archives: `auto15` or `auto30` (that many days after the deadline), `autocustom` (on `archive_date`) or `manual`."},"archive_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the notice is set to archive (yyyy-mm-dd)."},"set_aside_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The set-aside code, upper-cased: `SBA` (total small business), `SBP` (partial), `SDVOSBC`, `WOSB`, `EDWOSB`, `8A`, `8AN`, `HZC`, `HZS`, `VSA`, `ISBEE`, `BICIV` and so on; `NONE` when the notice states there is none; null when it says nothing."},"set_aside":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The set-aside spelled out, as SAM.gov writes it, e.g. `Small Business Set Aside - Total`."},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The NAICS code of the work, usually six digits, e.g. `541512`."},"classification_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The product service code (PSC), e.g. `D302`, `7030`, `Y1AA`."},"performance_street":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The place of performance, when the notice states one."},"performance_city":{"anyOf":[{"type":"string"},{"type":"null"}]},"performance_state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The two-letter state of the place of performance."},"performance_zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"performance_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A three-letter country code, e.g. `USA`, `DEU`, `JPN`."},"award_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an award: the contract or order number."},"award_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an award: when it was made (yyyy-mm-dd)."},"award_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"column":"number","description":"For an award: the amount in US dollars, when the agency wrote a number."},"awardee":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an award: the winning contractor, as the agency wrote it, often with its UEI and address."},"primary_contact":{"anyOf":[{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contact's role, when the notice gives one, e.g. `Contract Specialist`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As the agency wrote it: digits alone, or with dashes, dots or parentheses."},"fax":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","name","email","phone","fax"]},{"type":"null"}],"description":"The contracting officer or point of contact the notice names."},"secondary_contact":{"anyOf":[{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contact's role, when the notice gives one, e.g. `Contract Specialist`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As the agency wrote it: digits alone, or with dashes, dots or parentheses."},"fax":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","name","email","phone","fax"]},{"type":"null"}]},"office_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting office's address."},"office_state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The two-letter state of the contracting office."},"office_zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A three-letter country code, usually `USA`."},"active":{"type":"boolean","description":"Whether SAM.gov lists the notice as active. The copy carries the active list."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The notice's text, as the agency wrote it. SAM.gov cuts it at about 32,000 characters."},"additional_info_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A link the agency added for more information, when any."},"source_url":{"type":"string","description":"The notice's page on SAM.gov."}},"required":["id","title","solicitation_number","type","base_type","department","department_code","sub_tier","agency_code","office","office_code","organization_type","posted_date","posted_at","response_deadline","response_deadline_date","archive_type","archive_date","set_aside_code","set_aside","naics_code","classification_code","performance_street","performance_city","performance_state","performance_zip","performance_country","award_number","award_date","award_amount","awardee","primary_contact","secondary_contact","office_city","office_state","office_zip","office_country","active","description","additional_info_url","source_url"]},{"type":"null"}]}},"required":["found","id","as_of","opportunity"]},"SamOpportunityResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SamOpportunityData"}}},"FincenMsbRegistrationsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"activity":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"operates_in":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"operates_abroad":{"type":"boolean"},"registrant_key":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Registrations matching the filters, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"registrations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Croma's id for the filing, derived from what the list says about it (the list publishes no number of its own); a counter follows when FinCEN lists the same filing twice. The key."},"registrant_key":{"type":"string","description":"The same for every filing of one business (its legal name, street and ZIP), to list a registrant's renewals together."},"legal_name":{"type":"string","description":"The business's legal name as registered. FinCEN cuts names at 50 characters."},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name it does business as."},"street_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The two-letter state of the address; for a registrant abroad, sometimes its province."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a registrant located outside the US, its country as FinCEN writes it, e.g. `COLOMBIA`, `HONG KONG`."},"activities":{"type":"array","items":{"type":"string"},"description":"The money services the business registered for, e.g. `money_transmitter`, `check_casher`, `dealer_in_foreign_exchange`, `seller_of_prepaid_access`."},"activity_codes":{"type":"array","items":{"type":"string"},"description":"The same activities as FinCEN's codes, e.g. `409`."},"states_of_activity":{"type":"array","items":{"type":"string"},"description":"The US states and territories where the business said it operates, as two-letter codes."},"activity_scope":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"FinCEN's flag, as written: `A` all states and territories, `B` all states, `C` all territories, `D` foreign, or a combination such as `AD`."},"operates_abroad":{"type":"boolean","description":"Whether the business said it operates outside the US (the `D` flag)."},"branches":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of branches it reported."},"auth_sign_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration was signed (yyyy-mm-dd)."},"received_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When FinCEN received the registration (yyyy-mm-dd)."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"FinCEN's MSB registration number for the filing (14 digits), from its registration letter; null until the letter is read."},"registration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"From the registration letter: `Initial Registration`, `Renewal` or another kind FinCEN writes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the filing's registration letter (PDF), as FinCEN served it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"FinCEN's link to the letter when it was read. FinCEN renumbers these links, so it may no longer answer; `document_url` does."}},"required":["id","registrant_key","legal_name","dba_name","street_address","city","state","zip_code","country","activities","activity_codes","states_of_activity","activity_scope","operates_abroad","branches","auth_sign_date","received_date","registration_number","registration_type","document_url","source_document_url"]}}},"required":["as_of","query","activity","state","operates_in","country","operates_abroad","registrant_key","registration_number","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","registrations"]},"FincenMsbRegistrationsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FincenMsbRegistrationsSearchData"}}},"FincenMsbRegistrationData":{"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."},"registration":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Croma's id for the filing, derived from what the list says about it (the list publishes no number of its own); a counter follows when FinCEN lists the same filing twice. The key."},"registrant_key":{"type":"string","description":"The same for every filing of one business (its legal name, street and ZIP), to list a registrant's renewals together."},"legal_name":{"type":"string","description":"The business's legal name as registered. FinCEN cuts names at 50 characters."},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name it does business as."},"street_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The two-letter state of the address; for a registrant abroad, sometimes its province."},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a registrant located outside the US, its country as FinCEN writes it, e.g. `COLOMBIA`, `HONG KONG`."},"activities":{"type":"array","items":{"type":"string"},"description":"The money services the business registered for, e.g. `money_transmitter`, `check_casher`, `dealer_in_foreign_exchange`, `seller_of_prepaid_access`."},"activity_codes":{"type":"array","items":{"type":"string"},"description":"The same activities as FinCEN's codes, e.g. `409`."},"states_of_activity":{"type":"array","items":{"type":"string"},"description":"The US states and territories where the business said it operates, as two-letter codes."},"activity_scope":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"FinCEN's flag, as written: `A` all states and territories, `B` all states, `C` all territories, `D` foreign, or a combination such as `AD`."},"operates_abroad":{"type":"boolean","description":"Whether the business said it operates outside the US (the `D` flag)."},"branches":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of branches it reported."},"auth_sign_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the registration was signed (yyyy-mm-dd)."},"received_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When FinCEN received the registration (yyyy-mm-dd)."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"FinCEN's MSB registration number for the filing (14 digits), from its registration letter; null until the letter is read."},"registration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"From the registration letter: `Initial Registration`, `Renewal` or another kind FinCEN writes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the filing's registration letter (PDF), as FinCEN served it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"FinCEN's link to the letter when it was read. FinCEN renumbers these links, so it may no longer answer; `document_url` does."}},"required":["id","registrant_key","legal_name","dba_name","street_address","city","state","zip_code","country","activities","activity_codes","states_of_activity","activity_scope","operates_abroad","branches","auth_sign_date","received_date","registration_number","registration_type","document_url","source_document_url"]},{"type":"null"}]}},"required":["found","id","as_of","registration"]},"FincenMsbRegistrationResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/FincenMsbRegistrationData"}}},"UsptoTrademarksSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"owner":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"international_class":{"anyOf":[{"type":"string"},{"type":"null"}]},"owner_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"serial_number":{"type":"string","description":"The eight-digit serial number the USPTO assigned when the application was filed, e.g. \"79392077\". It identifies the mark for its whole life."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registration number, once the mark registered, e.g. \"7726306\". Null while the application is pending, or when it never registered."},"mark":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The words of the mark, e.g. \"GAME & WARIO\". Null for a design-only mark with no words."},"mark_types":{"type":"array","items":{"type":"string"},"description":"What the mark identifies: \"TRADEMARK\" (goods), \"SERVICE MARK\" (services), \"COLLECTIVE MEMBERSHIP MARK\", \"CERTIFICATION MARK\" and so on; a mark can be several."},"drawing_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the mark is drawn, as the register describes it, e.g. \"(4) STANDARD CHARACTER MARK\", \"(3) DESIGN PLUS WORDS, LETTERS, AND/OR NUMBERS\"."},"status_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The USPTO's status code, e.g. 700 (registered), 602 (abandoned), 686 (published for opposition)."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The status as the USPTO words it, e.g. \"REGISTERED\", \"ABANDONED - FAILURE TO RESPOND OR LATE RESPONSE\"."},"is_live":{"type":"boolean","description":"True while the application is pending or the registration is in force; false once abandoned, cancelled or expired."},"is_registered":{"type":"boolean","description":"True once the mark registered (and while the registration stands)."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was filed; what `from_date` and `to_date` filter on."},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the mark registered."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the mark was published for opposition."},"abandonment_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was abandoned."},"cancellation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration was cancelled."},"renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the last renewal of the registration."},"first_use_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the owner states the mark was first used anywhere."},"first_use_in_commerce_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the owner states the mark was first used in US commerce."},"international_classes":{"type":"array","items":{"type":"string"},"description":"The international (Nice) classes of the goods and services, as three digits, e.g. [\"009\", \"028\"]. \"A\", \"B\" and \"200\" are the USPTO's own classes for certification and collective membership marks."},"goods_and_services":{"type":"array","items":{"type":"string"},"description":"The goods and services the mark covers, one entry per class, e.g. \"IC 009: Recorded video game programs; ...\". Shortened when the whole list is very long; see `goods_and_services_truncated`."},"goods_and_services_truncated":{"type":"boolean","description":"True for the rare mark whose goods and services run past 100,000 characters: `goods_and_services` then carries the start of each class, and `goods_and_services_url` the whole list."},"goods_and_services_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The whole goods and services list as a JSON array, when `goods_and_services` is shortened. Null otherwise."},"filing_basis":{"type":"array","items":{"type":"string"},"description":"The current legal basis of the application, as the USPTO codes it: \"1a\" (use in commerce), \"1b\" (intent to use), \"44d\", \"44e\" (a foreign application or registration), \"66a\" (an international registration under the Madrid Protocol)."},"register":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"PRINCIPAL\" or \"SUPPLEMENTAL\", the register the mark is on or applied for."},"owner_names":{"type":"array","items":{"type":"string"},"description":"The owners as the register records them, e.g. [\"Nintendo of America Inc.\"]."},"owner_entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of owner, e.g. \"CORPORATION\", \"LIMITED LIABILITY COMPANY\", \"INDIVIDUAL\"."},"owner_citizenship":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the owner is organized or a citizen, as the register writes it, e.g. \"WASHINGTON, USA\", \"TURKEY\"."},"owner_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The city of the owner's address, when the register states it."},"owner_state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The US state of the owner's address, e.g. \"North Carolina\". Null outside the US."},"owner_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The country of the owner's address, as the register writes it, e.g. \"UNITED STATES\", \"JAPAN\"."},"attorney_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The attorney of record, when there is one."},"has_assignment":{"type":"boolean","description":"True when an assignment (a transfer of ownership or a security interest) has been recorded against the mark."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the USPTO last updated the record, ISO 8601."},"official_url":{"type":"string","description":"The mark's page at the USPTO's Trademark Status and Document Retrieval system."}},"required":["serial_number","registration_number","mark","mark_types","drawing_type","status_code","status","is_live","is_registered","filing_date","registration_date","publication_date","abandonment_date","cancellation_date","renewal_date","first_use_date","first_use_in_commerce_date","international_classes","goods_and_services","goods_and_services_truncated","goods_and_services_url","filing_basis","register","owner_names","owner_entity_type","owner_citizenship","owner_city","owner_state","owner_country","attorney_name","has_assignment","updated_at","official_url"]}}},"required":["as_of","query","owner","status","international_class","owner_country","registration_number","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"UsptoTrademarksSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UsptoTrademarksSearchData"}}},"UsptoTrademarkData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"serial_number":{"type":"string"},"trademark":{"anyOf":[{"type":"object","properties":{"serial_number":{"type":"string","description":"The eight-digit serial number the USPTO assigned when the application was filed, e.g. \"79392077\". It identifies the mark for its whole life."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registration number, once the mark registered, e.g. \"7726306\". Null while the application is pending, or when it never registered."},"mark":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The words of the mark, e.g. \"GAME & WARIO\". Null for a design-only mark with no words."},"mark_types":{"type":"array","items":{"type":"string"},"description":"What the mark identifies: \"TRADEMARK\" (goods), \"SERVICE MARK\" (services), \"COLLECTIVE MEMBERSHIP MARK\", \"CERTIFICATION MARK\" and so on; a mark can be several."},"drawing_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the mark is drawn, as the register describes it, e.g. \"(4) STANDARD CHARACTER MARK\", \"(3) DESIGN PLUS WORDS, LETTERS, AND/OR NUMBERS\"."},"status_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The USPTO's status code, e.g. 700 (registered), 602 (abandoned), 686 (published for opposition)."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The status as the USPTO words it, e.g. \"REGISTERED\", \"ABANDONED - FAILURE TO RESPOND OR LATE RESPONSE\"."},"is_live":{"type":"boolean","description":"True while the application is pending or the registration is in force; false once abandoned, cancelled or expired."},"is_registered":{"type":"boolean","description":"True once the mark registered (and while the registration stands)."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was filed; what `from_date` and `to_date` filter on."},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the mark registered."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the mark was published for opposition."},"abandonment_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was abandoned."},"cancellation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration was cancelled."},"renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the last renewal of the registration."},"first_use_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the owner states the mark was first used anywhere."},"first_use_in_commerce_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the owner states the mark was first used in US commerce."},"international_classes":{"type":"array","items":{"type":"string"},"description":"The international (Nice) classes of the goods and services, as three digits, e.g. [\"009\", \"028\"]. \"A\", \"B\" and \"200\" are the USPTO's own classes for certification and collective membership marks."},"goods_and_services":{"type":"array","items":{"type":"string"},"description":"The goods and services the mark covers, one entry per class, e.g. \"IC 009: Recorded video game programs; ...\". Shortened when the whole list is very long; see `goods_and_services_truncated`."},"goods_and_services_truncated":{"type":"boolean","description":"True for the rare mark whose goods and services run past 100,000 characters: `goods_and_services` then carries the start of each class, and `goods_and_services_url` the whole list."},"goods_and_services_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The whole goods and services list as a JSON array, when `goods_and_services` is shortened. Null otherwise."},"filing_basis":{"type":"array","items":{"type":"string"},"description":"The current legal basis of the application, as the USPTO codes it: \"1a\" (use in commerce), \"1b\" (intent to use), \"44d\", \"44e\" (a foreign application or registration), \"66a\" (an international registration under the Madrid Protocol)."},"register":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"PRINCIPAL\" or \"SUPPLEMENTAL\", the register the mark is on or applied for."},"owner_names":{"type":"array","items":{"type":"string"},"description":"The owners as the register records them, e.g. [\"Nintendo of America Inc.\"]."},"owner_entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of owner, e.g. \"CORPORATION\", \"LIMITED LIABILITY COMPANY\", \"INDIVIDUAL\"."},"owner_citizenship":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the owner is organized or a citizen, as the register writes it, e.g. \"WASHINGTON, USA\", \"TURKEY\"."},"owner_city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The city of the owner's address, when the register states it."},"owner_state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The US state of the owner's address, e.g. \"North Carolina\". Null outside the US."},"owner_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The country of the owner's address, as the register writes it, e.g. \"UNITED STATES\", \"JAPAN\"."},"attorney_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The attorney of record, when there is one."},"has_assignment":{"type":"boolean","description":"True when an assignment (a transfer of ownership or a security interest) has been recorded against the mark."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the USPTO last updated the record, ISO 8601."},"official_url":{"type":"string","description":"The mark's page at the USPTO's Trademark Status and Document Retrieval system."}},"required":["serial_number","registration_number","mark","mark_types","drawing_type","status_code","status","is_live","is_registered","filing_date","registration_date","publication_date","abandonment_date","cancellation_date","renewal_date","first_use_date","first_use_in_commerce_date","international_classes","goods_and_services","goods_and_services_truncated","goods_and_services_url","filing_basis","register","owner_names","owner_entity_type","owner_citizenship","owner_city","owner_state","owner_country","attorney_name","has_assignment","updated_at","official_url"]},{"type":"null"}]}},"required":["as_of","found","serial_number","trademark"]},"UsptoTrademarkResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UsptoTrademarkData"}}},"GleifEntitiesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_as":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Entities matching the filters, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"entities":{"type":"array","items":{"type":"object","properties":{"lei":{"type":"string","description":"The 20-character Legal Entity Identifier. The key."},"legal_name":{"type":"string","description":"The entity's legal name."},"legal_name_language":{"anyOf":[{"type":"string"},{"type":"null"}]},"other_names":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"GLEIF's kind of name, e.g. `TRADING_OR_OPERATING_NAME`, `PREVIOUS_LEGAL_NAME`, `AUTO_ASCII_TRANSLITERATED_LEGAL_NAME`."}},"required":["name","language","type"]},"description":"Other names: trading names, previous legal names, names in other languages."},"transliterated_names":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"GLEIF's kind of name, e.g. `TRADING_OR_OPERATING_NAME`, `PREVIOUS_LEGAL_NAME`, `AUTO_ASCII_TRANSLITERATED_LEGAL_NAME`."}},"required":["name","language","type"]},"description":"The names written in Latin script."},"all_names":{"type":"array","items":{"type":"string"},"description":"The legal name and every other name, for search."},"legal_address":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For another address, its kind, e.g. `AUTO_ASCII_TRANSLITERATED_LEGAL_ADDRESS`."},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_line":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"number_within_building":{"anyOf":[{"type":"string"},{"type":"null"}]},"mail_routing":{"anyOf":[{"type":"string"},{"type":"null"}]},"additional_lines":{"type":"array","items":{"type":"string"}},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-2 subdivision, e.g. `US-DE`."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-1 two-letter code."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","language","first_line","number","number_within_building","mail_routing","additional_lines","city","region","country","postal_code"]},"headquarters_address":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For another address, its kind, e.g. `AUTO_ASCII_TRANSLITERATED_LEGAL_ADDRESS`."},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_line":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"number_within_building":{"anyOf":[{"type":"string"},{"type":"null"}]},"mail_routing":{"anyOf":[{"type":"string"},{"type":"null"}]},"additional_lines":{"type":"array","items":{"type":"string"}},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-2 subdivision, e.g. `US-DE`."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-1 two-letter code."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","language","first_line","number","number_within_building","mail_routing","additional_lines","city","region","country","postal_code"]},"other_addresses":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For another address, its kind, e.g. `AUTO_ASCII_TRANSLITERATED_LEGAL_ADDRESS`."},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_line":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"number_within_building":{"anyOf":[{"type":"string"},{"type":"null"}]},"mail_routing":{"anyOf":[{"type":"string"},{"type":"null"}]},"additional_lines":{"type":"array","items":{"type":"string"}},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-2 subdivision, e.g. `US-DE`."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-1 two-letter code."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","language","first_line","number","number_within_building","mail_routing","additional_lines","city","region","country","postal_code"]}},"transliterated_addresses":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For another address, its kind, e.g. `AUTO_ASCII_TRANSLITERATED_LEGAL_ADDRESS`."},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_line":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"number_within_building":{"anyOf":[{"type":"string"},{"type":"null"}]},"mail_routing":{"anyOf":[{"type":"string"},{"type":"null"}]},"additional_lines":{"type":"array","items":{"type":"string"}},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-2 subdivision, e.g. `US-DE`."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-1 two-letter code."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","language","first_line","number","number_within_building","mail_routing","additional_lines","city","region","country","postal_code"]}},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The two-letter country of the legal address."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal jurisdiction: a country code (`GB`) or a subdivision (`US-DE`, `US-FL`)."},"registration_authority":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business register the entity is registered in, by GLEIF's code: `RA000602` is Delaware's Division of Corporations, `RA000603` Florida's Division of Corporations (Sunbiz). `RA999999` means none, `RA888888` another (see `other_registration_authority`)."},"other_registration_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_as":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's number at that register: a Delaware file number, a Sunbiz document number, a Colombian NIT, a Companies House number."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`GENERAL`, `FUND`, `BRANCH`, `SOLE_PROPRIETOR`, `RESIDENT_GOVERNMENT_ENTITY`, `INTERNATIONAL_ORGANIZATION`…"},"sub_category":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_form_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal form, by its ISO 20275 code."},"other_legal_form":{"anyOf":[{"type":"string"},{"type":"null"}]},"associated_entity":{"anyOf":[{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"lei":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","lei","name","language"]},{"type":"null"}],"description":"For a fund, its fund manager or umbrella, when recorded."},"entity_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ACTIVE` or `INACTIVE`."},"creation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiration_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"successor_entities":{"type":"array","items":{"type":"object","properties":{"lei":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["lei","name","language"]}},"events":{"type":"array","items":{"type":"object","properties":{"group_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"group_sequence_no":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `CHANGE_LEGAL_NAME`, `MERGERS_AND_ACQUISITIONS`, `DISSOLUTION`."},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_documents":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"affected_fields":{"type":"array","items":{"type":"object","properties":{"field":{"anyOf":[{"type":"string"},{"type":"null"}]},"xpath":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["field","xpath"]}}},"required":["group_type","status","group_id","group_sequence_no","type","effective_date","recorded_date","validation_documents","validation_reference","affected_fields"]},"description":"Legal entity events GLEIF records: name changes, mergers, dissolutions."},"initial_registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_update_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ISSUED` (kept up to date), `LAPSED` (not renewed), `RETIRED`, `DUPLICATE`, `ANNULLED`, `MERGED`, `PENDING_TRANSFER`, `PENDING_ARCHIVAL`."},"next_renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"managing_lou":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The LEI of the issuer that manages the record."},"validation_sources":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`FULLY_CORROBORATED`, `PARTIALLY_CORROBORATED`, `ENTITY_SUPPLIED_ONLY` or `PENDING`."},"validation_authority":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registration authority's code in GLEIF's list, e.g. `RA000602`."},"other_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's identifier at that authority."}},"required":["id","other_id","entity_id"]},"other_validation_authorities":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registration authority's code in GLEIF's list, e.g. `RA000602`."},"other_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's identifier at that authority."}},"required":["id","other_id","entity_id"]}},"conformity_flag":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["lei","legal_name","legal_name_language","other_names","transliterated_names","all_names","legal_address","headquarters_address","other_addresses","transliterated_addresses","country","jurisdiction","registration_authority","other_registration_authority","registered_as","category","sub_category","legal_form_code","other_legal_form","associated_entity","entity_status","creation_date","expiration_date","expiration_reason","successor_entities","events","initial_registration_date","last_update_date","registration_status","next_renewal_date","managing_lou","validation_sources","validation_authority","other_validation_authorities","conformity_flag"]}}},"required":["as_of","query","country","jurisdiction","registration_authority","registered_as","category","entity_status","registration_status","total","total_is_exact","page","per_page","total_pages","count","entities"]},"GleifEntitiesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GleifEntitiesSearchData"}}},"GleifEntityData":{"type":"object","properties":{"found":{"type":"boolean"},"lei":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"entity":{"anyOf":[{"type":"object","properties":{"lei":{"type":"string","description":"The 20-character Legal Entity Identifier. The key."},"legal_name":{"type":"string","description":"The entity's legal name."},"legal_name_language":{"anyOf":[{"type":"string"},{"type":"null"}]},"other_names":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"GLEIF's kind of name, e.g. `TRADING_OR_OPERATING_NAME`, `PREVIOUS_LEGAL_NAME`, `AUTO_ASCII_TRANSLITERATED_LEGAL_NAME`."}},"required":["name","language","type"]},"description":"Other names: trading names, previous legal names, names in other languages."},"transliterated_names":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"GLEIF's kind of name, e.g. `TRADING_OR_OPERATING_NAME`, `PREVIOUS_LEGAL_NAME`, `AUTO_ASCII_TRANSLITERATED_LEGAL_NAME`."}},"required":["name","language","type"]},"description":"The names written in Latin script."},"all_names":{"type":"array","items":{"type":"string"},"description":"The legal name and every other name, for search."},"legal_address":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For another address, its kind, e.g. `AUTO_ASCII_TRANSLITERATED_LEGAL_ADDRESS`."},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_line":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"number_within_building":{"anyOf":[{"type":"string"},{"type":"null"}]},"mail_routing":{"anyOf":[{"type":"string"},{"type":"null"}]},"additional_lines":{"type":"array","items":{"type":"string"}},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-2 subdivision, e.g. `US-DE`."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-1 two-letter code."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","language","first_line","number","number_within_building","mail_routing","additional_lines","city","region","country","postal_code"]},"headquarters_address":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For another address, its kind, e.g. `AUTO_ASCII_TRANSLITERATED_LEGAL_ADDRESS`."},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_line":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"number_within_building":{"anyOf":[{"type":"string"},{"type":"null"}]},"mail_routing":{"anyOf":[{"type":"string"},{"type":"null"}]},"additional_lines":{"type":"array","items":{"type":"string"}},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-2 subdivision, e.g. `US-DE`."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-1 two-letter code."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","language","first_line","number","number_within_building","mail_routing","additional_lines","city","region","country","postal_code"]},"other_addresses":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For another address, its kind, e.g. `AUTO_ASCII_TRANSLITERATED_LEGAL_ADDRESS`."},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_line":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"number_within_building":{"anyOf":[{"type":"string"},{"type":"null"}]},"mail_routing":{"anyOf":[{"type":"string"},{"type":"null"}]},"additional_lines":{"type":"array","items":{"type":"string"}},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-2 subdivision, e.g. `US-DE`."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-1 two-letter code."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","language","first_line","number","number_within_building","mail_routing","additional_lines","city","region","country","postal_code"]}},"transliterated_addresses":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For another address, its kind, e.g. `AUTO_ASCII_TRANSLITERATED_LEGAL_ADDRESS`."},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_line":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"number_within_building":{"anyOf":[{"type":"string"},{"type":"null"}]},"mail_routing":{"anyOf":[{"type":"string"},{"type":"null"}]},"additional_lines":{"type":"array","items":{"type":"string"}},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-2 subdivision, e.g. `US-DE`."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An ISO 3166-1 two-letter code."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","language","first_line","number","number_within_building","mail_routing","additional_lines","city","region","country","postal_code"]}},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The two-letter country of the legal address."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal jurisdiction: a country code (`GB`) or a subdivision (`US-DE`, `US-FL`)."},"registration_authority":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business register the entity is registered in, by GLEIF's code: `RA000602` is Delaware's Division of Corporations, `RA000603` Florida's Division of Corporations (Sunbiz). `RA999999` means none, `RA888888` another (see `other_registration_authority`)."},"other_registration_authority":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_as":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's number at that register: a Delaware file number, a Sunbiz document number, a Colombian NIT, a Companies House number."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`GENERAL`, `FUND`, `BRANCH`, `SOLE_PROPRIETOR`, `RESIDENT_GOVERNMENT_ENTITY`, `INTERNATIONAL_ORGANIZATION`…"},"sub_category":{"anyOf":[{"type":"string"},{"type":"null"}]},"legal_form_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal form, by its ISO 20275 code."},"other_legal_form":{"anyOf":[{"type":"string"},{"type":"null"}]},"associated_entity":{"anyOf":[{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"lei":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","lei","name","language"]},{"type":"null"}],"description":"For a fund, its fund manager or umbrella, when recorded."},"entity_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ACTIVE` or `INACTIVE`."},"creation_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiration_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"successor_entities":{"type":"array","items":{"type":"object","properties":{"lei":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["lei","name","language"]}},"events":{"type":"array","items":{"type":"object","properties":{"group_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"group_sequence_no":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `CHANGE_LEGAL_NAME`, `MERGERS_AND_ACQUISITIONS`, `DISSOLUTION`."},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_documents":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"affected_fields":{"type":"array","items":{"type":"object","properties":{"field":{"anyOf":[{"type":"string"},{"type":"null"}]},"xpath":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["field","xpath"]}}},"required":["group_type","status","group_id","group_sequence_no","type","effective_date","recorded_date","validation_documents","validation_reference","affected_fields"]},"description":"Legal entity events GLEIF records: name changes, mergers, dissolutions."},"initial_registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_update_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ISSUED` (kept up to date), `LAPSED` (not renewed), `RETIRED`, `DUPLICATE`, `ANNULLED`, `MERGED`, `PENDING_TRANSFER`, `PENDING_ARCHIVAL`."},"next_renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"managing_lou":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The LEI of the issuer that manages the record."},"validation_sources":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`FULLY_CORROBORATED`, `PARTIALLY_CORROBORATED`, `ENTITY_SUPPLIED_ONLY` or `PENDING`."},"validation_authority":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registration authority's code in GLEIF's list, e.g. `RA000602`."},"other_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's identifier at that authority."}},"required":["id","other_id","entity_id"]},"other_validation_authorities":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registration authority's code in GLEIF's list, e.g. `RA000602`."},"other_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's identifier at that authority."}},"required":["id","other_id","entity_id"]}},"conformity_flag":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["lei","legal_name","legal_name_language","other_names","transliterated_names","all_names","legal_address","headquarters_address","other_addresses","transliterated_addresses","country","jurisdiction","registration_authority","other_registration_authority","registered_as","category","sub_category","legal_form_code","other_legal_form","associated_entity","entity_status","creation_date","expiration_date","expiration_reason","successor_entities","events","initial_registration_date","last_update_date","registration_status","next_renewal_date","managing_lou","validation_sources","validation_authority","other_validation_authorities","conformity_flag"]},{"type":"null"}]},"direct_parent":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The child's LEI and the relationship type, joined by a colon. The key: a child reports one parent per type."},"child_lei":{"type":"string","description":"The LEI of the entity that reports the relationship (the subsidiary, the fund, the branch)."},"parent_lei":{"type":"string","description":"The LEI of the parent: the consolidating entity, the fund manager, the umbrella fund, the head office."},"relationship_type":{"type":"string","description":"`IS_DIRECTLY_CONSOLIDATED_BY`, `IS_ULTIMATELY_CONSOLIDATED_BY`, `IS_INTERNATIONAL_BRANCH_OF`, `IS_FUND-MANAGED_BY`, `IS_SUBFUND_OF` or `IS_FEEDER_TO`."},"relationship_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ACTIVE` or `INACTIVE`."},"periods":{"type":"array","items":{"type":"object","properties":{"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["start_date","end_date","type"]},"description":"`RELATIONSHIP_PERIOD`, `ACCOUNTING_PERIOD`, `DOCUMENT_FILING_PERIOD`."},"qualifiers":{"type":"array","items":{"type":"object","properties":{"dimension":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["dimension","category"]},"description":"e.g. the accounting standard, `IFRS` or `US_GAAP`."},"quantifiers":{"type":"array","items":{"type":"object","properties":{"method":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"string"},{"type":"null"}]},"units":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["method","amount","units"]},"description":"e.g. the percentage of consolidation."},"initial_registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_update_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`PUBLISHED`, `LAPSED`, `PENDING_ARCHIVAL`…"},"next_renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"managing_lou":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_sources":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_documents":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"current":{"type":"boolean","description":"False once GLEIF has withdrawn the relationship."},"withdrawn_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When GLEIF withdrew the relationship, if it has."},"parent_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"child_name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","child_lei","parent_lei","relationship_type","relationship_status","periods","qualifiers","quantifiers","initial_registration_date","last_update_date","registration_status","next_renewal_date","managing_lou","validation_sources","validation_documents","validation_reference","current","withdrawn_at","parent_name","child_name"]},{"type":"null"}],"description":"The entity's direct accounting consolidation parent, when it reports one."},"ultimate_parent":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The child's LEI and the relationship type, joined by a colon. The key: a child reports one parent per type."},"child_lei":{"type":"string","description":"The LEI of the entity that reports the relationship (the subsidiary, the fund, the branch)."},"parent_lei":{"type":"string","description":"The LEI of the parent: the consolidating entity, the fund manager, the umbrella fund, the head office."},"relationship_type":{"type":"string","description":"`IS_DIRECTLY_CONSOLIDATED_BY`, `IS_ULTIMATELY_CONSOLIDATED_BY`, `IS_INTERNATIONAL_BRANCH_OF`, `IS_FUND-MANAGED_BY`, `IS_SUBFUND_OF` or `IS_FEEDER_TO`."},"relationship_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ACTIVE` or `INACTIVE`."},"periods":{"type":"array","items":{"type":"object","properties":{"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["start_date","end_date","type"]},"description":"`RELATIONSHIP_PERIOD`, `ACCOUNTING_PERIOD`, `DOCUMENT_FILING_PERIOD`."},"qualifiers":{"type":"array","items":{"type":"object","properties":{"dimension":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["dimension","category"]},"description":"e.g. the accounting standard, `IFRS` or `US_GAAP`."},"quantifiers":{"type":"array","items":{"type":"object","properties":{"method":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"string"},{"type":"null"}]},"units":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["method","amount","units"]},"description":"e.g. the percentage of consolidation."},"initial_registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_update_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`PUBLISHED`, `LAPSED`, `PENDING_ARCHIVAL`…"},"next_renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"managing_lou":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_sources":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_documents":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"current":{"type":"boolean","description":"False once GLEIF has withdrawn the relationship."},"withdrawn_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When GLEIF withdrew the relationship, if it has."},"parent_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"child_name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","child_lei","parent_lei","relationship_type","relationship_status","periods","qualifiers","quantifiers","initial_registration_date","last_update_date","registration_status","next_renewal_date","managing_lou","validation_sources","validation_documents","validation_reference","current","withdrawn_at","parent_name","child_name"]},{"type":"null"}],"description":"Its ultimate accounting consolidation parent, when it reports one."},"other_parents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The child's LEI and the relationship type, joined by a colon. The key: a child reports one parent per type."},"child_lei":{"type":"string","description":"The LEI of the entity that reports the relationship (the subsidiary, the fund, the branch)."},"parent_lei":{"type":"string","description":"The LEI of the parent: the consolidating entity, the fund manager, the umbrella fund, the head office."},"relationship_type":{"type":"string","description":"`IS_DIRECTLY_CONSOLIDATED_BY`, `IS_ULTIMATELY_CONSOLIDATED_BY`, `IS_INTERNATIONAL_BRANCH_OF`, `IS_FUND-MANAGED_BY`, `IS_SUBFUND_OF` or `IS_FEEDER_TO`."},"relationship_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ACTIVE` or `INACTIVE`."},"periods":{"type":"array","items":{"type":"object","properties":{"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["start_date","end_date","type"]},"description":"`RELATIONSHIP_PERIOD`, `ACCOUNTING_PERIOD`, `DOCUMENT_FILING_PERIOD`."},"qualifiers":{"type":"array","items":{"type":"object","properties":{"dimension":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["dimension","category"]},"description":"e.g. the accounting standard, `IFRS` or `US_GAAP`."},"quantifiers":{"type":"array","items":{"type":"object","properties":{"method":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"string"},{"type":"null"}]},"units":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["method","amount","units"]},"description":"e.g. the percentage of consolidation."},"initial_registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_update_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`PUBLISHED`, `LAPSED`, `PENDING_ARCHIVAL`…"},"next_renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"managing_lou":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_sources":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_documents":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"current":{"type":"boolean","description":"False once GLEIF has withdrawn the relationship."},"withdrawn_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When GLEIF withdrew the relationship, if it has."},"parent_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"child_name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","child_lei","parent_lei","relationship_type","relationship_status","periods","qualifiers","quantifiers","initial_registration_date","last_update_date","registration_status","next_renewal_date","managing_lou","validation_sources","validation_documents","validation_reference","current","withdrawn_at","parent_name","child_name"]},"description":"Its fund manager, umbrella fund, master fund or head office, when it reports them."},"reporting_exceptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The LEI and the category, joined by a colon. The key."},"lei":{"type":"string","description":"The entity's LEI."},"category":{"type":"string","description":"`DIRECT_ACCOUNTING_CONSOLIDATION_PARENT` or `ULTIMATE_ACCOUNTING_CONSOLIDATION_PARENT`."},"reasons":{"type":"array","items":{"type":"string"},"description":"e.g. `NATURAL_PERSONS` (owned by people), `NON_CONSOLIDATING`, `NO_KNOWN_PERSON`, `NON_PUBLIC`, `NO_LEI`."},"exception_references":{"type":"array","items":{"type":"string"},"description":"GLEIF's free-text references for the exception, when given."},"current":{"type":"boolean","description":"False once GLEIF has withdrawn the exception."},"withdrawn_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","lei","category","reasons","exception_references","current","withdrawn_at"]},"description":"Why it reports no direct or ultimate parent, when it does not."},"children":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The child's LEI and the relationship type, joined by a colon. The key: a child reports one parent per type."},"child_lei":{"type":"string","description":"The LEI of the entity that reports the relationship (the subsidiary, the fund, the branch)."},"parent_lei":{"type":"string","description":"The LEI of the parent: the consolidating entity, the fund manager, the umbrella fund, the head office."},"relationship_type":{"type":"string","description":"`IS_DIRECTLY_CONSOLIDATED_BY`, `IS_ULTIMATELY_CONSOLIDATED_BY`, `IS_INTERNATIONAL_BRANCH_OF`, `IS_FUND-MANAGED_BY`, `IS_SUBFUND_OF` or `IS_FEEDER_TO`."},"relationship_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ACTIVE` or `INACTIVE`."},"periods":{"type":"array","items":{"type":"object","properties":{"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["start_date","end_date","type"]},"description":"`RELATIONSHIP_PERIOD`, `ACCOUNTING_PERIOD`, `DOCUMENT_FILING_PERIOD`."},"qualifiers":{"type":"array","items":{"type":"object","properties":{"dimension":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["dimension","category"]},"description":"e.g. the accounting standard, `IFRS` or `US_GAAP`."},"quantifiers":{"type":"array","items":{"type":"object","properties":{"method":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"string"},{"type":"null"}]},"units":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["method","amount","units"]},"description":"e.g. the percentage of consolidation."},"initial_registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_update_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`PUBLISHED`, `LAPSED`, `PENDING_ARCHIVAL`…"},"next_renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"managing_lou":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_sources":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_documents":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"current":{"type":"boolean","description":"False once GLEIF has withdrawn the relationship."},"withdrawn_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When GLEIF withdrew the relationship, if it has."},"parent_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"child_name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","child_lei","parent_lei","relationship_type","relationship_status","periods","qualifiers","quantifiers","initial_registration_date","last_update_date","registration_status","next_renewal_date","managing_lou","validation_sources","validation_documents","validation_reference","current","withdrawn_at","parent_name","child_name"]},"description":"Up to 100 entities that report this one as a parent of any kind, current relationships first."},"children_total":{"type":"number","description":"Every entity that reports this one as a parent; the relationships search pages through them."}},"required":["found","lei","as_of","entity","direct_parent","ultimate_parent","other_parents","reporting_exceptions","children","children_total"]},"GleifEntityResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GleifEntityData"}}},"GleifRelationshipsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"child_lei":{"anyOf":[{"type":"string"},{"type":"null"}]},"parent_lei":{"anyOf":[{"type":"string"},{"type":"null"}]},"relationship_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"include_inactive":{"type":"boolean"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"relationships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The child's LEI and the relationship type, joined by a colon. The key: a child reports one parent per type."},"child_lei":{"type":"string","description":"The LEI of the entity that reports the relationship (the subsidiary, the fund, the branch)."},"parent_lei":{"type":"string","description":"The LEI of the parent: the consolidating entity, the fund manager, the umbrella fund, the head office."},"relationship_type":{"type":"string","description":"`IS_DIRECTLY_CONSOLIDATED_BY`, `IS_ULTIMATELY_CONSOLIDATED_BY`, `IS_INTERNATIONAL_BRANCH_OF`, `IS_FUND-MANAGED_BY`, `IS_SUBFUND_OF` or `IS_FEEDER_TO`."},"relationship_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ACTIVE` or `INACTIVE`."},"periods":{"type":"array","items":{"type":"object","properties":{"start_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["start_date","end_date","type"]},"description":"`RELATIONSHIP_PERIOD`, `ACCOUNTING_PERIOD`, `DOCUMENT_FILING_PERIOD`."},"qualifiers":{"type":"array","items":{"type":"object","properties":{"dimension":{"anyOf":[{"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["dimension","category"]},"description":"e.g. the accounting standard, `IFRS` or `US_GAAP`."},"quantifiers":{"type":"array","items":{"type":"object","properties":{"method":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"string"},{"type":"null"}]},"units":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["method","amount","units"]},"description":"e.g. the percentage of consolidation."},"initial_registration_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_update_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`PUBLISHED`, `LAPSED`, `PENDING_ARCHIVAL`…"},"next_renewal_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"managing_lou":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_sources":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_documents":{"anyOf":[{"type":"string"},{"type":"null"}]},"validation_reference":{"anyOf":[{"type":"string"},{"type":"null"}]},"current":{"type":"boolean","description":"False once GLEIF has withdrawn the relationship."},"withdrawn_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When GLEIF withdrew the relationship, if it has."}},"required":["id","child_lei","parent_lei","relationship_type","relationship_status","periods","qualifiers","quantifiers","initial_registration_date","last_update_date","registration_status","next_renewal_date","managing_lou","validation_sources","validation_documents","validation_reference","current","withdrawn_at"]}}},"required":["as_of","child_lei","parent_lei","relationship_type","include_inactive","total","total_is_exact","page","per_page","total_pages","count","relationships"]},"GleifRelationshipsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GleifRelationshipsSearchData"}}},"WorldBankIndicatorsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"topic":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"indicator_code":{"type":"string","description":"The World Development Indicators code, e.g. \"SI.POV.GINI\". It is what `indicator_code` takes on the values endpoint."},"indicator":{"type":"string","description":"The indicator's name, e.g. \"Gini index\", \"Unemployment, total (% of total labor force) (modeled ILO estimate)\"."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit, as the name states it in its last parentheses, e.g. \"% of GDP\", \"current US$\". Null when the name states none (an index, a count)."},"topics":{"type":"array","items":{"type":"string"},"description":"The World Bank's topics for the indicator, by name, e.g. [\"Poverty\"]. Empty for a few indicators the World Bank files under none."},"source_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The World Bank's definition of the indicator and how it is computed."},"source_organization":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who produces the underlying data, as the World Bank credits it."}},"required":["indicator_code","indicator","unit","topics","source_note","source_organization"]}}},"required":["as_of","query","topic","total","total_is_exact","page","per_page","total_pages","count","results"]},"WorldBankIndicatorsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WorldBankIndicatorsSearchData"}}},"WorldBankIndicatorValuesData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"indicator_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"year_from":{"anyOf":[{"type":"number"},{"type":"null"}]},"year_to":{"anyOf":[{"type":"number"},{"type":"null"}]},"indicator":{"anyOf":[{"type":"object","properties":{"indicator_code":{"type":"string","description":"The World Development Indicators code, e.g. \"SI.POV.GINI\". It is what `indicator_code` takes on the values endpoint."},"indicator":{"type":"string","description":"The indicator's name, e.g. \"Gini index\", \"Unemployment, total (% of total labor force) (modeled ILO estimate)\"."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit, as the name states it in its last parentheses, e.g. \"% of GDP\", \"current US$\". Null when the name states none (an index, a count)."},"topics":{"type":"array","items":{"type":"string"},"description":"The World Bank's topics for the indicator, by name, e.g. [\"Poverty\"]. Empty for a few indicators the World Bank files under none."},"source_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The World Bank's definition of the indicator and how it is computed."},"source_organization":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who produces the underlying data, as the World Bank credits it."}},"required":["indicator_code","indicator","unit","topics","source_note","source_organization"]},{"type":"null"}],"description":"The indicator's definition, when `indicator_code` names one."},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The country, the indicator and the year, e.g. \"COL:SI.POV.GINI:2024\"."},"country_code":{"type":"string","description":"ISO 3166-1 three-letter code of the economy, e.g. \"COL\"."},"country":{"type":"string","description":"The economy's name as the World Bank writes it, e.g. \"Colombia\", \"Venezuela, RB\"."},"indicator_code":{"type":"string","description":"The indicator's code, e.g. \"SI.POV.GINI\"."},"indicator":{"type":"string","description":"The indicator's name, e.g. \"Gini index\"."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit, as the indicator's name states it, e.g. \"% of population\". Null when the name states none."},"year":{"type":"number","description":"The year the value refers to."},"value":{"type":"number","description":"The value. Years without a value are not listed."},"decimals":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How many decimals the World Bank shows for the indicator."},"obs_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The World Bank's status flag for the value, when it sets one (an estimate, a forecast)."}},"required":["id","country_code","country","indicator_code","indicator","unit","year","value","decimals","obs_status"]}}},"required":["as_of","indicator_code","country_code","year","year_from","year_to","indicator","total","total_is_exact","page","per_page","total_pages","count","results"]},"WorldBankIndicatorValuesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WorldBankIndicatorValuesData"}}},"WorldBankPovertyData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"year_from":{"anyOf":[{"type":"number"},{"type":"null"}]},"year_to":{"anyOf":[{"type":"number"},{"type":"null"}]},"reporting_level":{"anyOf":[{"type":"string"},{"type":"null"}]},"welfare_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The country, the year, the coverage and the welfare measure, e.g. \"COL:2024:national:income\"."},"country_code":{"type":"string","description":"ISO 3166-1 three-letter code, e.g. \"COL\"."},"country":{"type":"string","description":"The country's name, e.g. \"Colombia\"."},"region_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The World Bank region, e.g. \"LCN\" (Latin America and the Caribbean)."},"year":{"type":"number","description":"The year the estimate refers to."},"survey_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of the household survey behind the estimate; a fraction when the fieldwork spans two years (e.g. 2019.5)."},"survey_acronym":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The household survey, e.g. \"GEIH\" (Colombia), \"PNADC\" (Brazil), \"ENIGH\" (Mexico)."},"survey_coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the survey covers: \"national\", \"urban\" or \"rural\"."},"reporting_level":{"type":"string","description":"The coverage of this estimate: \"national\", \"urban\" or \"rural\"."},"welfare_type":{"type":"string","description":"The welfare measure: \"income\" or \"consumption\"."},"comparable_spell":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The run of years whose surveys are comparable with this one, e.g. \"2021 - 2024\". Compare across years only within a spell."},"headcount_300":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the population living below $3.00 a day per person (2021 PPP), from 0 to 1."},"headcount_420":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the population living below $4.20 a day per person (2021 PPP), from 0 to 1."},"headcount_830":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the population living below $8.30 a day per person (2021 PPP), from 0 to 1."},"poverty_gap_300":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Poverty gap at $3.00 a day: the mean shortfall below the line as a share of it, from 0 to 1."},"poverty_gap_420":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Poverty gap at $4.20 a day: the mean shortfall below the line as a share of it, from 0 to 1."},"poverty_gap_830":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Poverty gap at $8.30 a day: the mean shortfall below the line as a share of it, from 0 to 1."},"gini":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Gini index of the welfare distribution, from 0 (equality) to 1."},"mean":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean welfare, in 2021 PPP dollars a day per person."},"median":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Median welfare, in 2021 PPP dollars a day per person."},"mld":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean log deviation, another inequality measure."},"polarization":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Wolfson polarization index."},"deciles":{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"null"}]},"description":"Share of total welfare held by each tenth of the population, poorest first."},"societal_poverty_line":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The societal poverty line for the year, in 2021 PPP dollars a day."},"population":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The population the estimate covers."},"is_interpolated":{"type":"boolean","description":"True when the estimate is interpolated between surveys rather than read from one."},"estimation_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"survey\" when read from a survey of that year, otherwise how it was estimated."},"distribution_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"micro\" (survey microdata), \"group\" (grouped data) or \"aggregate\"."}},"required":["id","country_code","country","region_code","year","survey_year","survey_acronym","survey_coverage","reporting_level","welfare_type","comparable_spell","headcount_300","headcount_420","headcount_830","poverty_gap_300","poverty_gap_420","poverty_gap_830","gini","mean","median","mld","polarization","deciles","societal_poverty_line","population","is_interpolated","estimation_type","distribution_type"]}}},"required":["as_of","country_code","year","year_from","year_to","reporting_level","welfare_type","total","total_is_exact","page","per_page","total_pages","count","results"]},"WorldBankPovertyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WorldBankPovertyData"}}},"NyCorporationsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Entities matching the filters, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"corporations":{"type":"array","items":{"type":"object","properties":{"dos_id":{"type":"string","description":"The Department of State's id for the entity. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's current name; null on the rare row the register publishes without one."},"initial_filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the entity first filed with the Department of State (yyyy-mm-dd)."},"county":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The New York county of the entity's office, upper-cased."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the entity was formed, upper-cased: `NEW YORK`, or the state or country of a foreign entity, e.g. `DELAWARE`."},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `DOMESTIC BUSINESS CORPORATION`, `DOMESTIC LIMITED LIABILITY COMPANY`, `FOREIGN LIMITED LIABILITY COMPANY`."},"process":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","address_1","address_2","city","state","zip"]},{"type":"null"}],"description":"The name and address the Department of State mails service of process to."},"chief_executive":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","address_1","address_2","city","state","zip"]},{"type":"null"}],"description":"The chief executive officer, when the entity reports one."},"registered_agent":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","address_1","address_2","city","state","zip"]},{"type":"null"}],"description":"The registered agent, when the entity has one."},"location":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","address_1","address_2","city","state","zip"]},{"type":"null"}],"description":"The entity's principal executive office, when reported."}},"required":["dos_id","name","initial_filing_date","county","jurisdiction","entity_type","process","chief_executive","registered_agent","location"]}}},"required":["as_of","query","entity_type","county","jurisdiction","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","corporations"]},"NyCorporationsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/NyCorporationsSearchData"}}},"NyCorporationData":{"type":"object","properties":{"found":{"type":"boolean"},"dos_id":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"corporation":{"anyOf":[{"type":"object","properties":{"dos_id":{"type":"string","description":"The Department of State's id for the entity. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's current name; null on the rare row the register publishes without one."},"initial_filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the entity first filed with the Department of State (yyyy-mm-dd)."},"county":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The New York county of the entity's office, upper-cased."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the entity was formed, upper-cased: `NEW YORK`, or the state or country of a foreign entity, e.g. `DELAWARE`."},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `DOMESTIC BUSINESS CORPORATION`, `DOMESTIC LIMITED LIABILITY COMPANY`, `FOREIGN LIMITED LIABILITY COMPANY`."},"process":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","address_1","address_2","city","state","zip"]},{"type":"null"}],"description":"The name and address the Department of State mails service of process to."},"chief_executive":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","address_1","address_2","city","state","zip"]},{"type":"null"}],"description":"The chief executive officer, when the entity reports one."},"registered_agent":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","address_1","address_2","city","state","zip"]},{"type":"null"}],"description":"The registered agent, when the entity has one."},"location":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"address_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","address_1","address_2","city","state","zip"]},{"type":"null"}],"description":"The entity's principal executive office, when reported."}},"required":["dos_id","name","initial_filing_date","county","jurisdiction","entity_type","process","chief_executive","registered_agent","location"]},{"type":"null"}]}},"required":["found","dos_id","as_of","corporation"]},"NyCorporationResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/NyCorporationData"}}},"ColoradoEntitiesSearchData":{"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"}]},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Entities matching the filters, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","description":"The Secretary of State's id for the entity. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's name; null on the rare row the register publishes without one."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Upper-cased, e.g. `GOOD STANDING`, `DELINQUENT`, `VOLUNTARILY DISSOLVED`, `ADMINISTRATIVELY DISSOLVED`, `WITHDRAWN`, `NONCOMPLIANT`, `REVOKED`, `MERGED`, `CONVERTED`."},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Upper-cased, e.g. `LIMITED LIABILITY COMPANY`, `CORPORATION`, `NONPROFIT CORPORATION`."},"jurisdiction_of_formation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the entity was formed, upper-cased, e.g. `CO`, `DE`."},"formation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the entity was formed or registered in Colorado (yyyy-mm-dd)."},"principal_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"mailing_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"agent":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agent's name: the organization, or the person's first, middle and last name and suffix."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"organization_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"principal_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"mailing_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]}},"required":["name","first_name","middle_name","last_name","suffix","organization_name","principal_address","mailing_address"]},{"type":"null"}],"description":"The registered agent, when the entity has one."}},"required":["entity_id","name","status","entity_type","jurisdiction_of_formation","formation_date","principal_address","mailing_address","agent"]}}},"required":["as_of","query","status","entity_type","jurisdiction","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","entities"]},"ColoradoEntitiesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ColoradoEntitiesSearchData"}}},"ColoradoEntityData":{"type":"object","properties":{"found":{"type":"boolean"},"entity_id":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"entity":{"anyOf":[{"type":"object","properties":{"entity_id":{"type":"string","description":"The Secretary of State's id for the entity. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's name; null on the rare row the register publishes without one."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Upper-cased, e.g. `GOOD STANDING`, `DELINQUENT`, `VOLUNTARILY DISSOLVED`, `ADMINISTRATIVELY DISSOLVED`, `WITHDRAWN`, `NONCOMPLIANT`, `REVOKED`, `MERGED`, `CONVERTED`."},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Upper-cased, e.g. `LIMITED LIABILITY COMPANY`, `CORPORATION`, `NONPROFIT CORPORATION`."},"jurisdiction_of_formation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the entity was formed, upper-cased, e.g. `CO`, `DE`."},"formation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the entity was formed or registered in Colorado (yyyy-mm-dd)."},"principal_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"mailing_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"agent":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agent's name: the organization, or the person's first, middle and last name and suffix."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"organization_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"principal_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]},"mailing_address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","country"]},{"type":"null"}]}},"required":["name","first_name","middle_name","last_name","suffix","organization_name","principal_address","mailing_address"]},{"type":"null"}],"description":"The registered agent, when the entity has one."}},"required":["entity_id","name","status","entity_type","jurisdiction_of_formation","formation_date","principal_address","mailing_address","agent"]},{"type":"null"}]}},"required":["found","entity_id","as_of","entity"]},"ColoradoEntityResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ColoradoEntityData"}}},"CtBusinessesSearchData":{"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"}]},"business_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Businesses matching the filters, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"businesses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The register's id for the business record. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's name; null on the rare row the register publishes without one."},"business_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Upper-cased, e.g. `LLC`, `STOCK`, `NON-STOCK`, `LIMITED PARTNERSHIP`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Upper-cased, e.g. `ACTIVE`, `FORFEITED`, `DISSOLVED`, `WITHDRAWN`, `REVOKED`, `MERGED`."},"sub_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's account number with the Secretary of the State (7 digits)."},"date_registration":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the business registered (yyyy-mm-dd)."},"annual_report_due_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"began_transacting_in_ct":{"anyOf":[{"type":"string"},{"type":"null"}]},"date_of_organization_meeting":{"anyOf":[{"type":"string"},{"type":"null"}]},"dissolution_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason_for_administrative":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why the Secretary acted administratively, when recorded."},"business_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_name_in_state_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a foreign business, its name where it was formed."},"citizenship":{"anyOf":[{"type":"string"},{"type":"null"}]},"country_formation":{"anyOf":[{"type":"string"},{"type":"null"}]},"formation_place":{"anyOf":[{"type":"string"},{"type":"null"}]},"state_or_territory_formation":{"anyOf":[{"type":"string"},{"type":"null"}]},"billing_address":{"anyOf":[{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","unit","city","state","postal_code","country"]},{"type":"null"}]},"records_address":{"anyOf":[{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","unit","city","state","postal_code","country"]},{"type":"null"}]},"record_address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The records address as one line, as the register writes it."},"mail_jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_international_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_3":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_4":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction_3":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction_4":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_in_jurisdiction_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's NAICS industry code, when reported."},"naics_sub_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"woman_owned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The business's answer to the Secretary's ownership survey: woman-owned."},"veteran_owned":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"minority_owned":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"disability_owned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Owned by persons with disabilities."},"lgbtqi_owned":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"category_survey_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"total_authorized_shares":{"anyOf":[{"type":"number"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","name","business_type","status","sub_status","account_number","date_registration","annual_report_due_date","began_transacting_in_ct","date_of_organization_meeting","dissolution_date","reason_for_administrative","business_email","business_name_in_state_country","citizenship","country_formation","formation_place","state_or_territory_formation","billing_address","records_address","record_address","mail_jurisdiction","mailing_address","mailing_international_address","mailing_jurisdiction_address","mailing_jurisdiction","mailing_jurisdiction_1","mailing_jurisdiction_2","mailing_jurisdiction_3","mailing_jurisdiction_4","mailing_jurisdiction_country","office_jurisdiction_address","office_jurisdiction","office_jurisdiction_1","office_jurisdiction_2","office_jurisdiction_3","office_jurisdiction_4","office_in_jurisdiction_country","naics_code","naics_sub_code","woman_owned","veteran_owned","minority_owned","disability_owned","lgbtqi_owned","category_survey_email","total_authorized_shares","latitude","longitude"]}}},"required":["as_of","query","status","business_type","account_number","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","businesses"]},"CtBusinessesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CtBusinessesSearchData"}}},"CtBusinessData":{"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."},"business":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The register's id for the business record. The key."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's name; null on the rare row the register publishes without one."},"business_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Upper-cased, e.g. `LLC`, `STOCK`, `NON-STOCK`, `LIMITED PARTNERSHIP`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Upper-cased, e.g. `ACTIVE`, `FORFEITED`, `DISSOLVED`, `WITHDRAWN`, `REVOKED`, `MERGED`."},"sub_status":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's account number with the Secretary of the State (7 digits)."},"date_registration":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the business registered (yyyy-mm-dd)."},"annual_report_due_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"began_transacting_in_ct":{"anyOf":[{"type":"string"},{"type":"null"}]},"date_of_organization_meeting":{"anyOf":[{"type":"string"},{"type":"null"}]},"dissolution_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason_for_administrative":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why the Secretary acted administratively, when recorded."},"business_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_name_in_state_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a foreign business, its name where it was formed."},"citizenship":{"anyOf":[{"type":"string"},{"type":"null"}]},"country_formation":{"anyOf":[{"type":"string"},{"type":"null"}]},"formation_place":{"anyOf":[{"type":"string"},{"type":"null"}]},"state_or_territory_formation":{"anyOf":[{"type":"string"},{"type":"null"}]},"billing_address":{"anyOf":[{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","unit","city","state","postal_code","country"]},{"type":"null"}]},"records_address":{"anyOf":[{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","unit","city","state","postal_code","country"]},{"type":"null"}]},"record_address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The records address as one line, as the register writes it."},"mail_jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_international_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_3":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_4":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_jurisdiction_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction_address":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction_3":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_jurisdiction_4":{"anyOf":[{"type":"string"},{"type":"null"}]},"office_in_jurisdiction_country":{"anyOf":[{"type":"string"},{"type":"null"}]},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's NAICS industry code, when reported."},"naics_sub_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"woman_owned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The business's answer to the Secretary's ownership survey: woman-owned."},"veteran_owned":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"minority_owned":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"disability_owned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Owned by persons with disabilities."},"lgbtqi_owned":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"category_survey_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"total_authorized_shares":{"anyOf":[{"type":"number"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","name","business_type","status","sub_status","account_number","date_registration","annual_report_due_date","began_transacting_in_ct","date_of_organization_meeting","dissolution_date","reason_for_administrative","business_email","business_name_in_state_country","citizenship","country_formation","formation_place","state_or_territory_formation","billing_address","records_address","record_address","mail_jurisdiction","mailing_address","mailing_international_address","mailing_jurisdiction_address","mailing_jurisdiction","mailing_jurisdiction_1","mailing_jurisdiction_2","mailing_jurisdiction_3","mailing_jurisdiction_4","mailing_jurisdiction_country","office_jurisdiction_address","office_jurisdiction","office_jurisdiction_1","office_jurisdiction_2","office_jurisdiction_3","office_jurisdiction_4","office_in_jurisdiction_country","naics_code","naics_sub_code","woman_owned","veteran_owned","minority_owned","disability_owned","lgbtqi_owned","category_survey_email","total_authorized_shares","latitude","longitude"]},{"type":"null"}]},"principals":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The business record's id and a code for the principal's row. The key."},"business_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id of the business record the principal belongs to; null on the few rows the register publishes without one."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The principal's name as the register writes it."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"designation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `Officer`, `Director`, or both; often empty."},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_address":{"anyOf":[{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_3":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"international":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","line_3","city","state","zip","country","international"]},{"type":"null"}]}},"required":["id","business_id","name","first_name","middle_name","last_name","suffix","designation","type","business_address"]},"description":"Up to 200 principals the business reports."},"principals_total":{"type":"number"},"agents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The business record's id and a code for the agent's row. The key."},"business_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id of the business record the agent serves."},"business_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's account number, as the agents table writes it."},"agent_account":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agent firm's account, when the agent is a business."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Individual`, `Business` or `Secretary of the State`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_address":{"anyOf":[{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_3":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"international":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","line_3","city","state","zip","country","international"]},{"type":"null"}]},"business_address_text":{"anyOf":[{"type":"string"},{"type":"null"}]},"mailing_address":{"anyOf":[{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_3":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"international":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","line_3","city","state","zip","country","international"]},{"type":"null"}]},"mailing_address_text":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","business_id","business_account_number","agent_account","type","name","first_name","middle_name","last_name","suffix","phone","email","business_address","business_address_text","mailing_address","mailing_address_text"]}}},"required":["found","id","as_of","business","principals","principals_total","agents"]},"CtBusinessResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CtBusinessData"}}},"CtPrincipalsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"principals":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The business record's id and a code for the principal's row. The key."},"business_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id of the business record the principal belongs to; null on the few rows the register publishes without one."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The principal's name as the register writes it."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"designation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `Officer`, `Director`, or both; often empty."},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_address":{"anyOf":[{"type":"object","properties":{"line_1":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_2":{"anyOf":[{"type":"string"},{"type":"null"}]},"line_3":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"international":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","line_3","city","state","zip","country","international"]},{"type":"null"}]},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","business_id","name","first_name","middle_name","last_name","suffix","designation","type","business_address","business_name","business_status"]}}},"required":["as_of","query","total","total_is_exact","page","per_page","total_pages","count","principals"]},"CtPrincipalsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CtPrincipalsSearchData"}}},"ColoradoUccDebtorsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"organization_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Debtor listings matching, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"debtors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The debtor listing's id. The key; a second row the Secretary publishes under the same id with different content is kept as `<id>-2`."},"debtor_id":{"type":"string"},"file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing that lists the debtor."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The organization's name, or the person's first, middle and last name and suffix."},"organization_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip_4":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","zip_4","country"]},{"type":"null"}]},"organization_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As the filer wrote it, e.g. `CORPORATION`, `LLC`."},"organization_jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"organization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The organization's id as the filer wrote it; for a Colorado entity, often its id with the Secretary of State."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `transmitting utility`, `collateral held in a trust`, `decedent's estate`."},"action_type_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"action_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the filing did to this row: `add`, `change only`, `delete only`, `change and delete`."},"action_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The row a change or delete refers to, when the Secretary records it."},"record_status_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"record_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`active` or `inactive`: whether this listing is current, not whether the lien is."},"efs_unique_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing":{"anyOf":[{"type":"object","properties":{"filing_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"transaction_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["filing_number","transaction_type","document_type","filing_date"]},{"type":"null"}],"description":"The filing that lists this party."},"lien":{"anyOf":[{"type":"object","properties":{"initial_filing_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien's initial filing was made."},"filings":{"type":"number","description":"Filings the lien has: the initial one and every amendment."},"lapse_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien lapses unless continued (yyyy-mm-dd); null when the Secretary records none, as for most tax, hospital and statutory liens."},"terminated":{"type":"boolean","description":"A filing of the lien terminated or released it."},"in_force":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Computed by Croma when the response is served: false once terminated or past its lapse date, true while neither, null when the lien has no lapse date and no termination."}},"required":["initial_filing_number","filing_type","filed_date","filings","lapse_date","terminated","in_force"]},{"type":"null"}]}},"required":["id","debtor_id","file_id","name","organization_name","first_name","middle_name","last_name","suffix","address","organization_type","organization_jurisdiction","organization_id","description","action_type_code","action_type","action_reference_id","record_status_code","record_status","efs_unique_id","filing","lien"]}}},"required":["as_of","query","organization_id","total","total_is_exact","page","per_page","total_pages","count","debtors"]},"ColoradoUccDebtorsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ColoradoUccDebtorsSearchData"}}},"ColoradoUccSecuredPartiesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"total":{"type":"number","description":"Secured-party listings matching, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"secured_parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The secured-party listing's id. The key; a second row the Secretary publishes under the same id with different content is kept as `<id>-2`."},"secured_party_id":{"type":"string"},"file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing that lists the secured party."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The organization's name, or the person's first, middle and last name and suffix."},"organization_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip_4":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","zip_4","country"]},{"type":"null"}]},"assignor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The party assigned its interest to another in this filing."},"action_type_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"action_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the filing did to this row: `add`, `change only`, `delete only`, `change and delete`."},"action_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The row a change or delete refers to, when the Secretary records it."},"record_status_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"record_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`active` or `inactive`: whether this listing is current, not whether the lien is."},"filing":{"anyOf":[{"type":"object","properties":{"filing_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"transaction_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["filing_number","transaction_type","document_type","filing_date"]},{"type":"null"}],"description":"The filing that lists this party."},"lien":{"anyOf":[{"type":"object","properties":{"initial_filing_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien's initial filing was made."},"filings":{"type":"number","description":"Filings the lien has: the initial one and every amendment."},"lapse_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien lapses unless continued (yyyy-mm-dd); null when the Secretary records none, as for most tax, hospital and statutory liens."},"terminated":{"type":"boolean","description":"A filing of the lien terminated or released it."},"in_force":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Computed by Croma when the response is served: false once terminated or past its lapse date, true while neither, null when the lien has no lapse date and no termination."}},"required":["initial_filing_number","filing_type","filed_date","filings","lapse_date","terminated","in_force"]},{"type":"null"}]}},"required":["id","secured_party_id","file_id","name","organization_name","first_name","middle_name","last_name","suffix","address","assignor","action_type_code","action_type","action_reference_id","record_status_code","record_status","filing","lien"]}}},"required":["as_of","query","total","total_is_exact","page","per_page","total_pages","count","secured_parties"]},"ColoradoUccSecuredPartiesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ColoradoUccSecuredPartiesSearchData"}}},"ColoradoUccLienData":{"type":"object","properties":{"found":{"type":"boolean"},"filing_number":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"lien":{"anyOf":[{"type":"object","properties":{"initial_filing_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"lapse_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien lapses unless continued (yyyy-mm-dd); null when the Secretary records none, as for most tax, hospital and statutory liens."},"terminated":{"type":"boolean","description":"A filing of the lien terminated or released it."},"in_force":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Computed by Croma when the response is served: false once terminated or past its lapse date, true while neither, null when the lien has no lapse date and no termination."},"filings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The filing's id. The key; a second row the Secretary publishes under the same id with different content is kept as `<id>-2`."},"file_id":{"type":"string","description":"The Secretary's id for the filing, which the debtor, secured-party and collateral rows carry."},"filing_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing's number, e.g. `20262077023`; older filings read like `2004F012345`."},"initial_filing_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the initial filing this one belongs to. Every filing of one lien carries it."},"transaction_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Initial Filing`, `Amendment`, `Correction` or `Filing Officer Correction`."},"filing_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `ucc`, `lien_irs` (federal tax lien), `lien_hosp` (hospital lien), `efs` (effective financing statement), `lien_othr_stat`."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `UCC financing statement`, `UCC amendment-continuation`, `UCC amendment-termination`, `IRS tax lien`."},"financial_statement_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing was made (yyyy-mm-dd)."},"lapse_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien lapses unless continued (yyyy-mm-dd). The same on every filing of one lien, and moved by a continuation."},"continuation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The filing continues the lien."},"termination":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The filing terminates or releases the lien."},"manufactured_home":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["id","file_id","filing_number","initial_filing_number","transaction_type","filing_type","document_type","financial_statement_type","filing_date","lapse_date","continuation","termination","manufactured_home"]},"description":"Every filing of the lien, oldest first."},"debtors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The debtor listing's id. The key; a second row the Secretary publishes under the same id with different content is kept as `<id>-2`."},"debtor_id":{"type":"string"},"file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing that lists the debtor."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The organization's name, or the person's first, middle and last name and suffix."},"organization_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip_4":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","zip_4","country"]},{"type":"null"}]},"organization_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As the filer wrote it, e.g. `CORPORATION`, `LLC`."},"organization_jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}]},"organization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The organization's id as the filer wrote it; for a Colorado entity, often its id with the Secretary of State."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `transmitting utility`, `collateral held in a trust`, `decedent's estate`."},"action_type_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"action_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the filing did to this row: `add`, `change only`, `delete only`, `change and delete`."},"action_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The row a change or delete refers to, when the Secretary records it."},"record_status_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"record_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`active` or `inactive`: whether this listing is current, not whether the lien is."},"efs_unique_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","debtor_id","file_id","name","organization_name","first_name","middle_name","last_name","suffix","address","organization_type","organization_jurisdiction","organization_id","description","action_type_code","action_type","action_reference_id","record_status_code","record_status","efs_unique_id"]},"description":"Every debtor listing on any of its filings, up to 1,000."},"debtors_total":{"type":"number"},"secured_parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The secured-party listing's id. The key; a second row the Secretary publishes under the same id with different content is kept as `<id>-2`."},"secured_party_id":{"type":"string"},"file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing that lists the secured party."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The organization's name, or the person's first, middle and last name and suffix."},"organization_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"zip_4":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["line_1","line_2","city","state","zip","zip_4","country"]},{"type":"null"}]},"assignor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The party assigned its interest to another in this filing."},"action_type_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"action_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the filing did to this row: `add`, `change only`, `delete only`, `change and delete`."},"action_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The row a change or delete refers to, when the Secretary records it."},"record_status_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"record_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`active` or `inactive`: whether this listing is current, not whether the lien is."}},"required":["id","secured_party_id","file_id","name","organization_name","first_name","middle_name","last_name","suffix","address","assignor","action_type_code","action_type","action_reference_id","record_status_code","record_status"]},"description":"Every secured-party listing on any of its filings, up to 1,000."},"secured_parties_total":{"type":"number"},"collateral":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The collateral statement's id. The key; a second row the Secretary publishes under the same id with different content is kept as `<id>-2`."},"collateral_id":{"type":"string"},"file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing that lists the collateral."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A category, e.g. `General Description`, `EQUIPMENT`, `ACCOUNTS RECEIVABLE/GENERAL INTANGIBLES`, a farm product, or `UNKNOWN`."},"additional_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The collateral as the filer described it, in full."},"county_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"county":{"anyOf":[{"type":"string"},{"type":"null"}]},"farm_product":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"farm_product_all_years":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"farm_product_start_year":{"anyOf":[{"type":"number"},{"type":"null"}]},"farm_product_end_year":{"anyOf":[{"type":"number"},{"type":"null"}]},"action_type_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"action_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the filing did to this row: `add`, `change only`, `delete only`, `change and delete`."},"action_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The row a change or delete refers to, when the Secretary records it."},"record_status_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"record_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`active` or `inactive`: whether this listing is current, not whether the lien is."}},"required":["id","collateral_id","file_id","description","additional_description","county_id","county","farm_product","farm_product_all_years","farm_product_start_year","farm_product_end_year","action_type_code","action_type","action_reference_id","record_status_code","record_status"]},"description":"Every collateral statement on any of its filings, up to 1,000."},"collateral_total":{"type":"number"}},"required":["initial_filing_number","filing_type","filed_date","lapse_date","terminated","in_force","filings","debtors","debtors_total","secured_parties","secured_parties_total","collateral","collateral_total"]},{"type":"null"}]}},"required":["found","filing_number","as_of","lien"]},"ColoradoUccLienResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ColoradoUccLienData"}}},"CtUccLiensSearchData":{"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"}]},"lien_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Liens matching the filters, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"liens":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The lien's number; `filing-<number>` for the few filings the Secretary publishes without one. The key."},"lien_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filing's number, which every later filing of the lien carries."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Upper-cased: `ACTIVE`, `RELEASED` or `TERMINATED`."},"lien_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `OFS` (a financing statement), `MUNICIPAL`, `IRS`, `LABOR`, `DEPT REV SERVS`, `TRANS UTILITY`, `VESSEL`, `JUDGMENT`."},"lapse_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien lapses unless continued (yyyy-mm-dd). `9999-12-31` means it does not lapse."},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien's first filing was accepted (yyyy-mm-dd)."},"last_filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When its latest filing was accepted (yyyy-mm-dd)."},"filing_numbers":{"type":"array","items":{"type":"string"},"description":"Every filing number of the lien."},"debtor_names":{"type":"array","items":{"type":"string"},"description":"Every debtor's name, across its filings."},"secured_party_names":{"type":"array","items":{"type":"string"},"description":"Every secured party's name, across its filings."},"filings":{"type":"array","items":{"type":"object","properties":{"filing_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing's own number; on the original filing, the lien's."},"filing_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `ORIG FIN STMT`, `AMENDMENT`, `CONTINUATION`, `RELEASE`, `TERMINATION`, `ASSIGNMENT`, `VESSEL LIEN`, `JUDGMENT LIEN`."},"accepted_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Secretary accepted the filing (yyyy-mm-dd)."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"volume":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The book volume of an older filing, when recorded."},"start_page":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The page in that volume."},"debtors":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's name, or the person's first, middle and last name and suffix."},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]},{"type":"null"}]}},"required":["name","business_name","prefix","first_name","middle_name","last_name","suffix","address"]}},"secured_parties":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's name, or the person's first, middle and last name and suffix."},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]},{"type":"null"}]}},"required":["name","business_name","prefix","first_name","middle_name","last_name","suffix","address"]}},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our byte-identical copy of the filing's document; null until it is copied, or when the Secretary publishes none."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Secretary's own link to the document."},"document_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name the Secretary published the document under."}},"required":["filing_number","filing_type","accepted_date","pages","volume","start_page","debtors","secured_parties","document_url","source_document_url","document_name"]},"description":"Every filing of the lien, oldest first, each with the debtors and secured parties it lists and its document."},"in_force":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Computed by Croma when the response is served: true while the lien is `ACTIVE` and not past its lapse date, false otherwise, null when it has no lapse date on record."}},"required":["id","lien_number","status","lien_type","lapse_date","filed_date","last_filed_date","filing_numbers","debtor_names","secured_party_names","filings","in_force"]}}},"required":["as_of","query","status","lien_type","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","liens"]},"CtUccLiensSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CtUccLiensSearchData"}}},"CtUccLienData":{"type":"object","properties":{"found":{"type":"boolean"},"filing_number":{"type":"string"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"lien":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The lien's number; `filing-<number>` for the few filings the Secretary publishes without one. The key."},"lien_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filing's number, which every later filing of the lien carries."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Upper-cased: `ACTIVE`, `RELEASED` or `TERMINATED`."},"lien_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `OFS` (a financing statement), `MUNICIPAL`, `IRS`, `LABOR`, `DEPT REV SERVS`, `TRANS UTILITY`, `VESSEL`, `JUDGMENT`."},"lapse_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien lapses unless continued (yyyy-mm-dd). `9999-12-31` means it does not lapse."},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the lien's first filing was accepted (yyyy-mm-dd)."},"last_filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When its latest filing was accepted (yyyy-mm-dd)."},"filing_numbers":{"type":"array","items":{"type":"string"},"description":"Every filing number of the lien."},"debtor_names":{"type":"array","items":{"type":"string"},"description":"Every debtor's name, across its filings."},"secured_party_names":{"type":"array","items":{"type":"string"},"description":"Every secured party's name, across its filings."},"filings":{"type":"array","items":{"type":"object","properties":{"filing_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing's own number; on the original filing, the lien's."},"filing_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `ORIG FIN STMT`, `AMENDMENT`, `CONTINUATION`, `RELEASE`, `TERMINATION`, `ASSIGNMENT`, `VESSEL LIEN`, `JUDGMENT LIEN`."},"accepted_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Secretary accepted the filing (yyyy-mm-dd)."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"volume":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The book volume of an older filing, when recorded."},"start_page":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The page in that volume."},"debtors":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's name, or the person's first, middle and last name and suffix."},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]},{"type":"null"}]}},"required":["name","business_name","prefix","first_name","middle_name","last_name","suffix","address"]}},"secured_parties":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's name, or the person's first, middle and last name and suffix."},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"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"}]},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street_1","street_2","city","state","zip"]},{"type":"null"}]}},"required":["name","business_name","prefix","first_name","middle_name","last_name","suffix","address"]}},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our byte-identical copy of the filing's document; null until it is copied, or when the Secretary publishes none."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Secretary's own link to the document."},"document_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name the Secretary published the document under."}},"required":["filing_number","filing_type","accepted_date","pages","volume","start_page","debtors","secured_parties","document_url","source_document_url","document_name"]},"description":"Every filing of the lien, oldest first, each with the debtors and secured parties it lists and its document."},"in_force":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Computed by Croma when the response is served: true while the lien is `ACTIVE` and not past its lapse date, false otherwise, null when it has no lapse date on record."}},"required":["id","lien_number","status","lien_type","lapse_date","filed_date","last_filed_date","filing_numbers","debtor_names","secured_party_names","filings","in_force"]},{"type":"null"}]}},"required":["found","filing_number","as_of","lien"]},"CtUccLienResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CtUccLienData"}}},"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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"active":{"type":"number","description":"How many of them are `active`: a person or company's standing at a glance. Counted up to 1000, like `total`."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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"}}},"IbgeTablesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the catalog in this response is."},"query":{"type":"string"},"total":{"type":"number","description":"Tables matching the filters, across every page, counted up to 1000."},"total_is_exact":{"type":"boolean"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"tables":{"type":"array","items":{"type":"object","properties":{"table_id":{"type":"string","description":"The table's number: pass it to `ibge-table-values`."},"name":{"type":"string","description":"The table's title, as IBGE publishes it."},"survey_id":{"type":"string","description":"IBGE's two-character code for the survey or study."},"survey":{"type":"string","description":"The survey or study the table comes from, e.g. `Pesquisa Nacional por Amostra de Domicílios Contínua trimestral`."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subject, as IBGE names it, e.g. `Trabalho`."},"periodicity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How often the table is published: `monthly`, `quarterly`, `annual`, or a rarer cadence."},"period_start":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The first period the table has, e.g. `201201` (first quarter of 2012) or `2002`."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The last period the table had when the catalog was last read."},"territory_levels":{"type":"array","items":{"type":"string"},"description":"The levels the table has data for: `country`, `region`, `state`, `municipality`, and finer or special ones such as `metro_area`."},"variables":{"type":"array","items":{"type":"object","properties":{"variable_id":{"type":"string","description":"The variable's number: pass it in `variable_ids`."},"name":{"type":"string","description":"What the variable measures, as IBGE names it."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its unit, e.g. `%`, `Mil Reais`, `Pessoas`."}},"required":["variable_id","name","unit"]}},"classifications":{"type":"array","items":{"type":"object","properties":{"classification_id":{"type":"string","description":"The classification's number: the key in `classifications`."},"name":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"category_id":{"type":"string","description":"The category's number: pass it in `classifications`."},"name":{"type":"string"},"level":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Depth in the classification's hierarchy: 0 is the total."}},"required":["category_id","name","level"]}}},"required":["classification_id","name","categories"]},"description":"The breakdowns the table offers (sex, age group, product...) and each one's categories."},"source_url":{"type":"string","description":"The table's page at IBGE."}},"required":["table_id","name","survey_id","survey","subject","periodicity","period_start","period_end","territory_levels","variables","classifications","source_url"]}}},"required":["as_of","query","total","total_is_exact","page","per_page","total_pages","count","tables"]},"IbgeTablesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IbgeTablesSearchData"}}},"IbgeTableValuesData":{"type":"object","properties":{"found":{"type":"boolean","description":"false when the table does not exist or has no values for this request."},"table_id":{"type":"string"},"table_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"survey":{"anyOf":[{"type":"string"},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string"},{"type":"null"}]},"territory_level":{"type":"string","enum":["country","region","state","municipality"]},"period":{"type":"string","description":"The period asked for, echoed back."},"periods":{"type":"array","items":{"type":"object","properties":{"period":{"type":"string"},"name":{"type":"string","description":"The period as IBGE names it, e.g. `2º trimestre 2026`."}},"required":["period","name"]},"description":"The periods the values cover, oldest first."},"variables":{"type":"array","items":{"type":"object","properties":{"variable_id":{"type":"string","description":"The variable's number: pass it in `variable_ids`."},"name":{"type":"string","description":"What the variable measures, as IBGE names it."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its unit, e.g. `%`, `Mil Reais`, `Pessoas`."}},"required":["variable_id","name","unit"]},"description":"The variables the values belong to."},"count":{"type":"integer"},"values":{"type":"array","items":{"type":"object","properties":{"territory_level":{"type":"string","enum":["country","region","state","municipality"]},"territory_code":{"type":"string","description":"The territory's IBGE code: `1` for Brazil, 1 digit for a region, 2 for a state, 7 for a municipality."},"territory_name":{"type":"string"},"variable_id":{"type":"string"},"period":{"type":"string","description":"The period's code, e.g. `202602` or `2023`; its name is in `periods`."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value, or null when IBGE publishes none for this cell (see `value_note`)."},"value_note":{"anyOf":[{"type":"string","enum":["zero","not_applicable","not_available","suppressed"]},{"type":"null"}],"description":"Why a value is special: `zero` (a true zero), `not_applicable`, `not_available`, or `suppressed` (withheld to protect respondents)."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"categories":{"type":"array","items":{"type":"object","properties":{"classification_id":{"type":"string"},"category_id":{"type":"string"},"category_name":{"type":"string"}},"required":["classification_id","category_id","category_name"]},"description":"The category of each classification this value belongs to."}},"required":["territory_level","territory_code","territory_name","variable_id","period","value","value_note","unit","categories"]}},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"checked_at":{"type":"string","description":"When this answer was read from IBGE, as an ISO timestamp."}},"required":["found","table_id","table_name","survey","periodicity","territory_level","period","periods","variables","count","values","source_url","checked_at"]},"IbgeTableValuesResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/IbgeTableValuesData"}}},"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"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","total_is_exact","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"}}},"CregActsSearchData":{"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"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"issued_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier: family, number and year, e.g. `resolucion_101-128_2026` (Resolución CREG 101 128 de 2026), `resolucion_131_1998`, `circular_345_2026`, `concepto_6838_2026`, `auto_939_2026`. Draft resolutions share the `resolucion` family with the resolutions they become."},"kind":{"type":"string","enum":["resolution","particular_resolution","draft_resolution","circular","legal_opinion","order"],"description":"`resolution` (resolución de carácter general), `particular_resolution` (resolución de carácter particular: a decision about one company or one tariff), `draft_resolution` (proyecto de resolución under public consultation), `circular`, `legal_opinion` (concepto jurídico) or `order` (auto de inicio of an administrative proceeding)."},"number":{"type":"string","description":"The number as the CREG prints it: \"101 128\", \"131\", \"345\", \"6838\", \"502 120D\"."},"year":{"type":"number","description":"The year in the act's designation."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the act does, in the CREG's own words: the epígrafe of a resolution, the subject of a circular or a concepto."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act is dated."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the CREG published the act on its site. Null for older acts, which record only their Diario Oficial date."},"gazette":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Diario Oficial reference as the CREG prints it, e.g. \"Diario Oficial No. 53.620 de 9 de septiembre de 2026\". Null when the act was not published there."},"gazette_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the Diario Oficial issue that published the act."},"text_status":{"type":"string","enum":["ok","missing"],"description":"`ok` when the full text is here; `missing` when the CREG publishes the act only as a file this dataset could not read the text of."},"amendments":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"The note as the CREG writes it, e.g. `Modificada por la Resolución 38 de 2010, publicada en el Diario Oficial No. 47.645 de 8 de marzo de 2010, '...'`."},"act_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The `id` of the act the note refers to, when it is one of this dataset's acts."}},"required":["description","act_id"]},"description":"The CREG's own notes on later acts that modified, added to or repealed this one (notas de vigencia). Empty when it records none."},"official_url":{"type":"string","description":"The act on the CREG's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the act's main document (its PDF, or the Word file when the CREG publishes no PDF), byte for byte as the CREG published it. Null when it publishes no file."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's main document on the CREG's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the CREG published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `docx`, `doc`, `xlsx`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as the CREG published it. Null when the CREG's link no longer answers."},"source_document_url":{"type":"string","description":"The file on the CREG's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file the CREG publishes with the act: the act itself as PDF and Word, technical memos, annexes, comment matrices."},"source_modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the CREG's site last regenerated the act's page, as it reports it."}},"required":["id","kind","number","year","title","issued_at","published_at","gazette","gazette_date","text_status","amendments","official_url","document_url","source_document_url","documents","source_modified_at"]}}},"required":["as_of","query","kind","number","year","issued_from","issued_to","total","total_is_exact","page","per_page","total_pages","count","results"]},"CregActsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CregActsSearchData"}}},"CregActData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"act_id":{"type":"string"},"act":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier: family, number and year, e.g. `resolucion_101-128_2026` (Resolución CREG 101 128 de 2026), `resolucion_131_1998`, `circular_345_2026`, `concepto_6838_2026`, `auto_939_2026`. Draft resolutions share the `resolucion` family with the resolutions they become."},"kind":{"type":"string","enum":["resolution","particular_resolution","draft_resolution","circular","legal_opinion","order"],"description":"`resolution` (resolución de carácter general), `particular_resolution` (resolución de carácter particular: a decision about one company or one tariff), `draft_resolution` (proyecto de resolución under public consultation), `circular`, `legal_opinion` (concepto jurídico) or `order` (auto de inicio of an administrative proceeding)."},"number":{"type":"string","description":"The number as the CREG prints it: \"101 128\", \"131\", \"345\", \"6838\", \"502 120D\"."},"year":{"type":"number","description":"The year in the act's designation."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the act does, in the CREG's own words: the epígrafe of a resolution, the subject of a circular or a concepto."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act is dated."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the CREG published the act on its site. Null for older acts, which record only their Diario Oficial date."},"gazette":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Diario Oficial reference as the CREG prints it, e.g. \"Diario Oficial No. 53.620 de 9 de septiembre de 2026\". Null when the act was not published there."},"gazette_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the Diario Oficial issue that published the act."},"text_status":{"type":"string","enum":["ok","missing"],"description":"`ok` when the full text is here; `missing` when the CREG publishes the act only as a file this dataset could not read the text of."},"amendments":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"The note as the CREG writes it, e.g. `Modificada por la Resolución 38 de 2010, publicada en el Diario Oficial No. 47.645 de 8 de marzo de 2010, '...'`."},"act_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The `id` of the act the note refers to, when it is one of this dataset's acts."}},"required":["description","act_id"]},"description":"The CREG's own notes on later acts that modified, added to or repealed this one (notas de vigencia). Empty when it records none."},"official_url":{"type":"string","description":"The act on the CREG's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the act's main document (its PDF, or the Word file when the CREG publishes no PDF), byte for byte as the CREG published it. Null when it publishes no file."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's main document on the CREG's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the CREG published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `docx`, `doc`, `xlsx`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as the CREG published it. Null when the CREG's link no longer answers."},"source_document_url":{"type":"string","description":"The file on the CREG's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file the CREG publishes with the act: the act itself as PDF and Word, technical memos, annexes, comment matrices."},"source_modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the CREG's site last regenerated the act's page, as it reports it."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the act'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 act's text, or null when `text_status` is not `ok`."}},"required":["id","kind","number","year","title","issued_at","published_at","gazette","gazette_date","text_status","amendments","official_url","document_url","source_document_url","documents","source_modified_at","content"]},{"type":"null"}]}},"required":["as_of","found","act_id","act"]},"CregActResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CregActData"}}},"SicRegulationsSearchData":{"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"}]},"topic":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The act's permanent number in the Superintendencia's normative register, e.g. `24968`."},"title":{"type":"string","description":"The act as the register titles it, e.g. \"Resolución No. 71690 del 10 de septiembre de 2026 \\\"por la cual se adoptan medidas transitorias...\\\"\"."},"kinds":{"type":"array","items":{"type":"string"},"description":"The kinds the register files the act under, as it names them: \"Resoluciones\", \"Circulares\", \"Títulos Circular única\", \"Leyes\", \"Decretos\", \"Doctrina\", \"Nombramientos\", \"Proyectos de resolución\", ... An act can carry more than one."},"kind_keys":{"type":"array","items":{"type":"string"},"description":"`kinds` in canonical form (lowercased, unaccented, hyphenated), which is what the `kind` filter matches."},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's area the act belongs to, e.g. \"Protección al Consumidor\", \"Protección de Datos Personales\", \"Propiedad Industrial\". Null when the register files it under none."},"topic_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`topic` in canonical form, which is what the `topic` filter matches."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the act does, in the Superintendencia's own words."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was issued (fecha de expedición)."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Superintendencia published the act in its register."},"official_url":{"type":"string","description":"The act in the Superintendencia's normative register."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the act's main file (its PDF), byte for byte as the Superintendencia published it. Null when it publishes no file."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's main file on the Superintendencia's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the Superintendencia published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `docx`, `xlsx`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as the Superintendencia published it. Null when its link no longer answers."},"source_document_url":{"type":"string","description":"The file on the Superintendencia's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file the Superintendencia attached to the act."}},"required":["id","title","kinds","kind_keys","topic","topic_key","summary","issued_at","published_at","official_url","document_url","source_document_url","documents"]}}},"required":["as_of","query","kind","topic","issued_from","issued_to","published_from","published_to","total","total_is_exact","page","per_page","total_pages","count","results"]},"SicRegulationsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicRegulationsSearchData"}}},"SicRegulationData":{"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":"The act's permanent number in the Superintendencia's normative register, e.g. `24968`."},"title":{"type":"string","description":"The act as the register titles it, e.g. \"Resolución No. 71690 del 10 de septiembre de 2026 \\\"por la cual se adoptan medidas transitorias...\\\"\"."},"kinds":{"type":"array","items":{"type":"string"},"description":"The kinds the register files the act under, as it names them: \"Resoluciones\", \"Circulares\", \"Títulos Circular única\", \"Leyes\", \"Decretos\", \"Doctrina\", \"Nombramientos\", \"Proyectos de resolución\", ... An act can carry more than one."},"kind_keys":{"type":"array","items":{"type":"string"},"description":"`kinds` in canonical form (lowercased, unaccented, hyphenated), which is what the `kind` filter matches."},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's area the act belongs to, e.g. \"Protección al Consumidor\", \"Protección de Datos Personales\", \"Propiedad Industrial\". Null when the register files it under none."},"topic_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`topic` in canonical form, which is what the `topic` filter matches."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the act does, in the Superintendencia's own words."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was issued (fecha de expedición)."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Superintendencia published the act in its register."},"official_url":{"type":"string","description":"The act in the Superintendencia's normative register."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the act's main file (its PDF), byte for byte as the Superintendencia published it. Null when it publishes no file."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's main file on the Superintendencia's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the Superintendencia published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `docx`, `xlsx`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as the Superintendencia published it. Null when its link no longer answers."},"source_document_url":{"type":"string","description":"The file on the Superintendencia's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file the Superintendencia attached to the act."}},"required":["id","title","kinds","kind_keys","topic","topic_key","summary","issued_at","published_at","official_url","document_url","source_document_url","documents"]},{"type":"null"}]}},"required":["as_of","found","regulation_id","regulation"]},"SicRegulationResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicRegulationData"}}},"SicBulletinsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"topic":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The item's permanent number on the Superintendencia's site, e.g. `24896`."},"section":{"type":"string","enum":["bulletin","opinion"],"description":"`bulletin` for an item of the Boletín Jurídico (a decision or a concept the Oficina Asesora Jurídica highlights); `opinion` for one of the conceptos it publishes alongside."},"title":{"type":"string","description":"The item's title."},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's area the item belongs to, e.g. \"Protección al Consumidor\", \"Asuntos Jurisdiccionales\", \"Propiedad Industrial\"."},"topic_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`topic` in canonical form, which is what the `topic` filter matches."},"tags":{"type":"array","items":{"type":"string"},"description":"The tags the Superintendencia gives the item, e.g. \"Información engañosa\", \"Habeas data\". Empty when it gives none."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Superintendencia published the item."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's summary of the decision or concept."},"official_url":{"type":"string","description":"The item on the Superintendencia's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the underlying decision or concept (its PDF), byte for byte as the Superintendencia published it. Null when the item carries no file."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The underlying document on the Superintendencia's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the Superintendencia published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `docx`, `xlsx`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as the Superintendencia published it. Null when its link no longer answers."},"source_document_url":{"type":"string","description":"The file on the Superintendencia's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file the Superintendencia attached to the item."}},"required":["id","section","title","topic","topic_key","tags","published_at","summary","official_url","document_url","source_document_url","documents"]}}},"required":["as_of","query","section","topic","published_from","published_to","total","total_is_exact","page","per_page","total_pages","count","results"]},"SicBulletinsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicBulletinsSearchData"}}},"SicBulletinData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"bulletin_id":{"type":"string"},"bulletin":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The item's permanent number on the Superintendencia's site, e.g. `24896`."},"section":{"type":"string","enum":["bulletin","opinion"],"description":"`bulletin` for an item of the Boletín Jurídico (a decision or a concept the Oficina Asesora Jurídica highlights); `opinion` for one of the conceptos it publishes alongside."},"title":{"type":"string","description":"The item's title."},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's area the item belongs to, e.g. \"Protección al Consumidor\", \"Asuntos Jurisdiccionales\", \"Propiedad Industrial\"."},"topic_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`topic` in canonical form, which is what the `topic` filter matches."},"tags":{"type":"array","items":{"type":"string"},"description":"The tags the Superintendencia gives the item, e.g. \"Información engañosa\", \"Habeas data\". Empty when it gives none."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Superintendencia published the item."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's summary of the decision or concept."},"official_url":{"type":"string","description":"The item on the Superintendencia's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the underlying decision or concept (its PDF), byte for byte as the Superintendencia published it. Null when the item carries no file."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The underlying document on the Superintendencia's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as the Superintendencia published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `docx`, `xlsx`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as the Superintendencia published it. Null when its link no longer answers."},"source_document_url":{"type":"string","description":"The file on the Superintendencia's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file the Superintendencia attached to the item."}},"required":["id","section","title","topic","topic_key","tags","published_at","summary","official_url","document_url","source_document_url","documents"]},{"type":"null"}]}},"required":["as_of","found","bulletin_id","bulletin"]},"SicBulletinResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicBulletinData"}}},"SicSanctionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"party":{"anyOf":[{"type":"string"},{"type":"null"}]},"sector":{"anyOf":[{"type":"string"},{"type":"null"}]},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier: the case, the resolution and the sanctioned party, e.g. `24-503714_40639_empresa-de-creditos-sas`."},"case_number":{"type":"string","description":"The case (radicado) as the Superintendencia prints it, e.g. \"24 503714\": the two-digit year it was opened and its number."},"resolution_number":{"type":"string","description":"The number of the resolution that imposed the fine, e.g. \"40639\"."},"issued_at":{"type":"string","description":"`yyyy-mm-dd` the resolution was issued."},"year":{"type":"number","description":"The year the resolution was issued."},"sanctioned_party":{"type":"string","description":"The person or company fined, as the Superintendencia names it."},"amount_cop":{"type":"number","description":"The fine, in Colombian pesos."},"conduct":{"type":"string","description":"The conduct fined, in the Superintendencia's words, e.g. \"Usura\", \"Falta de información para conocer las características del crédito\"."},"sector":{"type":"string","description":"The sector the party belongs to, e.g. \"Servicios de financiación\", \"Turismo\", \"Comercio electrónico\"."},"entries":{"type":"number","description":"How many times the Superintendencia's list carries this exact sanction; 1 almost always."}},"required":["id","case_number","resolution_number","issued_at","year","sanctioned_party","amount_cop","conduct","sector","entries"]}}},"required":["as_of","query","party","sector","case_number","resolution_number","issued_from","issued_to","total","total_is_exact","page","per_page","total_pages","count","results"]},"SicSanctionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicSanctionsSearchData"}}},"SicActsSearchData":{"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"}]},"office":{"anyOf":[{"type":"string"},{"type":"null"}]},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"party_document_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"issued_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The act's permanent number in the Superintendencia's register of administrative acts."},"act_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's own id of the act."},"type":{"type":"string","enum":["resolution","judgment","other"],"description":"`resolution` (resolución) or `judgment` (sentencia); `other` for anything else."},"type_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of act as the register prints it, e.g. \"RE-RESOLUCION\", \"SE-SENTENCIA\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's number."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was issued."},"office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office (dependencia) that issued it."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case (radicado) the act belongs to, e.g. \"24-449511\"."},"decisions":{"type":"array","items":{"type":"object","properties":{"class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The class of the decision, e.g. \"SENTENCIA ACEPTA ALLANAMIENTO CON ORDEN\", \"INVESTIGACION\"."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the act decides, e.g. \"ORDENA DEVOLUCION DINERO\", \"IMPONE SANCION\"."},"act_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of act the decision belongs to, e.g. \"SP-SENTENCIA PROTECCION\"."}},"required":["class","name","act_type"]},"description":"What the act decides, as the Superintendencia classifies it."},"parties":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's name as the Superintendencia records it."},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's role, e.g. \"INVESTIGADO\", \"QUEJOSO\", \"APODERADO\", \"REPRESENTANTE LEGAL\"."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of identification, e.g. \"CC - CEDULA DE CIUDADANIA\", \"NI - NIT\"."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The identification number, digits only."},"representative_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the party's representative, when the Superintendencia records one."},"representative_document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The representative's kind of identification."},"representative_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The representative's identification number, digits only."}},"required":["name","role","document_type","document_number","representative_name","representative_document_type","representative_document_number"]},"description":"The parties the Superintendencia records for the act."},"party_document_numbers":{"type":"array","items":{"type":"string"},"description":"Every party's and representative's identification number, digits only, which is what the `party_document_number` filter matches."},"file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name the Superintendencia gave the act's document."},"registered_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the act entered the register."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the register last changed the act."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when no document could be read."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the act's document (PDF), byte for byte as the Superintendencia published it. Null when it could not be kept."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Superintendencia publishes the document only through its search tool, with no permanent link."},"document_bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the document in bytes."}},"required":["id","act_id","type","type_label","number","issued_at","office","case_number","decisions","parties","party_document_numbers","file_name","registered_at","modified_at","text_status","document_url","source_document_url","document_bytes"]}}},"required":["as_of","query","type","office","case_number","party_document_number","issued_from","issued_to","total","total_is_exact","page","per_page","total_pages","count","results"]},"SicActsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicActsSearchData"}}},"SicActData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"act_id":{"type":"string"},"act":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The act's permanent number in the Superintendencia's register of administrative acts."},"act_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's own id of the act."},"type":{"type":"string","enum":["resolution","judgment","other"],"description":"`resolution` (resolución) or `judgment` (sentencia); `other` for anything else."},"type_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of act as the register prints it, e.g. \"RE-RESOLUCION\", \"SE-SENTENCIA\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's number."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was issued."},"office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office (dependencia) that issued it."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case (radicado) the act belongs to, e.g. \"24-449511\"."},"decisions":{"type":"array","items":{"type":"object","properties":{"class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The class of the decision, e.g. \"SENTENCIA ACEPTA ALLANAMIENTO CON ORDEN\", \"INVESTIGACION\"."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the act decides, e.g. \"ORDENA DEVOLUCION DINERO\", \"IMPONE SANCION\"."},"act_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of act the decision belongs to, e.g. \"SP-SENTENCIA PROTECCION\"."}},"required":["class","name","act_type"]},"description":"What the act decides, as the Superintendencia classifies it."},"parties":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's name as the Superintendencia records it."},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's role, e.g. \"INVESTIGADO\", \"QUEJOSO\", \"APODERADO\", \"REPRESENTANTE LEGAL\"."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of identification, e.g. \"CC - CEDULA DE CIUDADANIA\", \"NI - NIT\"."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The identification number, digits only."},"representative_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the party's representative, when the Superintendencia records one."},"representative_document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The representative's kind of identification."},"representative_document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The representative's identification number, digits only."}},"required":["name","role","document_type","document_number","representative_name","representative_document_type","representative_document_number"]},"description":"The parties the Superintendencia records for the act."},"party_document_numbers":{"type":"array","items":{"type":"string"},"description":"Every party's and representative's identification number, digits only, which is what the `party_document_number` filter matches."},"file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name the Superintendencia gave the act's document."},"registered_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the act entered the register."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the register last changed the act."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when no document could be read."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the act's document (PDF), byte for byte as the Superintendencia published it. Null when it could not be kept."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Superintendencia publishes the document only through its search tool, with no permanent link."},"document_bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the document in bytes."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the act'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 act's text, or null when `text_status` is not `ok`."}},"required":["id","act_id","type","type_label","number","issued_at","office","case_number","decisions","parties","party_document_numbers","file_name","registered_at","modified_at","text_status","document_url","source_document_url","document_bytes","content"]},{"type":"null"}]}},"required":["as_of","found","act_id","act"]},"SicActResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicActData"}}},"SicTramitesCaseData":{"type":"object","properties":{"found":{"type":"boolean","description":"Whether the filing exists and the document belongs to one of its parties."},"year":{"type":"integer"},"case_number":{"type":"string"},"case_control":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_type":{"type":"string"},"document_number":{"type":"string"},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing's procedure (trámite)."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the filing was made: the date of its first action."},"last_action_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date of its most recent action."},"total_actions":{"type":"integer"},"actions":{"type":"array","items":{"type":"object","properties":{"sequence_number":{"type":"integer","description":"Position of the action in the filing (consecutivo), from 0."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure (trámite), e.g. `DEMANDA PROTECCIÓN CONSUMIDOR JURISDICCIONAL`."},"event":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The event (evento), e.g. `DEMANDA`."},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The action (actuación), e.g. `PRESENTACION`, `FIJACION EN LISTA`."},"direction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's code for the action's direction: `EN` (incoming), `SA` (outgoing), `TR` (internal)."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the action was filed, `yyyy-mm-ddThh:mm:ss`, Bogotá time."},"party":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sender or addressee of the action (solicitante / destinatario)."},"parent_case":{"anyOf":[{"type":"object","properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}]},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"case_control":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["year","case_number","case_control"]},{"type":"null"}],"description":"The filing this one was joined to, when it was."},"joined_cases":{"type":"array","items":{"type":"object","properties":{"year":{"anyOf":[{"type":"integer"},{"type":"null"}]},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"case_control":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["year","case_number","case_control"]},"description":"Filings joined to this one (acumulados)."},"has_documents":{"type":"boolean","description":"Whether the Superintendencia publishes documents for this action."},"documents":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"How the Superintendencia labels the file, e.g. `presentacion - página 1`. Each label is a separate file."},"file_name":{"type":"string","description":"The file name the Superintendencia published the document under, e.g. `25194793--0000000001.PDF`."},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's type, read from its bytes (or its extension when the bytes do not say): mostly `application/pdf`, also scanned images and forwarded e-mails (`message/rfc822`). Null when neither tells."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of the document in bytes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our stored copy of the document, byte-identical to the original."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's own link to the document."}},"required":["label","file_name","content_type","bytes","document_url","source_document_url"]},"description":"The action's documents. Empty when `include_documents` is false or the action has none."}},"required":["sequence_number","procedure","event","action","direction","date","party","parent_case","joined_cases","has_documents","documents"]},"description":"Every action of the filing, oldest first."},"administrative_acts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"How the Superintendencia labels the act, e.g. `AU 53213 2025/05/20`."},"act_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Type of act, as the Superintendencia abbreviates it: `AU` (auto), `SE` (sentencia), `RE` (resolución)."},"act_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Number of the act."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the act, `yyyy-mm-dd`."},"file_name":{"type":"string","description":"The file name the Superintendencia published the document under, e.g. `25194793--0000000001.PDF`."},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's type, read from its bytes (or its extension when the bytes do not say): mostly `application/pdf`, also scanned images and forwarded e-mails (`message/rfc822`). Null when neither tells."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of the document in bytes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our stored copy of the document, byte-identical to the original."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Superintendencia's own link to the document."}},"required":["label","act_type","act_number","issued_at","file_name","content_type","bytes","document_url","source_document_url"]},"description":"The administrative acts (autos, sentencias, resoluciones) issued in the filing, each once."},"documents_included":{"type":"boolean","description":"Whether documents were read for this answer (`include_documents`)."}},"required":["found","year","case_number","case_control","document_type","document_number","procedure","filed_at","last_action_at","total_actions","actions","administrative_acts","documents_included"]},"SicTramitesCaseResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicTramitesCaseData"}}},"SicGazetteEntriesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"domain":{"anyOf":[{"type":"string"},{"type":"null"}]},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue_number":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"nice_class":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"entry_id":{"type":"string","description":"The entry: issue, part, section and file number, e.g. \"1116-TM-trademarks-SD2026/0099552\". A file listed twice in one section of one issue gets \"~2\", \"~3\" after the first."},"issue_id":{"type":"string","description":"The issue this entry was published in, e.g. \"1116-TM\"; see the issue lookup."},"issue_number":{"type":"number","description":"The issue number of the gazette, e.g. 1116."},"domain":{"type":"string","enum":["trademarks","patents","designs"],"description":"`trademarks`, `patents` or `designs`."},"section":{"type":"string","description":"The section, as a slug: `trademarks` (applications for marks), `collective_marks`, `territorial_extensions` (international registrations extended to Colombia), `slogans`, `registrations` (marks granted), `cancellation_decisions`, `nullity_judgments` (rulings of the Consejo de Estado), `patents`, `utility_models`, `pct_patents`, `layout_designs`, `industrial_designs`, `judgment_publications` (rulings of the Consejo de Estado the gazette was ordered to publish)."},"section_name":{"type":"string","description":"The section as the gazette names it, e.g. \"Marcas\", \"Títulos\", \"Patente PCT publicada\"."},"published_at":{"type":"string","description":"`yyyy-mm-dd` the issue was published; what `from_date` and `to_date` filter on."},"file_number":{"type":"string","description":"The file (expediente) number, e.g. \"SD2026/0099552\" (distinctive signs) or \"NC2026/0014108\" (new creations); older files carry bare digits."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure, as the gazette names it, e.g. \"SD Solicitud de Signos Distintivos\", \"NC Solicitud de Patente PCT Fase Nacional\"."},"application_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For patents and designs, the kind, e.g. \"Patente de Invención Nacional\", \"Patente PCT\", \"Diseño Industrial 3D\"."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was filed."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sign (the words of the mark) or the title of the invention or design."},"sign_nature":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For signs, how the sign is made: \"Nominativa\", \"Mixta\", \"Figurativa\", \"Tridimensional\", \"Sonido\"..."},"nice_classes":{"type":"array","items":{"type":"number"},"description":"For signs, the international (Nice) classes of the goods and services, e.g. [29, 30, 43]."},"color_claim":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For signs, the colors claimed, as the gazette writes them."},"priority":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The priority claimed, as the gazette prints it: dates for signs; country, number and date for patents and designs, one line each."},"priorities":{"type":"array","items":{"type":"object","properties":{"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The country of the earlier filing, as the gazette writes it."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the earlier filing."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the earlier filing."}},"required":["country","number","date"]},"description":"The same priorities, one entry per earlier filing."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The status the gazette prints, e.g. \"Publicada\", \"Registrada\", \"Publicada sin pago\", \"Publicado\"."},"applicant":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The applicants, as the gazette names them; several are separated by `; `."},"owner":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For cancellation decisions and judgments, the owner (titular) of the mark or design."},"agent":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The agent (apoderado) or the contact for the application; several are separated by `; `."},"inventor_or_designer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For patents and designs, the inventors or designers; several are separated by `; `."},"international_application_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For PCT patents, the international application number, e.g. \"PCT/CA2025/050297\"."},"international_publication_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For PCT patents, the international publication number, e.g. \"WO/2025/184731\"."},"international_filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For PCT patents, `yyyy-mm-dd` of the international filing."},"classification":{"type":"array","items":{"type":"string"},"description":"For patents, the International Patent Classification symbols, e.g. [\"C12N 15/13\"]; for designs, the Locarno classes, e.g. [\"09.01\"]."},"classification_system":{"anyOf":[{"type":"string","enum":["ipc","locarno"]},{"type":"null"}],"description":"`ipc` or `locarno`: which classification `classification` holds. Null for signs."},"cancellation_petitioner":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For cancellation decisions, who asked for the cancellation."},"court_file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For judgments, the file number the Consejo de Estado's ruling was entered under."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the issue's workbook (XLSX) that published this entry."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Superintendencia gives the workbook no stable public link of its own; `document_url` is the copy to use."}},"required":["entry_id","issue_id","issue_number","domain","section","section_name","published_at","file_number","procedure","application_type","filed_at","title","sign_nature","nice_classes","color_claim","priority","priorities","status","applicant","owner","agent","inventor_or_designer","international_application_number","international_publication_number","international_filing_date","classification","classification_system","cancellation_petitioner","court_file_number","document_url","source_document_url"]}}},"required":["as_of","query","file_number","domain","section","issue_number","status","nice_class","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"SicGazetteEntriesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicGazetteEntriesSearchData"}}},"SicGazetteIssuesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"domain":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"total_is_exact":{"type":"boolean"},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"issue_id":{"type":"string","description":"The issue and its part, e.g. \"1116-TM\": the number, then TM (trademarks), PT (patents) or DS (industrial designs)."},"number":{"type":"number","description":"The issue number of the gazette, e.g. 1116."},"domain":{"type":"string","enum":["trademarks","patents","designs"],"description":"`trademarks`, `patents` or `designs`: the part of the gazette this issue row covers."},"published_at":{"type":"string","description":"`yyyy-mm-dd` the issue was published."},"sections":{"type":"array","items":{"type":"string"},"description":"The sections the issue carries in this part, e.g. [\"trademarks\", \"territorial_extensions\", \"registrations\"]."},"section_names":{"type":"array","items":{"type":"string"},"description":"The same sections as the gazette names them, e.g. [\"Marcas\", \"Extensión Territorial\", \"Títulos\"]."},"entry_count":{"type":"number","description":"Entries published in this part of the issue, every section together."},"generated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Superintendencia generated the issue's workbook, ISO 8601."},"file_name":{"type":"string","description":"The name the Superintendencia published the workbook under, e.g. \"1116TM01XLS.xlsx\"."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the issue's workbook (XLSX), byte for byte as the Superintendencia published it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Superintendencia gives the workbook no stable public link of its own; `document_url` is the copy to use."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the workbook in bytes."}},"required":["issue_id","number","domain","published_at","sections","section_names","entry_count","generated_at","file_name","document_url","source_document_url","bytes"]}}},"required":["as_of","domain","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"SicGazetteIssuesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicGazetteIssuesSearchData"}}},"SicGazetteIssueData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"number":{"type":"number"},"domain":{"type":"string"},"issue":{"anyOf":[{"type":"object","properties":{"issue_id":{"type":"string","description":"The issue and its part, e.g. \"1116-TM\": the number, then TM (trademarks), PT (patents) or DS (industrial designs)."},"number":{"type":"number","description":"The issue number of the gazette, e.g. 1116."},"domain":{"type":"string","enum":["trademarks","patents","designs"],"description":"`trademarks`, `patents` or `designs`: the part of the gazette this issue row covers."},"published_at":{"type":"string","description":"`yyyy-mm-dd` the issue was published."},"sections":{"type":"array","items":{"type":"string"},"description":"The sections the issue carries in this part, e.g. [\"trademarks\", \"territorial_extensions\", \"registrations\"]."},"section_names":{"type":"array","items":{"type":"string"},"description":"The same sections as the gazette names them, e.g. [\"Marcas\", \"Extensión Territorial\", \"Títulos\"]."},"entry_count":{"type":"number","description":"Entries published in this part of the issue, every section together."},"generated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Superintendencia generated the issue's workbook, ISO 8601."},"file_name":{"type":"string","description":"The name the Superintendencia published the workbook under, e.g. \"1116TM01XLS.xlsx\"."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the issue's workbook (XLSX), byte for byte as the Superintendencia published it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Superintendencia gives the workbook no stable public link of its own; `document_url` is the copy to use."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the workbook in bytes."}},"required":["issue_id","number","domain","published_at","sections","section_names","entry_count","generated_at","file_name","document_url","source_document_url","bytes"]},{"type":"null"}]}},"required":["as_of","found","number","domain","issue"]},"SicGazetteIssueResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicGazetteIssueData"}}},"SicIpTrademarksSearchData":{"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"}]},"nice_class":{"anyOf":[{"type":"string"},{"type":"null"}]},"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"file_number":{"type":"string","description":"The file number (expediente) the register gave the case when it was filed, e.g. `SD2026/0031979`, `NC2026/0006185`, or the bare digits of a file opened before 2016 (`16137606`). It identifies the case for its whole life."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's status as the register words it, e.g. `Registrada`, `Publicada`, `Concedida`, `Negada`, `Caducado`."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was filed (fecha de presentación); what `from_date` and `to_date` filter on."},"owners":{"type":"array","items":{"type":"string"},"description":"The owners (titulares), or the applicants while the case is pending, as the register lists them."},"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registration certificate number, once the mark registered, e.g. `612592`."},"sign":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sign (denominación) as filed, e.g. `CAFÉ BOSQUE ADENTRO`. Null for a purely figurative mark."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration runs out unless renewed (vigencia)."},"nice_classes":{"type":"array","items":{"type":"string"},"description":"The Nice classes the mark covers, e.g. [\"29\", \"30\"]."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the Gaceta de Propiedad Industrial that published the application."},"label_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the mark's label (etiqueta), byte for byte as the register serves it. Null for a mark with no label."},"source_label_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own link to the label."}},"required":["file_number","status","filing_date","owners","certificate_number","sign","expires_on","nice_classes","gazette_number","label_url","source_label_url"]}}},"required":["as_of","query","status","nice_class","certificate_number","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"SicIpTrademarksSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicIpTrademarksSearchData"}}},"SicIpPatentsSearchData":{"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"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"file_number":{"type":"string","description":"The file number (expediente) the register gave the case when it was filed, e.g. `SD2026/0031979`, `NC2026/0006185`, or the bare digits of a file opened before 2016 (`16137606`). It identifies the case for its whole life."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's status as the register words it, e.g. `Registrada`, `Publicada`, `Concedida`, `Negada`, `Caducado`."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was filed (fecha de presentación); what `from_date` and `to_date` filter on."},"owners":{"type":"array","items":{"type":"string"},"description":"The owners (titulares), or the applicants while the case is pending, as the register lists them."},"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grant or certificate number, once granted."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The title of the invention or the design as filed."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the grant runs out, when the register lists it."},"figure_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the characteristic figure, byte for byte as the register serves it. Null when the case shows none."},"source_figure_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own link to the figure."}},"required":["file_number","status","filing_date","owners","certificate_number","title","expires_on","figure_url","source_figure_url"]}}},"required":["as_of","query","status","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"SicIpPatentsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicIpPatentsSearchData"}}},"SicIpDesignsSearchData":{"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"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"file_number":{"type":"string","description":"The file number (expediente) the register gave the case when it was filed, e.g. `SD2026/0031979`, `NC2026/0006185`, or the bare digits of a file opened before 2016 (`16137606`). It identifies the case for its whole life."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's status as the register words it, e.g. `Registrada`, `Publicada`, `Concedida`, `Negada`, `Caducado`."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was filed (fecha de presentación); what `from_date` and `to_date` filter on."},"owners":{"type":"array","items":{"type":"string"},"description":"The owners (titulares), or the applicants while the case is pending, as the register lists them."},"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grant or certificate number, once granted."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The title of the invention or the design as filed."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the grant runs out, when the register lists it."},"figure_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the characteristic figure, byte for byte as the register serves it. Null when the case shows none."},"source_figure_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own link to the figure."}},"required":["file_number","status","filing_date","owners","certificate_number","title","expires_on","figure_url","source_figure_url"]}}},"required":["as_of","query","status","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"SicIpDesignsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicIpDesignsSearchData"}}},"SicIpResolutionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"document_id":{"type":"string","description":"The register's id of the document, 16 hexadecimal characters, e.g. `09000002825ba3d5`."},"kind":{"type":"string","enum":["resolucion","oficio"],"description":"`resolucion` (a decision) or `oficio` (a requirement or a notice)."},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The resolution's or oficio's number, e.g. `77922`."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's type as the register names it, e.g. `TM179 - Acepta Cancelación`, `240 PT Resolución Abandono art 44`."},"template_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The template code the type begins with, e.g. `TM179`, `PT240`, `NC513`."},"act_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the administrative act."},"sent_date":{"type":"string","description":"`yyyy-mm-dd` the register sent the document out (fecha de envío); what `from_date` and `to_date` filter on."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The request the document answers (número de solicitud): the case itself, or a secondary request in it (an opposition, a transfer, a security interest)."},"main_file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The main case a secondary request belongs to (número de solicitud PI), when it is not the same."},"parties":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party the document was notified to, as the register writes it."},"notified_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` that party was notified."},"enforced_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act became final for that party (ejecutoria)."}},"required":["name","notified_on","enforced_on"]},"description":"Who the document was notified to, with each party's own notification and ejecutoria dates."},"notified_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was notified."},"enforced_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act became final (ejecutoria)."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the document (PDF), byte for byte as the register serves it."},"source_document_url":{"type":"string","description":"The register's own link to the document."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."}},"required":["document_id","kind","resolution_number","title","template_code","act_date","sent_date","file_number","main_file_number","parties","notified_on","enforced_on","document_url","source_document_url","bytes"]}}},"required":["as_of","query","file_number","kind","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"SicIpResolutionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicIpResolutionsSearchData"}}},"SicIpTrademarkData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when the register has no case of this kind under the number."},"file_number":{"type":"string"},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the register was last asked for this case."},"served_from":{"anyOf":[{"type":"string","enum":["copy","upstream","stale"]},{"type":"null"}],"description":"`copy` when Croma answered from what it stored within the last day, `upstream` when the register was read for this request, `stale` when the register could not be read and the last stored answer stood in."},"trademark":{"anyOf":[{"type":"object","properties":{"file_number":{"type":"string","description":"The case's file number (expediente)."},"kind":{"type":"string","enum":["trademark","patent","design"],"description":"What the case protects."},"procedure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of request as the register names it, e.g. `SD Solicitud de Signos Distintivos`, `Patente de Invención Nacional`, `NC Solicitud de Diseño Industrial`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's status as the register words it, e.g. `Registrada`, `Publicada`, `Concedida`."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sign (trademarks) or the title (patents, designs)."},"sign_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trademarks: the kind of sign, e.g. `Marca`, `Lema Comercial`, `Nombre Comercial`."},"sign_nature":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trademarks: `Nominativa`, `Mixta`, `Figurativa`, `Tridimensional`, `Sonora` and so on."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was filed (fecha de presentación)."},"submitted_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was received (fecha de radicación)."},"publication_ordered_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` publication was ordered."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Gaceta de Propiedad Industrial that published the application."},"published_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of that publication."},"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registration certificate or grant number."},"registered_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the mark was registered or the patent or design granted."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the right runs out unless renewed (vigencia)."},"applicant_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The applicant's own reference for the case."},"nice_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trademarks: the edition of the Nice classification the classes follow."},"classes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"]},"description":"Trademarks: each Nice class with the goods and services the mark covers in it."},"nice_classes":{"type":"array","items":{"type":"string"},"description":"Trademarks: the Nice class numbers alone."},"locarno":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"version":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description","version"]},"description":"Designs: the Locarno classes."},"patent_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Patents: e.g. `Patente de Invención Nacional`, `Patente de Modelo de Utilidad`, `Patente PCT`."},"technology_sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Patents: the technology sector as the register files it."},"technology_subsector":{"anyOf":[{"type":"string"},{"type":"null"}]},"abstract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Patents: the abstract (resumen) as filed."},"design_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Designs: `Diseño Industrial 2D` or `3D`."},"parties":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"`owner` (titular), `applicant`, `agent` (apoderado or legal representative), `contact`, `inventor` or `designer`."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's identification number as the register records it: NIT for a company, cédula or the register's own number for a person."},"wipo_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address the register records for the party."}},"required":["role","document_number","wipo_id","name","address"]},"description":"Everyone the case names, with their identification number and address as the register records them."},"images":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name the register published the file under."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy, byte for byte. Null when the register withholds the file, or when it lies past the copies kept per case (see `documents_kept`)."},"source_document_url":{"type":"string","description":"The register's own link to the file."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."},"role":{"type":"string","enum":["label","figure"]}},"required":["name","document_url","source_document_url","bytes","role"]},"description":"The mark's label or the design's figures, kept by Croma."},"specification":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name the register published the file under."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy, byte for byte. Null when the register withholds the file, or when it lies past the copies kept per case (see `documents_kept`)."},"source_document_url":{"type":"string","description":"The register's own link to the file."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."},"type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","document_url","source_document_url","bytes","type"]},"description":"Patents: the public specification (description, claims, drawings), kept by Croma."},"history":{"type":"array","items":{"type":"object","properties":{"action":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tipo de actuación, e.g. `Solicitud de signo distintivo`, `Marcas`, `Edición de signo distintivo`."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What happened, as the register words it; a publication carries the full gazette entry, an edit the field with its old and new value."},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the event was recorded, ISO 8601 at -05:00."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_on":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["action","description","created_at","gazette_number","published_on"]},"description":"The case's procedural history, newest first."},"linked_procedures":{"type":"array","items":{"type":"object","properties":{"file_number":{"type":"string","description":"The linked request's own number."},"procedure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `SD Oposición de Signos Distintivos`, `SD Transferencia de Signo Distintivo`, `DPI Gestión de personas`."},"link_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"owner":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party that filed it (an opponent, the new owner)."}},"required":["file_number","procedure_type","link_type","title","filed_on","status","owner"]},"description":"Oppositions, transfers, licences, name changes, corrections and other requests filed against the case."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name the register published the file under."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy, byte for byte. Null when the register withholds the file, or when it lies past the copies kept per case (see `documents_kept`)."},"source_document_url":{"type":"string","description":"The register's own link to the file."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's type as the register names it, e.g. `TM5 - Requerimiento Examen de Forma`."},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"act_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"sent_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"notified_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"enforced_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"parties":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party the document was notified to, as the register writes it."},"notified_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` that party was notified."},"enforced_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act became final for that party (ejecutoria)."}},"required":["name","notified_on","enforced_on"]}}},"required":["name","document_url","source_document_url","bytes","title","resolution_number","document_date","act_date","sent_date","notified_on","enforced_on","parties"]},"description":"Every document of the file, newest first: resolutions, oficios, the applicant's filings, certificates."},"documents_total":{"type":"integer","description":"Documents the register lists for the case."},"documents_kept":{"type":"integer","description":"Documents of which Croma holds a copy; the newest ones are kept when a file has more than the per-case limit."},"fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]},"description":"Every labelled field of the case page, as the register prints it, for anything the named fields above do not carry."},"checked_at":{"type":"string"}},"required":["file_number","kind","procedure_type","status","title","sign_type","sign_nature","filing_date","submitted_on","publication_ordered_on","gazette_number","published_on","certificate_number","registered_on","expires_on","applicant_reference","nice_version","classes","nice_classes","locarno","patent_type","technology_sector","technology_subsector","abstract","design_type","parties","images","specification","history","linked_procedures","documents","documents_total","documents_kept","fields","checked_at"]},{"type":"null"}]}},"required":["found","file_number","checked_at","served_from","trademark"]},"SicIpTrademarkResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicIpTrademarkData"}}},"SicIpPatentData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when the register has no case of this kind under the number."},"file_number":{"type":"string"},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the register was last asked for this case."},"served_from":{"anyOf":[{"type":"string","enum":["copy","upstream","stale"]},{"type":"null"}],"description":"`copy` when Croma answered from what it stored within the last day, `upstream` when the register was read for this request, `stale` when the register could not be read and the last stored answer stood in."},"patent":{"anyOf":[{"type":"object","properties":{"file_number":{"type":"string","description":"The case's file number (expediente)."},"kind":{"type":"string","enum":["trademark","patent","design"],"description":"What the case protects."},"procedure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of request as the register names it, e.g. `SD Solicitud de Signos Distintivos`, `Patente de Invención Nacional`, `NC Solicitud de Diseño Industrial`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's status as the register words it, e.g. `Registrada`, `Publicada`, `Concedida`."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sign (trademarks) or the title (patents, designs)."},"sign_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trademarks: the kind of sign, e.g. `Marca`, `Lema Comercial`, `Nombre Comercial`."},"sign_nature":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trademarks: `Nominativa`, `Mixta`, `Figurativa`, `Tridimensional`, `Sonora` and so on."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was filed (fecha de presentación)."},"submitted_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was received (fecha de radicación)."},"publication_ordered_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` publication was ordered."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Gaceta de Propiedad Industrial that published the application."},"published_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of that publication."},"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registration certificate or grant number."},"registered_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the mark was registered or the patent or design granted."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the right runs out unless renewed (vigencia)."},"applicant_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The applicant's own reference for the case."},"nice_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trademarks: the edition of the Nice classification the classes follow."},"classes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"]},"description":"Trademarks: each Nice class with the goods and services the mark covers in it."},"nice_classes":{"type":"array","items":{"type":"string"},"description":"Trademarks: the Nice class numbers alone."},"locarno":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"version":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description","version"]},"description":"Designs: the Locarno classes."},"patent_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Patents: e.g. `Patente de Invención Nacional`, `Patente de Modelo de Utilidad`, `Patente PCT`."},"technology_sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Patents: the technology sector as the register files it."},"technology_subsector":{"anyOf":[{"type":"string"},{"type":"null"}]},"abstract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Patents: the abstract (resumen) as filed."},"design_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Designs: `Diseño Industrial 2D` or `3D`."},"parties":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"`owner` (titular), `applicant`, `agent` (apoderado or legal representative), `contact`, `inventor` or `designer`."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's identification number as the register records it: NIT for a company, cédula or the register's own number for a person."},"wipo_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address the register records for the party."}},"required":["role","document_number","wipo_id","name","address"]},"description":"Everyone the case names, with their identification number and address as the register records them."},"images":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name the register published the file under."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy, byte for byte. Null when the register withholds the file, or when it lies past the copies kept per case (see `documents_kept`)."},"source_document_url":{"type":"string","description":"The register's own link to the file."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."},"role":{"type":"string","enum":["label","figure"]}},"required":["name","document_url","source_document_url","bytes","role"]},"description":"The mark's label or the design's figures, kept by Croma."},"specification":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name the register published the file under."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy, byte for byte. Null when the register withholds the file, or when it lies past the copies kept per case (see `documents_kept`)."},"source_document_url":{"type":"string","description":"The register's own link to the file."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."},"type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","document_url","source_document_url","bytes","type"]},"description":"Patents: the public specification (description, claims, drawings), kept by Croma."},"history":{"type":"array","items":{"type":"object","properties":{"action":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tipo de actuación, e.g. `Solicitud de signo distintivo`, `Marcas`, `Edición de signo distintivo`."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What happened, as the register words it; a publication carries the full gazette entry, an edit the field with its old and new value."},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the event was recorded, ISO 8601 at -05:00."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_on":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["action","description","created_at","gazette_number","published_on"]},"description":"The case's procedural history, newest first."},"linked_procedures":{"type":"array","items":{"type":"object","properties":{"file_number":{"type":"string","description":"The linked request's own number."},"procedure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `SD Oposición de Signos Distintivos`, `SD Transferencia de Signo Distintivo`, `DPI Gestión de personas`."},"link_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"owner":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party that filed it (an opponent, the new owner)."}},"required":["file_number","procedure_type","link_type","title","filed_on","status","owner"]},"description":"Oppositions, transfers, licences, name changes, corrections and other requests filed against the case."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name the register published the file under."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy, byte for byte. Null when the register withholds the file, or when it lies past the copies kept per case (see `documents_kept`)."},"source_document_url":{"type":"string","description":"The register's own link to the file."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's type as the register names it, e.g. `TM5 - Requerimiento Examen de Forma`."},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"act_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"sent_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"notified_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"enforced_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"parties":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party the document was notified to, as the register writes it."},"notified_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` that party was notified."},"enforced_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act became final for that party (ejecutoria)."}},"required":["name","notified_on","enforced_on"]}}},"required":["name","document_url","source_document_url","bytes","title","resolution_number","document_date","act_date","sent_date","notified_on","enforced_on","parties"]},"description":"Every document of the file, newest first: resolutions, oficios, the applicant's filings, certificates."},"documents_total":{"type":"integer","description":"Documents the register lists for the case."},"documents_kept":{"type":"integer","description":"Documents of which Croma holds a copy; the newest ones are kept when a file has more than the per-case limit."},"fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]},"description":"Every labelled field of the case page, as the register prints it, for anything the named fields above do not carry."},"checked_at":{"type":"string"}},"required":["file_number","kind","procedure_type","status","title","sign_type","sign_nature","filing_date","submitted_on","publication_ordered_on","gazette_number","published_on","certificate_number","registered_on","expires_on","applicant_reference","nice_version","classes","nice_classes","locarno","patent_type","technology_sector","technology_subsector","abstract","design_type","parties","images","specification","history","linked_procedures","documents","documents_total","documents_kept","fields","checked_at"]},{"type":"null"}]}},"required":["found","file_number","checked_at","served_from","patent"]},"SicIpPatentResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicIpPatentData"}}},"SicIpDesignData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when the register has no case of this kind under the number."},"file_number":{"type":"string"},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the register was last asked for this case."},"served_from":{"anyOf":[{"type":"string","enum":["copy","upstream","stale"]},{"type":"null"}],"description":"`copy` when Croma answered from what it stored within the last day, `upstream` when the register was read for this request, `stale` when the register could not be read and the last stored answer stood in."},"design":{"anyOf":[{"type":"object","properties":{"file_number":{"type":"string","description":"The case's file number (expediente)."},"kind":{"type":"string","enum":["trademark","patent","design"],"description":"What the case protects."},"procedure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of request as the register names it, e.g. `SD Solicitud de Signos Distintivos`, `Patente de Invención Nacional`, `NC Solicitud de Diseño Industrial`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's status as the register words it, e.g. `Registrada`, `Publicada`, `Concedida`."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sign (trademarks) or the title (patents, designs)."},"sign_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trademarks: the kind of sign, e.g. `Marca`, `Lema Comercial`, `Nombre Comercial`."},"sign_nature":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trademarks: `Nominativa`, `Mixta`, `Figurativa`, `Tridimensional`, `Sonora` and so on."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was filed (fecha de presentación)."},"submitted_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was received (fecha de radicación)."},"publication_ordered_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` publication was ordered."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Gaceta de Propiedad Industrial that published the application."},"published_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of that publication."},"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registration certificate or grant number."},"registered_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the mark was registered or the patent or design granted."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the right runs out unless renewed (vigencia)."},"applicant_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The applicant's own reference for the case."},"nice_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trademarks: the edition of the Nice classification the classes follow."},"classes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description"]},"description":"Trademarks: each Nice class with the goods and services the mark covers in it."},"nice_classes":{"type":"array","items":{"type":"string"},"description":"Trademarks: the Nice class numbers alone."},"locarno":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"version":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["code","description","version"]},"description":"Designs: the Locarno classes."},"patent_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Patents: e.g. `Patente de Invención Nacional`, `Patente de Modelo de Utilidad`, `Patente PCT`."},"technology_sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Patents: the technology sector as the register files it."},"technology_subsector":{"anyOf":[{"type":"string"},{"type":"null"}]},"abstract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Patents: the abstract (resumen) as filed."},"design_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Designs: `Diseño Industrial 2D` or `3D`."},"parties":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"`owner` (titular), `applicant`, `agent` (apoderado or legal representative), `contact`, `inventor` or `designer`."},"document_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party's identification number as the register records it: NIT for a company, cédula or the register's own number for a person."},"wipo_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address the register records for the party."}},"required":["role","document_number","wipo_id","name","address"]},"description":"Everyone the case names, with their identification number and address as the register records them."},"images":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name the register published the file under."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy, byte for byte. Null when the register withholds the file, or when it lies past the copies kept per case (see `documents_kept`)."},"source_document_url":{"type":"string","description":"The register's own link to the file."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."},"role":{"type":"string","enum":["label","figure"]}},"required":["name","document_url","source_document_url","bytes","role"]},"description":"The mark's label or the design's figures, kept by Croma."},"specification":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name the register published the file under."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy, byte for byte. Null when the register withholds the file, or when it lies past the copies kept per case (see `documents_kept`)."},"source_document_url":{"type":"string","description":"The register's own link to the file."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."},"type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","document_url","source_document_url","bytes","type"]},"description":"Patents: the public specification (description, claims, drawings), kept by Croma."},"history":{"type":"array","items":{"type":"object","properties":{"action":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tipo de actuación, e.g. `Solicitud de signo distintivo`, `Marcas`, `Edición de signo distintivo`."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What happened, as the register words it; a publication carries the full gazette entry, an edit the field with its old and new value."},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the event was recorded, ISO 8601 at -05:00."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_on":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["action","description","created_at","gazette_number","published_on"]},"description":"The case's procedural history, newest first."},"linked_procedures":{"type":"array","items":{"type":"object","properties":{"file_number":{"type":"string","description":"The linked request's own number."},"procedure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `SD Oposición de Signos Distintivos`, `SD Transferencia de Signo Distintivo`, `DPI Gestión de personas`."},"link_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"owner":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party that filed it (an opponent, the new owner)."}},"required":["file_number","procedure_type","link_type","title","filed_on","status","owner"]},"description":"Oppositions, transfers, licences, name changes, corrections and other requests filed against the case."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file name the register published the file under."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy, byte for byte. Null when the register withholds the file, or when it lies past the copies kept per case (see `documents_kept`)."},"source_document_url":{"type":"string","description":"The register's own link to the file."},"bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Size of our copy in bytes."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's type as the register names it, e.g. `TM5 - Requerimiento Examen de Forma`."},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"act_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"sent_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"notified_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"enforced_on":{"anyOf":[{"type":"string"},{"type":"null"}]},"parties":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party the document was notified to, as the register writes it."},"notified_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` that party was notified."},"enforced_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act became final for that party (ejecutoria)."}},"required":["name","notified_on","enforced_on"]}}},"required":["name","document_url","source_document_url","bytes","title","resolution_number","document_date","act_date","sent_date","notified_on","enforced_on","parties"]},"description":"Every document of the file, newest first: resolutions, oficios, the applicant's filings, certificates."},"documents_total":{"type":"integer","description":"Documents the register lists for the case."},"documents_kept":{"type":"integer","description":"Documents of which Croma holds a copy; the newest ones are kept when a file has more than the per-case limit."},"fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]},"description":"Every labelled field of the case page, as the register prints it, for anything the named fields above do not carry."},"checked_at":{"type":"string"}},"required":["file_number","kind","procedure_type","status","title","sign_type","sign_nature","filing_date","submitted_on","publication_ordered_on","gazette_number","published_on","certificate_number","registered_on","expires_on","applicant_reference","nice_version","classes","nice_classes","locarno","patent_type","technology_sector","technology_subsector","abstract","design_type","parties","images","specification","history","linked_procedures","documents","documents_total","documents_kept","fields","checked_at"]},{"type":"null"}]}},"required":["found","file_number","checked_at","served_from","design"]},"SicIpDesignResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicIpDesignData"}}},"SicIpTrademarksByOwnerData":{"type":"object","properties":{"document_number":{"type":"string"},"found":{"type":"boolean","description":"False when the register knows no owner or applicant under the number."},"parties":{"type":"array","items":{"type":"object","properties":{"document_number":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["document_number","name"]},"description":"The register's party records the number matched (a company can appear with and without its check digit)."},"total":{"type":"integer","description":"Trademark cases found for those parties."},"checked_at":{"type":"string","description":"When the register was read."},"trademarks":{"type":"array","items":{"type":"object","properties":{"file_number":{"type":"string","description":"The file number (expediente) the register gave the case when it was filed, e.g. `SD2026/0031979`, `NC2026/0006185`, or the bare digits of a file opened before 2016 (`16137606`). It identifies the case for its whole life."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's status as the register words it, e.g. `Registrada`, `Publicada`, `Concedida`, `Negada`, `Caducado`."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the application was filed (fecha de presentación); what `from_date` and `to_date` filter on."},"owners":{"type":"array","items":{"type":"string"},"description":"The owners (titulares), or the applicants while the case is pending, as the register lists them."},"certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registration certificate number, once the mark registered, e.g. `612592`."},"sign":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sign (denominación) as filed, e.g. `CAFÉ BOSQUE ADENTRO`. Null for a purely figurative mark."},"expires_on":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the registration runs out unless renewed (vigencia)."},"nice_classes":{"type":"array","items":{"type":"string"},"description":"The Nice classes the mark covers, e.g. [\"29\", \"30\"]."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the Gaceta de Propiedad Industrial that published the application."},"source_label_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own link to the label."},"label_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the label, when the trademarks register copy already holds the case."}},"required":["file_number","status","filing_date","owners","certificate_number","sign","expires_on","nice_classes","gazette_number","source_label_url","label_url"]}}},"required":["document_number","found","parties","total","checked_at","trademarks"]},"SicIpTrademarksByOwnerResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SicIpTrademarksByOwnerData"}}},"SuitProceduresSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"order":{"type":"string"},"entity_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The procedure's número único in the national register, e.g. `44`. gov.co shows it as `T44`."},"number":{"type":"integer","description":"The procedure's número único in the national register."},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The procedure's version number in the register."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure's state in the register, e.g. \"PUBLICADO\"."},"procedure_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The class of procedure, e.g. \"UNICO\" (one entity's own) or \"MODELO\" (a standard procedure many entities offer)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure's name."},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the procedure is for, as the register states it."},"result":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the person obtains at the end."},"time_to_obtain":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How long it takes, as the register states it, e.g. \"35 días\"."},"entity_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's code of the entity that offers the procedure."},"entity_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity that offers the procedure."},"entity_order":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"NACIONAL\" or \"TERRITORIAL\"."},"entity_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For territorial entities, \"MUNICIPAL\", \"DEPARTAMENTAL\" or \"DISTRITAL\"."},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DANE code of the entity's department."},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DANE code of the entity's municipality."},"municipality_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's municipality."},"online":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the procedure can be done online: \"TOTALMENTE\", \"PARCIALMENTE\" or \"NO\"."},"online_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the procedure is done online, when it can be."},"manual_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The user manual for doing the procedure online, when there is one."},"entity_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The website of the entity that offers the procedure."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the procedure's information was last updated in the register, ISO 8601."},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When this version of the procedure's information was created, ISO 8601."},"official_url":{"type":"string","description":"The procedure on gov.co, the state's portal."}},"required":["id","number","version","state","procedure_class","name","purpose","result","time_to_obtain","entity_code","entity_name","entity_order","entity_level","department_code","municipality_code","municipality_name","online","online_url","manual_url","entity_url","modified_at","created_at","official_url"]}}},"required":["as_of","query","order","entity_code","department_code","municipality_code","total","total_is_exact","page","per_page","total_pages","count","results"]},"SuitProceduresSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SuitProceduresSearchData"}}},"SuitProcedureData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"procedure_id":{"type":"string"},"procedure":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The procedure's número único in the national register, e.g. `44`. gov.co shows it as `T44`."},"number":{"type":"integer","description":"The procedure's número único in the national register."},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The procedure's version number in the register."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure's state in the register, e.g. \"PUBLICADO\"."},"procedure_class":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The class of procedure, e.g. \"UNICO\" (one entity's own) or \"MODELO\" (a standard procedure many entities offer)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure's name."},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the procedure is for, as the register states it."},"result":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the person obtains at the end."},"time_to_obtain":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How long it takes, as the register states it, e.g. \"35 días\"."},"entity_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's code of the entity that offers the procedure."},"entity_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity that offers the procedure."},"entity_order":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"NACIONAL\" or \"TERRITORIAL\"."},"entity_level":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For territorial entities, \"MUNICIPAL\", \"DEPARTAMENTAL\" or \"DISTRITAL\"."},"department_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DANE code of the entity's department."},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DANE code of the entity's municipality."},"municipality_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity's municipality."},"online":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the procedure can be done online: \"TOTALMENTE\", \"PARCIALMENTE\" or \"NO\"."},"online_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the procedure is done online, when it can be."},"manual_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The user manual for doing the procedure online, when there is one."},"entity_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The website of the entity that offers the procedure."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the procedure's information was last updated in the register, ISO 8601."},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When this version of the procedure's information was created, ISO 8601."},"official_url":{"type":"string","description":"The procedure on gov.co, the state's portal."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the procedure's information, as markdown."},"offset":{"type":"number","description":"First character of the range."},"total_length":{"type":"number","description":"Length of the whole text 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 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 procedure's information as markdown, or null when there is none."}},"required":["id","number","version","state","procedure_class","name","purpose","result","time_to_obtain","entity_code","entity_name","entity_order","entity_level","department_code","municipality_code","municipality_name","online","online_url","manual_url","entity_url","modified_at","created_at","official_url","content"]},{"type":"null"}]}},"required":["as_of","found","procedure_id","procedure"]},"SuitProcedureResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SuitProcedureData"}}},"GovPagesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"site":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match."},"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 page's permanent id: a short hash of its address."},"site":{"type":"string","description":"Which entity's site: `cancilleria` or `unidad-victimas`."},"entity":{"type":"string","description":"The entity that publishes the page."},"url":{"type":"string","description":"The page's address on the entity's site."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page's own title."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the entity last changed the page, ISO 8601, when its site says so."}},"required":["id","site","entity","url","title","modified_at"]}}},"required":["as_of","query","site","total","total_is_exact","page","per_page","total_pages","count","results"]},"GovPagesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GovPagesSearchData"}}},"GovPageData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"page_id":{"type":"string"},"page":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The page's permanent id: a short hash of its address."},"site":{"type":"string","description":"Which entity's site: `cancilleria` or `unidad-victimas`."},"entity":{"type":"string","description":"The entity that publishes the page."},"url":{"type":"string","description":"The page's address on the entity's site."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page's own title."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the entity last changed the page, ISO 8601, when its site says so."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the page's content, as markdown."},"offset":{"type":"number","description":"First character of the range."},"total_length":{"type":"number","description":"Length of the whole content in characters."},"has_more":{"type":"boolean","description":"Whether the content 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."}},"required":["text","offset","total_length","has_more","next_offset"]},{"type":"null"}],"description":"A range of the page's content as markdown."}},"required":["id","site","entity","url","title","modified_at","content"]},{"type":"null"}]}},"required":["as_of","found","page_id","page"]},"GovPageResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GovPageData"}}},"CsjSvRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"court_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"court":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"proceeding_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"crime":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The resolution's permanent number at the Corte Suprema's documentation center, e.g. \"1138697\". One case can have several resolutions, so the reference number is not unique."},"registration_number":{"type":"string","description":"The reference number (N°) as the court prints it, e.g. \"49COMP2026\", \"86-CAC-2026\", \"INC-8-2026\"."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the court handed the resolution down."},"year":{"type":"number","description":"The year of the resolution."},"court_type":{"anyOf":[{"type":"string","enum":["corte_plena","sala","camara","tribunal_de_sentencia","juzgado"]},{"type":"null"}],"description":"The level of the court: `corte_plena`, `sala` (a Sala of the Corte Suprema), `camara` (a second-instance Cámara), `tribunal_de_sentencia` or `juzgado`."},"court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court as the documentation center names it, e.g. \"SALA DE LO CONSTITUCIONAL\", \"CÁMARA SEGUNDA DE LO LABORAL, SAN SALVADOR\"."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The area of law (materia), e.g. \"PENAL\", \"FAMILIA\", \"CIVIL Y MERCANTIL\", \"CONSTITUCIONAL\", \"LABORAL\"."},"proceeding_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of proceeding (tipo de proceso), e.g. \"AMPARO\", \"HÁBEAS CORPUS\", \"INCONSTITUCIONALIDAD\", \"CONFLICTOS DE COMPETENCIA EN DERECHO PENAL\"."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of resolution (tipo de resolución), e.g. \"Sentencias Definitivas\", \"Interlocutorias\", \"Improcedencias\", \"Autos definitivos\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The appeal decided (tipo de recurso), e.g. \"RECURSO DE CASACION\", \"RECURSO DE APELACION\"."},"lawsuit_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of civil or commercial action (tipo de juicio), e.g. \"Proceso ejecutivo\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided (fallo), in the documentation center's words."},"facts":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The documentation center's summary of the facts and of the court's reasoning (cuadro fáctico)."},"crimes":{"type":"array","items":{"type":"string"},"description":"The crimes the resolution deals with, e.g. [\"Homicidio agravado\"]. Empty outside criminal matters."},"lower_courts":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court or courts the case came from (tribunales de procedencia)."},"courts_in_conflict":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The courts whose jurisdiction dispute the resolution settles (tribunales en conflicto)."},"challenged_act":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act or provision challenged (acto reclamado, acto impugnado, disposición impugnada)."},"rights_invoked":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rights the claimant says were violated (derechos vulnerados)."},"grounds":{"type":"array","items":{"type":"string"},"description":"The grounds of the appeal or cassation (motivos), as recorded."},"applied_law":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedural law applied, e.g. \"D.L. Nº 733 del 22 de Octubre de 2008 - VIGENTE\"."},"other_fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The field's name as the court's record prints it."},"value":{"type":"string"}},"required":["label","value"]},"description":"Any other field of the court's record for this resolution, by its label. Party names are never included."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The topics the documentation center filed the resolution under, one per headnote, e.g. [\"PROCEDIMIENTO SUMARIO\"]. Empty when it wrote none."},"extracts":{"type":"array","items":{"type":"object","properties":{"descriptor":{"type":"string","description":"The topic the headnote is filed under, e.g. \"PROCEDIMIENTO SUMARIO\"."},"restrictors":{"type":"array","items":{"type":"string"},"description":"What the court held on that topic, one line each, as the documentation center wrote them."}},"required":["descriptor","restrictors"]},"description":"The headnotes (extractos, máximas): each topic with the holdings the documentation center drew from the resolution."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the court published the resolution as an image with no text in it; `missing` when it published no readable document."},"official_url":{"type":"string","description":"The resolution's record at the Corte Suprema's documentation center."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the resolution's original document (PDF), byte for byte as the court published it. It stays available whatever happens to the court's own link. Null when the court publishes no document for the resolution."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The resolution's document on the Corte Suprema's own site, as the court links it. Null when the court links none."}},"required":["id","registration_number","ruling_date","year","court_type","court","subject","proceeding_type","type","appeal_type","lawsuit_type","decision","facts","crimes","lower_courts","courts_in_conflict","challenged_act","rights_invoked","grounds","applied_law","other_fields","descriptors","extracts","text_status","official_url","document_url","source_document_url"]}}},"required":["as_of","query","court_type","court","subject","proceeding_type","type","crime","registration_number","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"CsjSvRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CsjSvRulingsSearchData"}}},"CsjSvRulingData":{"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 resolution's permanent number at the Corte Suprema's documentation center, e.g. \"1138697\". One case can have several resolutions, so the reference number is not unique."},"registration_number":{"type":"string","description":"The reference number (N°) as the court prints it, e.g. \"49COMP2026\", \"86-CAC-2026\", \"INC-8-2026\"."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the court handed the resolution down."},"year":{"type":"number","description":"The year of the resolution."},"court_type":{"anyOf":[{"type":"string","enum":["corte_plena","sala","camara","tribunal_de_sentencia","juzgado"]},{"type":"null"}],"description":"The level of the court: `corte_plena`, `sala` (a Sala of the Corte Suprema), `camara` (a second-instance Cámara), `tribunal_de_sentencia` or `juzgado`."},"court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court as the documentation center names it, e.g. \"SALA DE LO CONSTITUCIONAL\", \"CÁMARA SEGUNDA DE LO LABORAL, SAN SALVADOR\"."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The area of law (materia), e.g. \"PENAL\", \"FAMILIA\", \"CIVIL Y MERCANTIL\", \"CONSTITUCIONAL\", \"LABORAL\"."},"proceeding_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of proceeding (tipo de proceso), e.g. \"AMPARO\", \"HÁBEAS CORPUS\", \"INCONSTITUCIONALIDAD\", \"CONFLICTOS DE COMPETENCIA EN DERECHO PENAL\"."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of resolution (tipo de resolución), e.g. \"Sentencias Definitivas\", \"Interlocutorias\", \"Improcedencias\", \"Autos definitivos\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The appeal decided (tipo de recurso), e.g. \"RECURSO DE CASACION\", \"RECURSO DE APELACION\"."},"lawsuit_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of civil or commercial action (tipo de juicio), e.g. \"Proceso ejecutivo\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided (fallo), in the documentation center's words."},"facts":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The documentation center's summary of the facts and of the court's reasoning (cuadro fáctico)."},"crimes":{"type":"array","items":{"type":"string"},"description":"The crimes the resolution deals with, e.g. [\"Homicidio agravado\"]. Empty outside criminal matters."},"lower_courts":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court or courts the case came from (tribunales de procedencia)."},"courts_in_conflict":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The courts whose jurisdiction dispute the resolution settles (tribunales en conflicto)."},"challenged_act":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act or provision challenged (acto reclamado, acto impugnado, disposición impugnada)."},"rights_invoked":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rights the claimant says were violated (derechos vulnerados)."},"grounds":{"type":"array","items":{"type":"string"},"description":"The grounds of the appeal or cassation (motivos), as recorded."},"applied_law":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedural law applied, e.g. \"D.L. Nº 733 del 22 de Octubre de 2008 - VIGENTE\"."},"other_fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The field's name as the court's record prints it."},"value":{"type":"string"}},"required":["label","value"]},"description":"Any other field of the court's record for this resolution, by its label. Party names are never included."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The topics the documentation center filed the resolution under, one per headnote, e.g. [\"PROCEDIMIENTO SUMARIO\"]. Empty when it wrote none."},"extracts":{"type":"array","items":{"type":"object","properties":{"descriptor":{"type":"string","description":"The topic the headnote is filed under, e.g. \"PROCEDIMIENTO SUMARIO\"."},"restrictors":{"type":"array","items":{"type":"string"},"description":"What the court held on that topic, one line each, as the documentation center wrote them."}},"required":["descriptor","restrictors"]},"description":"The headnotes (extractos, máximas): each topic with the holdings the documentation center drew from the resolution."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the court published the resolution as an image with no text in it; `missing` when it published no readable document."},"official_url":{"type":"string","description":"The resolution's record at the Corte Suprema's documentation center."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the resolution's original document (PDF), byte for byte as the court published it. It stays available whatever happens to the court's own link. Null when the court publishes no document for the resolution."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The resolution's document on the Corte Suprema's own site, as the court links it. Null when the court links none."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the resolution'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 resolution's text, or null when `text_status` is not `ok`."}},"required":["id","registration_number","ruling_date","year","court_type","court","subject","proceeding_type","type","appeal_type","lawsuit_type","decision","facts","crimes","lower_courts","courts_in_conflict","challenged_act","rights_invoked","grounds","applied_law","other_fields","descriptors","extracts","text_status","official_url","document_url","source_document_url","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"CsjSvRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CsjSvRulingData"}}},"CsjSvLawsSearchData":{"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"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The document's permanent number at the Corte Suprema's documentation center, e.g. \"558819\" (the Código Penal)."},"title":{"type":"string","description":"The document's name, e.g. \"CODIGO PENAL\"."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of document: \"Decretos Legislativos\", \"Decretos Ejecutivos\", \"Decretos Institucionales\", \"Acuerdos\", \"Reglamentos\", \"Ordenanzas Municipales\" or \"Documentos Generales\"."},"nature":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal nature of the act, e.g. \"Decreto Legislativo\", \"Decreto Municipal\", \"Acuerdo Ejecutivo\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The decree or agreement number, e.g. \"1030\"."},"status":{"anyOf":[{"type":"string","enum":["vigente","caducada","derogada"]},{"type":"null"}],"description":"Whether the document is in force: `vigente`, `caducada` (expired) or `derogada` (repealed), as the documentation center records it."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The area of law, e.g. \"Penal\", \"Tributaria\", \"Administrativa\"."},"issuing_body":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who issued it, e.g. \"ORGANO LEGISLATIVO\", \"ORGANO EJECUTIVO (Ministerio de Salud)\"."},"state_organ":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The branch of the state, when recorded: \"Legislativo\", \"Ejecutivo\", \"Judicial\" or \"Instituciones autónomas\"."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality of an ordinance."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department of an ordinance."},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was issued."},"publication_date":{"type":"string","description":"`yyyy-mm-dd` the act was published in the Diario Oficial."},"year":{"type":"number","description":"The year of publication in the Diario Oficial."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the Diario Oficial that published it."},"gazette_volume":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The volume (tomo) of the Diario Oficial that published it."},"considerations":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The documentation center's summary of what the act is for."},"reform_count":{"type":"number","description":"How many amendments the documentation center records."},"related_rulings":{"type":"array","items":{"type":"string"},"description":"The `id`s of rulings of the Corte Suprema de Justicia de El Salvador the documentation center relates to this act (read them with the ruling endpoint)."},"other_fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The field's name as the court's record prints it."},"value":{"type":"string"}},"required":["label","value"]},"description":"Any other field of the court's record for this act, by its label."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when the court publishes no readable document."},"official_url":{"type":"string","description":"The act's record at the Corte Suprema's documentation center."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the current version of the act's document (PDF), byte for byte as the court published it. Null when the court publishes none."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's document on the Corte Suprema's own site, which the court rewrites when it incorporates an amendment."},"document_modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the court last changed the current version of the document."}},"required":["id","title","type","nature","number","status","subject","issuing_body","state_organ","municipality","department","issue_date","publication_date","year","gazette_number","gazette_volume","considerations","reform_count","related_rulings","other_fields","text_status","official_url","document_url","source_document_url","document_modified_at"]}}},"required":["as_of","query","type","status","subject","number","municipality","department","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"CsjSvLawsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CsjSvLawsSearchData"}}},"CsjSvLawData":{"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"},"law":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The document's permanent number at the Corte Suprema's documentation center, e.g. \"558819\" (the Código Penal)."},"title":{"type":"string","description":"The document's name, e.g. \"CODIGO PENAL\"."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of document: \"Decretos Legislativos\", \"Decretos Ejecutivos\", \"Decretos Institucionales\", \"Acuerdos\", \"Reglamentos\", \"Ordenanzas Municipales\" or \"Documentos Generales\"."},"nature":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The legal nature of the act, e.g. \"Decreto Legislativo\", \"Decreto Municipal\", \"Acuerdo Ejecutivo\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The decree or agreement number, e.g. \"1030\"."},"status":{"anyOf":[{"type":"string","enum":["vigente","caducada","derogada"]},{"type":"null"}],"description":"Whether the document is in force: `vigente`, `caducada` (expired) or `derogada` (repealed), as the documentation center records it."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The area of law, e.g. \"Penal\", \"Tributaria\", \"Administrativa\"."},"issuing_body":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who issued it, e.g. \"ORGANO LEGISLATIVO\", \"ORGANO EJECUTIVO (Ministerio de Salud)\"."},"state_organ":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The branch of the state, when recorded: \"Legislativo\", \"Ejecutivo\", \"Judicial\" or \"Instituciones autónomas\"."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality of an ordinance."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department of an ordinance."},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was issued."},"publication_date":{"type":"string","description":"`yyyy-mm-dd` the act was published in the Diario Oficial."},"year":{"type":"number","description":"The year of publication in the Diario Oficial."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the Diario Oficial that published it."},"gazette_volume":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The volume (tomo) of the Diario Oficial that published it."},"considerations":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The documentation center's summary of what the act is for."},"reforms":{"type":"array","items":{"type":"object","properties":{"order":{"type":"number","description":"The amendment's place in the documentation center's list, 1 for the oldest."},"decree":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The amending act as the documentation center cites it, e.g. \"Decreto Legislativo No. 537 de fecha 26 de marzo de 2026, publicado en el Diario Oficial No. 61, Tomo 450 de fecha 27 de marzo de 2026\"."},"decree_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The amending act's number, e.g. \"537\"."},"issuing_body":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who issued the amending act, e.g. \"ORGANO LEGISLATIVO\"."},"decree_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the amending act was issued."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the amending act was published in the Diario Oficial."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the Diario Oficial that published it."},"gazette_volume":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The volume (tomo) of the Diario Oficial that published it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the amending act's text, byte for byte as the documentation center published it. Null when it publishes none."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The amending act's text on the Corte Suprema's own site. Null when it links none."}},"required":["order","decree","decree_number","issuing_body","decree_date","publication_date","gazette_number","gazette_volume","document_url","source_document_url"]},"description":"Every amendment the documentation center records, oldest first, each with its act, dates and its own text."},"reform_count":{"type":"number","description":"How many amendments the documentation center records."},"related_rulings":{"type":"array","items":{"type":"string"},"description":"The `id`s of rulings of the Corte Suprema de Justicia de El Salvador the documentation center relates to this act (read them with the ruling endpoint)."},"other_fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The field's name as the court's record prints it."},"value":{"type":"string"}},"required":["label","value"]},"description":"Any other field of the court's record for this act, by its label."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when the court publishes no readable document."},"official_url":{"type":"string","description":"The act's record at the Corte Suprema's documentation center."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the current version of the act's document (PDF), byte for byte as the court published it. Null when the court publishes none."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's document on the Corte Suprema's own site, which the court rewrites when it incorporates an amendment."},"document_modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the court last changed the current version of the document."},"document_versions":{"type":"array","items":{"type":"object","properties":{"document_url":{"type":"string","description":"Croma's copy of this version of the document."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the court last changed this version of the document, as its site reports it. Null when it reports nothing."},"bytes":{"type":"number","description":"The document's size in bytes."}},"required":["document_url","modified_at","bytes"]},"description":"Every version of the act's document Croma has kept, oldest first: the court rewrites a consolidated text in place when it incorporates an amendment, and each version stays available here."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the act'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 act's text, or null when `text_status` is not `ok`."}},"required":["id","title","type","nature","number","status","subject","issuing_body","state_organ","municipality","department","issue_date","publication_date","year","gazette_number","gazette_volume","considerations","reforms","reform_count","related_rulings","other_fields","text_status","official_url","document_url","source_document_url","document_modified_at","document_versions","content"]},{"type":"null"}]}},"required":["as_of","found","law_id","law"]},"CsjSvLawResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CsjSvLawData"}}},"AsambleaSvDecreesSearchData":{"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"}]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"subtopic":{"anyOf":[{"type":"string"},{"type":"null"}]},"area_of_law":{"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The decree's permanent number in the Asamblea Legislativa's register, e.g. \"7000\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The decree number, e.g. \"632\". Numbers restart with each legislature."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of act: \"Decreto\", \"Ley\", \"Código\" or \"Reglamento\"."},"title":{"type":"string","description":"The decree's title as the Asamblea registers it."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Asamblea's summary of what the decree provides."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subject (materia) the Asamblea files it under, e.g. \"Hacienda y Presupuesto\"."},"subtopic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subtopic (sub-materia), e.g. \"Autorizaciones para Préstamos\"."},"area_of_law":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The area of law (rama del derecho), e.g. \"Derecho Administrativo\"."},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Asamblea issued the decree."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year the Asamblea issued the decree."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of publication in the Diario Oficial. While `pending_publication` is true, the date the Diario Oficial has assigned."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the Diario Oficial that publishes it."},"gazette_volume":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The volume (tomo) of the Diario Oficial that publishes it."},"pending_publication":{"type":"boolean","description":"True while the decree awaits its publication in the Diario Oficial; `publication_date` is then the date assigned to it."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when the Asamblea publishes no readable document yet."},"official_url":{"type":"string","description":"The decree's record on the Asamblea Legislativa's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the decree's document (PDF), byte for byte as the Asamblea published it. Null when it publishes none."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The decree's document on the Asamblea Legislativa's own site."},"document_modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Asamblea last changed the document, as its site reports it."}},"required":["id","number","type","title","summary","subject","subtopic","area_of_law","issue_date","year","publication_date","gazette_number","gazette_volume","pending_publication","text_status","official_url","document_url","source_document_url","document_modified_at"]}}},"required":["as_of","query","type","subject","subtopic","area_of_law","number","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"AsambleaSvDecreesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AsambleaSvDecreesSearchData"}}},"AsambleaSvDecreeData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"decree_id":{"type":"string"},"decree":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The decree's permanent number in the Asamblea Legislativa's register, e.g. \"7000\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The decree number, e.g. \"632\". Numbers restart with each legislature."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of act: \"Decreto\", \"Ley\", \"Código\" or \"Reglamento\"."},"title":{"type":"string","description":"The decree's title as the Asamblea registers it."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Asamblea's summary of what the decree provides."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subject (materia) the Asamblea files it under, e.g. \"Hacienda y Presupuesto\"."},"subtopic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subtopic (sub-materia), e.g. \"Autorizaciones para Préstamos\"."},"area_of_law":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The area of law (rama del derecho), e.g. \"Derecho Administrativo\"."},"issue_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Asamblea issued the decree."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year the Asamblea issued the decree."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of publication in the Diario Oficial. While `pending_publication` is true, the date the Diario Oficial has assigned."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the Diario Oficial that publishes it."},"gazette_volume":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The volume (tomo) of the Diario Oficial that publishes it."},"pending_publication":{"type":"boolean","description":"True while the decree awaits its publication in the Diario Oficial; `publication_date` is then the date assigned to it."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when the Asamblea publishes no readable document yet."},"official_url":{"type":"string","description":"The decree's record on the Asamblea Legislativa's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the decree's document (PDF), byte for byte as the Asamblea published it. Null when it publishes none."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The decree's document on the Asamblea Legislativa's own site."},"document_modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Asamblea last changed the document, as its site reports it."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the decree'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 decree's text, or null when `text_status` is not `ok`."}},"required":["id","number","type","title","summary","subject","subtopic","area_of_law","issue_date","year","publication_date","gazette_number","gazette_volume","pending_publication","text_status","official_url","document_url","source_document_url","document_modified_at","content"]},{"type":"null"}]}},"required":["as_of","found","decree_id","decree"]},"AsambleaSvDecreeResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AsambleaSvDecreeData"}}},"MiturSvPlacesSearchData":{"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"}]},"theme":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"registered_only":{"type":"boolean"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The place's permanent id in the official tourism directory, e.g. \"2905\"."},"slug":{"type":"string","description":"The place's slug on the official tourism site, e.g. \"berlin\"."},"name":{"type":"string","description":"The place's name as the Ministerio de Turismo lists it."},"kind":{"type":"string","enum":["destination","attraction","restaurant","lodging","transport","recreation","tourist_info","surf_school","guide"],"description":"`destination`, `attraction` (a tourist site), `restaurant`, `lodging`, `transport`, `recreation`, `tourist_info`, `surf_school` or `guide` (a certified tour guide)."},"themes":{"type":"array","items":{"type":"string"},"description":"The themes a destination is filed under: `surf_city`, `bitcoin`, `nature_adventure`, `archaeology`, `towns`, `wellness` or `regional`. Empty for other kinds."},"guide_level":{"anyOf":[{"type":"string","enum":["site","local","national"]},{"type":"null"}],"description":"For a guide: certified for one `site`, `local` or `national`. Null for other kinds."},"registered":{"type":"boolean","description":"Whether the business is inscribed in the national tourism registry (Registro Nacional de Turismo)."},"access":{"anyOf":[{"type":"string","enum":["public","private"]},{"type":"null"}],"description":"For a tourist site: whether it is public or privately run. Null for other kinds."},"department":{"anyOf":[{"type":"string","enum":["Ahuachapán","Cabañas","Chalatenango","Cuscatlán","La Libertad","La Paz","La Unión","Morazán","San Miguel","San Salvador","San Vicente","Santa Ana","Sonsonate","Usulután"]},{"type":"null"}],"description":"The department of El Salvador the place is in."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The town or municipality, e.g. \"Tamanique\"."},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The tourism region the Ministerio places a destination in, e.g. \"La Libertad Costa\"."},"languages":{"type":"array","items":{"type":"string"},"description":"For a guide: the languages they work in, as ISO 639 codes."},"hours":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Opening hours and fees as published."},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phone numbers. Empty for guides."},"emails":{"type":"array","items":{"type":"string"},"description":"Contact email addresses. Empty for guides."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address as published. Null for guides."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's own website."},"whatsapp":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A WhatsApp number or link."},"social_links":{"type":"array","items":{"type":"string"},"description":"The business's own social media pages."},"official_url":{"type":"string","description":"The place's page on the official tourism site."},"updated_at":{"type":"string","description":"When the Ministerio last changed the listing."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of a destination's description, at most about 320 characters. Null for listings."}},"required":["id","slug","name","kind","themes","guide_level","registered","access","department","municipality","region","languages","hours","phones","emails","address","website","whatsapp","social_links","official_url","updated_at","summary"]}}},"required":["as_of","query","kind","theme","department","municipality","language","registered_only","total","total_is_exact","page","per_page","total_pages","count","results"]},"MiturSvPlacesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MiturSvPlacesSearchData"}}},"MiturSvPlaceData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"place_id":{"type":"string"},"place":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The place's permanent id in the official tourism directory, e.g. \"2905\"."},"slug":{"type":"string","description":"The place's slug on the official tourism site, e.g. \"berlin\"."},"name":{"type":"string","description":"The place's name as the Ministerio de Turismo lists it."},"kind":{"type":"string","enum":["destination","attraction","restaurant","lodging","transport","recreation","tourist_info","surf_school","guide"],"description":"`destination`, `attraction` (a tourist site), `restaurant`, `lodging`, `transport`, `recreation`, `tourist_info`, `surf_school` or `guide` (a certified tour guide)."},"themes":{"type":"array","items":{"type":"string"},"description":"The themes a destination is filed under: `surf_city`, `bitcoin`, `nature_adventure`, `archaeology`, `towns`, `wellness` or `regional`. Empty for other kinds."},"guide_level":{"anyOf":[{"type":"string","enum":["site","local","national"]},{"type":"null"}],"description":"For a guide: certified for one `site`, `local` or `national`. Null for other kinds."},"registered":{"type":"boolean","description":"Whether the business is inscribed in the national tourism registry (Registro Nacional de Turismo)."},"access":{"anyOf":[{"type":"string","enum":["public","private"]},{"type":"null"}],"description":"For a tourist site: whether it is public or privately run. Null for other kinds."},"department":{"anyOf":[{"type":"string","enum":["Ahuachapán","Cabañas","Chalatenango","Cuscatlán","La Libertad","La Paz","La Unión","Morazán","San Miguel","San Salvador","San Vicente","Santa Ana","Sonsonate","Usulután"]},{"type":"null"}],"description":"The department of El Salvador the place is in."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The town or municipality, e.g. \"Tamanique\"."},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The tourism region the Ministerio places a destination in, e.g. \"La Libertad Costa\"."},"languages":{"type":"array","items":{"type":"string"},"description":"For a guide: the languages they work in, as ISO 639 codes."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Ministerio's description of a destination. Null for listings."},"hours":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Opening hours and fees as published."},"phones":{"type":"array","items":{"type":"string"},"description":"Contact phone numbers. Empty for guides."},"emails":{"type":"array","items":{"type":"string"},"description":"Contact email addresses. Empty for guides."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address as published. Null for guides."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business's own website."},"whatsapp":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A WhatsApp number or link."},"social_links":{"type":"array","items":{"type":"string"},"description":"The business's own social media pages."},"photos":{"type":"array","items":{"type":"object","properties":{"document_url":{"type":"string","description":"Croma's copy of the photo, byte for byte as the Ministerio de Turismo published it."},"source_document_url":{"type":"string","description":"The photo on the official tourism site."}},"required":["document_url","source_document_url"]},"description":"The destination's photo gallery."},"official_url":{"type":"string","description":"The place's page on the official tourism site."},"updated_at":{"type":"string","description":"When the Ministerio last changed the listing."}},"required":["id","slug","name","kind","themes","guide_level","registered","access","department","municipality","region","languages","description","hours","phones","emails","address","website","whatsapp","social_links","photos","official_url","updated_at"]},{"type":"null"}]}},"required":["as_of","found","place_id","place"]},"MiturSvPlaceResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MiturSvPlaceData"}}},"MiturSvEventsSearchData":{"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"}]},"from_date":{"type":"string","description":"Events still running on or after this date. Today in El Salvador unless given."},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The event's permanent id in the official agenda, e.g. \"22744\"."},"slug":{"type":"string","description":"The event's slug on the official tourism site."},"name":{"type":"string","description":"The event's name."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the event starts."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the event ends; the start date for a one-day event."},"venue":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where it takes place, e.g. \"Centro Histórico de San Salvador\"."},"department":{"anyOf":[{"type":"string","enum":["Ahuachapán","Cabañas","Chalatenango","Cuscatlán","La Libertad","La Paz","La Unión","Morazán","San Miguel","San Salvador","San Vicente","Santa Ana","Sonsonate","Usulután"]},{"type":"null"}],"description":"The department of El Salvador it takes place in."},"links":{"type":"array","items":{"type":"string"},"description":"Links the agenda gives for more information: the organiser's page, tickets, a post."},"official_url":{"type":"string","description":"The event's page on the official tourism site."},"updated_at":{"type":"string","description":"When the Ministerio last changed the event."}},"required":["id","slug","name","start_date","end_date","venue","department","links","official_url","updated_at"]}}},"required":["as_of","query","department","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"MiturSvEventsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MiturSvEventsSearchData"}}},"ComprasalSvSuppliersSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"sanctioned_only":{"type":"boolean"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The supplier's permanent id in COMPRASAL's supplier register, e.g. `392`, the `supplier_id` other endpoints take."},"name":{"type":"string","description":"The supplier's registered name: a company's legal name, or a person's name for a sole trader."},"trade_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The supplier's trade name."},"sanctioned":{"type":"boolean","description":"Whether COMPRASAL flags the supplier as sanctioned."},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How close the name or trade name is to `query`, 0 to 100. Null without a query."}},"required":["id","name","trade_name","sanctioned","score"]}}},"required":["as_of","query","sanctioned_only","total","total_is_exact","page","per_page","total_pages","count","results"]},"ComprasalSvSuppliersSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ComprasalSvSuppliersSearchData"}}},"ComprasalSvSupplierData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"supplier_id":{"type":"number"},"supplier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The supplier's permanent id in COMPRASAL's supplier register, e.g. `392`, the `supplier_id` other endpoints take."},"name":{"type":"string","description":"The supplier's registered name: a company's legal name, or a person's name for a sole trader."},"trade_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The supplier's trade name."},"sanctioned":{"type":"boolean","description":"Whether COMPRASAL flags the supplier as sanctioned."}},"required":["id","name","trade_name","sanctioned"]},{"type":"null"}]},"sanctions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The sanction's identity in Croma's copy: its start date, the sanctioned name and the sanctioning entity."},"name":{"type":"string","description":"The sanctioned supplier, as the list names it."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the sanction starts."},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the sanction ends."},"sanctioning_entity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entity that imposed it."},"list":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The list COMPRASAL carries it on, e.g. \"SancionHomologada\"."},"active":{"type":"boolean","description":"Whether the sanction is in force today in El Salvador."},"score":{"type":"number","description":"How close the sanctioned name is to the supplier's name, 0 to 100."}},"required":["id","name","start_date","end_date","sanctioning_entity","list","active","score"]},"description":"Entries of the sanctions list whose name matches the supplier's name or trade name, best match first."},"awards":{"anyOf":[{"type":"object","properties":{"total":{"type":"number","description":"Every award to the supplier in COMPRASAL."},"summarized":{"type":"number","description":"How many of them the amounts and entities below add up; all of them unless `summary_is_complete` is false."},"summary_is_complete":{"type":"boolean"},"amount":{"type":"number","description":"Total amount of the summarized awards, in US dollars."},"first_awarded_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_awarded_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"anyOf":[{"type":"number"},{"type":"null"}]},"entity_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"awards":{"type":"number","description":"Awards to the supplier from this entity, among those summarized."},"amount":{"type":"number","description":"Their total amount, in US dollars."}},"required":["entity_id","entity_name","awards","amount"]},"description":"The entities the supplier sold to, most awards first."},"latest":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The award's permanent id in COMPRASAL, e.g. `587047`."},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The amount awarded to the supplier, in US dollars."},"awarded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the award was made. Null when COMPRASAL has not dated it."},"process_id":{"type":"integer","description":"The procurement process the award belongs to."},"process_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The process code, e.g. \"1000009-2026-P0003\": the entity's code, the year and a sequence."},"process_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What was bought, as the entity named the process."},"contracting_method":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How it was contracted, e.g. \"Subasta Inversa\", \"Comparación de precios\", \"Licitación competitiva\"."},"contracting_method_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting method's code, e.g. \"SI\", \"CP\", \"LC\"."},"entity_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The contracting entity's id in COMPRASAL."},"entity_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting entity's code, e.g. \"4100\" for the Ministerio de Economía."},"entity_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting entity."},"supplier_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The supplier's id in COMPRASAL's supplier register, the same `id` the suppliers search returns."},"supplier_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The supplier's registered name."},"supplier_trade_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The supplier's trade name."},"official_url":{"type":"string","description":"The award on COMPRASAL."}},"required":["id","amount","awarded_date","process_id","process_code","process_name","contracting_method","contracting_method_code","entity_id","entity_code","entity_name","supplier_id","supplier_name","supplier_trade_name","official_url"]},"description":"The most recent awards, newest first."}},"required":["total","summarized","summary_is_complete","amount","first_awarded_date","last_awarded_date","entities","latest"]},{"type":"null"}]}},"required":["as_of","found","supplier_id","supplier","sanctions","awards"]},"ComprasalSvSupplierResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ComprasalSvSupplierData"}}},"ComprasalSvAwardsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"supplier_id":{"anyOf":[{"type":"number"},{"type":"null"}]},"entity_id":{"anyOf":[{"type":"number"},{"type":"null"}]},"process_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The award's permanent id in COMPRASAL, e.g. `587047`."},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The amount awarded to the supplier, in US dollars."},"awarded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the award was made. Null when COMPRASAL has not dated it."},"process_id":{"type":"integer","description":"The procurement process the award belongs to."},"process_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The process code, e.g. \"1000009-2026-P0003\": the entity's code, the year and a sequence."},"process_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What was bought, as the entity named the process."},"contracting_method":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How it was contracted, e.g. \"Subasta Inversa\", \"Comparación de precios\", \"Licitación competitiva\"."},"contracting_method_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting method's code, e.g. \"SI\", \"CP\", \"LC\"."},"entity_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The contracting entity's id in COMPRASAL."},"entity_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting entity's code, e.g. \"4100\" for the Ministerio de Economía."},"entity_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting entity."},"supplier_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The supplier's id in COMPRASAL's supplier register, the same `id` the suppliers search returns."},"supplier_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The supplier's registered name."},"supplier_trade_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The supplier's trade name."},"official_url":{"type":"string","description":"The award on COMPRASAL."}},"required":["id","amount","awarded_date","process_id","process_code","process_name","contracting_method","contracting_method_code","entity_id","entity_code","entity_name","supplier_id","supplier_name","supplier_trade_name","official_url"]}}},"required":["as_of","query","supplier_id","entity_id","process_code","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"ComprasalSvAwardsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ComprasalSvAwardsSearchData"}}},"ComprasalSvAwardData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when COMPRASAL has no award under that id."},"award_id":{"type":"number"},"checked_at":{"type":"string","description":"When COMPRASAL was last asked for this award."},"served_from":{"type":"string","enum":["copy","upstream","stale"],"description":"`copy`: answered from Croma's stored answer; `upstream`: COMPRASAL was read for this call; `stale`: COMPRASAL could not be read and the stored answer stood in."},"award":{"anyOf":[{"type":"object","properties":{"award_id":{"type":"string","description":"The award's id in COMPRASAL."},"contract_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contract's name."},"contracting_method":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How it was contracted, e.g. \"Subasta Inversa\"."},"term_days":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The contract term, in days."},"planned_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The amount the entity planned, in US dollars."},"certified_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The amount certified for the contract, in US dollars."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the process was published, ISO timestamp."},"opened_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When offers opened, ISO timestamp."},"closed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When offers closed, ISO timestamp."},"process_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The process's stage, e.g. \"Contratación\"."},"signed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the contract was signed, ISO timestamp."},"budget_codes":{"type":"array","items":{"type":"string"},"description":"The budget codes (cifrados presupuestarios) that fund it."},"bidders":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The bidder's trade name."},"submitted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the offer was loaded, ISO timestamp."}},"required":["name","submitted_at"]},"description":"Every supplier that bid."},"modifications":{"type":"number","description":"Contract modifications COMPRASAL records."},"payments":{"type":"number","description":"Payments COMPRASAL records."},"official_url":{"type":"string","description":"The award on COMPRASAL."},"checked_at":{"type":"string"}},"required":["award_id","contract_name","contracting_method","term_days","planned_amount","certified_amount","published_at","opened_at","closed_at","process_status","signed_at","budget_codes","bidders","modifications","payments","official_url","checked_at"]},{"type":"null"}]}},"required":["found","award_id","checked_at","served_from","award"]},"ComprasalSvAwardResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ComprasalSvAwardData"}}},"ComprasalSvTendersSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"activity_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"open_only":{"type":"boolean"},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The process's permanent id in COMPRASAL, e.g. `141137`."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The process code, e.g. \"8651-2026-P0075\"."},"name":{"type":"string","description":"What the entity is buying."},"entity_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting entity."},"contracting_method":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How it will be contracted, e.g. \"Subasta Inversa\"."},"contracting_method_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting method's code, e.g. \"SI\"."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The process's status, e.g. \"Activo\"."},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the process is, e.g. \"En ejecución\"."},"current_stages":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."}},"required":["name","starts_at","ends_at"]},"description":"The stages under way now."},"stages":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."}},"required":["name","starts_at","ends_at"]},"description":"Every stage of the process's calendar, in order."},"offers_due_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When offers close: the end of the offer reception stage, ISO timestamp. Null when the calendar has none."},"activities":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The economic activity code, e.g. \"46592\"."},"name":{"type":"string"}},"required":["code","name"]},"description":"The economic activities the process is open to."},"activity_codes":{"type":"array","items":{"type":"string"},"description":"The codes of `activities`, which is what the `activity_code` filter matches."}},"required":["id","code","name","entity_name","contracting_method","contracting_method_code","status","stage","current_stages","stages","offers_due_at","activities","activity_codes"]}}},"required":["as_of","query","activity_code","open_only","total","total_is_exact","page","per_page","total_pages","count","results"]},"ComprasalSvTendersSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ComprasalSvTendersSearchData"}}},"ComprasalSvTendersForSupplierData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the open tenders are."},"found":{"type":"boolean","description":"False when the supplier id is not in the register."},"supplier_id":{"type":"number"},"supplier_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"awards_considered":{"type":"number","description":"Past awards of the supplier the match is built from."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The process's permanent id in COMPRASAL, e.g. `141137`."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The process code, e.g. \"8651-2026-P0075\"."},"name":{"type":"string","description":"What the entity is buying."},"entity_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting entity."},"contracting_method":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How it will be contracted, e.g. \"Subasta Inversa\"."},"contracting_method_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The contracting method's code, e.g. \"SI\"."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The process's status, e.g. \"Activo\"."},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the process is, e.g. \"En ejecución\"."},"current_stages":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."}},"required":["name","starts_at","ends_at"]},"description":"The stages under way now."},"stages":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."}},"required":["name","starts_at","ends_at"]},"description":"Every stage of the process's calendar, in order."},"offers_due_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When offers close: the end of the offer reception stage, ISO timestamp. Null when the calendar has none."},"activities":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The economic activity code, e.g. \"46592\"."},"name":{"type":"string"}},"required":["code","name"]},"description":"The economic activities the process is open to."},"activity_codes":{"type":"array","items":{"type":"string"},"description":"The codes of `activities`, which is what the `activity_code` filter matches."},"score":{"type":"number","description":"How strongly the tender matches what the supplier has sold before, higher is closer."},"matched_terms":{"type":"array","items":{"type":"string"},"description":"The words the tender shares with the supplier's past awards, strongest first."},"similar_award_ids":{"type":"array","items":{"type":"string"},"description":"Past awards of the supplier that read most like the tender."}},"required":["id","code","name","entity_name","contracting_method","contracting_method_code","status","stage","current_stages","stages","offers_due_at","activities","activity_codes","score","matched_terms","similar_award_ids"]},"description":"Open tenders whose offers are still due, best match first."}},"required":["as_of","found","supplier_id","supplier_name","awards_considered","count","results"]},"ComprasalSvTendersForSupplierResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ComprasalSvTendersForSupplierData"}}},"HaciendaSvDteData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when Hacienda has no document under that code."},"generation_code":{"type":"string","description":"The code that was looked up, normalized to upper case."},"environment":{"type":"string","enum":["production","test"]},"status":{"anyOf":[{"type":"string","enum":["received","received_with_notes","adjusted","rejected","invalidated","unknown"]},{"type":"null"}],"description":"`received` (transmitted and accepted), `received_with_notes`, `adjusted`, `rejected`, `invalidated`, or `unknown` for a status Croma does not map yet. Null when not found."},"status_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hacienda's own status code, e.g. \"SR\"."},"status_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hacienda's status as it words it, e.g. \"Transmitido Satisfactoriamente\"."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hacienda's description of the status."},"invalidated":{"type":"boolean","description":"Whether the issuer has invalidated the document."},"document":{"anyOf":[{"type":"object","properties":{"generation_code":{"type":"string","description":"The document's código de generación."},"control_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The número de control, e.g. \"DTE-03-S008P001-000000000014012\"."},"type_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The DTE type: \"01\" factura, \"03\" comprobante de crédito fiscal, \"05\" nota de crédito, \"14\" factura de sujeto excluido, and so on."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The DTE type as Hacienda names it, e.g. \"COMPROBANTE DE CREDITO FISCAL\"."},"version":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The schema version the document follows."},"issued_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the document was issued."},"issued_time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`hh:mm:ss` it was issued."},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When Hacienda processed it, as Hacienda reports it."},"reception_seal":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sello de recepción Hacienda gave the document."},"currency":{"type":"string","const":"USD"},"subtotal":{"anyOf":[{"type":"number"},{"type":"null"}]},"taxed_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"exempt_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_subject_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"taxes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The tax code, e.g. \"20\" for IVA."},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"In US dollars."}},"required":["code","description","amount"]}},"income_tax_withheld":{"anyOf":[{"type":"number"},{"type":"null"}]},"vat_withheld":{"anyOf":[{"type":"number"},{"type":"null"}]},"vat_perceived":{"anyOf":[{"type":"number"},{"type":"null"}]},"operation_total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The operation's total."},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The total to pay."},"total_in_words":{"anyOf":[{"type":"string"},{"type":"null"}]},"payment_condition":{"anyOf":[{"type":"string","enum":["cash","credit","other"]},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The line's position on the document."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The issuer's product or service code."},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"unit_price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"In US dollars."},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"taxed_sale":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Sale subject to IVA, in US dollars."},"exempt_sale":{"anyOf":[{"type":"number"},{"type":"null"}]},"non_subject_sale":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["number","code","description","quantity","unit_price","discount","taxed_sale","exempt_sale","non_subject_sale"]},"description":"Every line of the document."}},"required":["generation_code","control_number","type_code","type","version","issued_date","issued_time","processed_at","reception_seal","currency","subtotal","taxed_total","exempt_total","non_subject_total","discount_total","taxes","income_tax_withheld","vat_withheld","vat_perceived","operation_total","total","total_in_words","payment_condition","items"]},{"type":"null"}]},"checked_at":{"type":"string","description":"When Hacienda was asked."}},"required":["found","generation_code","environment","status","status_code","status_label","description","invalidated","document","checked_at"]},"HaciendaSvDteResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/HaciendaSvDteData"}}},"CnrSvFilingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"filing_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The filing's permanent id: the book and entry it was inscribed under for a registration or a corporate act (e.g. \"matricula-517-361-1\", \"sociedades-4959-965\"), the deposit number for a balance sheet (e.g. \"balance-288451\")."},"filing_type":{"type":"string","enum":["matricula_registration","matricula_transfer","matricula_cancellation","opening_balance","balance","liquidation_balance","incorporation","amendment","liquidation","dissolution","transformation","merger"],"description":"`matricula_registration`, `matricula_transfer`, `matricula_cancellation`, `opening_balance`, `balance`, `liquidation_balance`, `incorporation`, `amendment`, `liquidation`, `dissolution`, `transformation` or `merger`."},"service":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The service the Registro de Comercio lists the filing under, as published, e.g. \"CONSTITUCION de la Sociedad\"."},"company_name":{"type":"string","description":"The company's legal name as the bulletin lists it."},"company_abbreviation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The abbreviation the company may use, e.g. \"ZONTE, S.A. DE C.V.\"."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's registration file number (N° de expediente), e.g. \"2026136080\". Null for filings the bulletin lists without one."},"registered_on":{"type":"string","description":"`yyyy-mm-dd` the Registro de Comercio inscribed the filing, or received the balance sheet."},"bulletin_period":{"type":"string","description":"The bimonthly bulletin that published it, as `yyyy-n` (n from 1, January-February, to 6, November-December), e.g. \"2026-4\"."},"entry_book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The book the filing was inscribed in."},"entry_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entry number inside that book."},"incorporation_book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a registration: the book of the Registro de Sociedades the company's articles are inscribed in."},"incorporation_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a registration: the entry number of the company's articles in that book."},"trade_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a registration: the name the business trades under."},"nationality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's nationality, as published, e.g. \"SALVADOREÑA\"."},"domicile":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's domicile, as published, e.g. \"SAN SALVADOR CENTRO\"."},"department":{"anyOf":[{"type":"string","enum":["Ahuachapán","Cabañas","Chalatenango","Cuscatlán","La Libertad","La Paz","La Unión","Morazán","San Miguel","San Salvador","San Vicente","Santa Ana","Sonsonate","Usulután"]},{"type":"null"}],"description":"The department of El Salvador the company is domiciled in, or its registered business is."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality of the registered business."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address of the registered business, as published."},"activities":{"type":"array","items":{"type":"string"},"description":"For a registration: the economic activities the business declared."},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a corporate act: the company's purpose, as published."},"term":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a corporate act: the company's term, e.g. \"INDETERMINADO\"."},"capital":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"For a corporate act: the company's capital in US dollars."},"declared_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"For a registration: the business's declared assets in US dollars."},"balance_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a balance sheet: `yyyy-mm-dd` the balance was drawn up at."},"balance_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a balance sheet: its kind as published, e.g. \"GENERAL\", \"INICIAL\"."},"balance_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"For a balance sheet: the amount it was deposited with, in US dollars."},"deposit_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a balance sheet: the deposit number the Registro de Comercio gave it."},"presentation_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a balance sheet: the presentation entry it came in under."},"document_url":{"type":"string","description":"Croma's copy of the filing's extract, the PDF the bulletin publishes, byte for byte."},"source_document_url":{"type":"string","description":"The Registro de Comercio's bulletin, where the extract is published."}},"required":["id","filing_type","service","company_name","company_abbreviation","file_number","registered_on","bulletin_period","entry_book","entry_number","incorporation_book","incorporation_number","trade_name","nationality","domicile","department","municipality","address","activities","purpose","term","capital","declared_assets","balance_date","balance_kind","balance_amount","deposit_number","presentation_number","document_url","source_document_url"]}}},"required":["as_of","query","filing_type","department","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"CnrSvFilingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CnrSvFilingsSearchData"}}},"CnrSvCompanyData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"file_number":{"type":"string"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's legal name, from its newest filing."},"company_abbreviation":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancelled":{"type":"boolean","description":"Whether the bulletin has published the cancellation of the company's registration."},"count":{"type":"number"},"filings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The filing's permanent id: the book and entry it was inscribed under for a registration or a corporate act (e.g. \"matricula-517-361-1\", \"sociedades-4959-965\"), the deposit number for a balance sheet (e.g. \"balance-288451\")."},"filing_type":{"type":"string","enum":["matricula_registration","matricula_transfer","matricula_cancellation","opening_balance","balance","liquidation_balance","incorporation","amendment","liquidation","dissolution","transformation","merger"],"description":"`matricula_registration`, `matricula_transfer`, `matricula_cancellation`, `opening_balance`, `balance`, `liquidation_balance`, `incorporation`, `amendment`, `liquidation`, `dissolution`, `transformation` or `merger`."},"service":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The service the Registro de Comercio lists the filing under, as published, e.g. \"CONSTITUCION de la Sociedad\"."},"company_name":{"type":"string","description":"The company's legal name as the bulletin lists it."},"company_abbreviation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The abbreviation the company may use, e.g. \"ZONTE, S.A. DE C.V.\"."},"file_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's registration file number (N° de expediente), e.g. \"2026136080\". Null for filings the bulletin lists without one."},"registered_on":{"type":"string","description":"`yyyy-mm-dd` the Registro de Comercio inscribed the filing, or received the balance sheet."},"bulletin_period":{"type":"string","description":"The bimonthly bulletin that published it, as `yyyy-n` (n from 1, January-February, to 6, November-December), e.g. \"2026-4\"."},"entry_book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The book the filing was inscribed in."},"entry_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The entry number inside that book."},"incorporation_book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a registration: the book of the Registro de Sociedades the company's articles are inscribed in."},"incorporation_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a registration: the entry number of the company's articles in that book."},"trade_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a registration: the name the business trades under."},"nationality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's nationality, as published, e.g. \"SALVADOREÑA\"."},"domicile":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's domicile, as published, e.g. \"SAN SALVADOR CENTRO\"."},"department":{"anyOf":[{"type":"string","enum":["Ahuachapán","Cabañas","Chalatenango","Cuscatlán","La Libertad","La Paz","La Unión","Morazán","San Miguel","San Salvador","San Vicente","Santa Ana","Sonsonate","Usulután"]},{"type":"null"}],"description":"The department of El Salvador the company is domiciled in, or its registered business is."},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality of the registered business."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address of the registered business, as published."},"activities":{"type":"array","items":{"type":"string"},"description":"For a registration: the economic activities the business declared."},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a corporate act: the company's purpose, as published."},"term":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a corporate act: the company's term, e.g. \"INDETERMINADO\"."},"capital":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"For a corporate act: the company's capital in US dollars."},"declared_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"For a registration: the business's declared assets in US dollars."},"balance_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a balance sheet: `yyyy-mm-dd` the balance was drawn up at."},"balance_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a balance sheet: its kind as published, e.g. \"GENERAL\", \"INICIAL\"."},"balance_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"For a balance sheet: the amount it was deposited with, in US dollars."},"deposit_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a balance sheet: the deposit number the Registro de Comercio gave it."},"presentation_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a balance sheet: the presentation entry it came in under."},"document_url":{"type":"string","description":"Croma's copy of the filing's extract, the PDF the bulletin publishes, byte for byte."},"source_document_url":{"type":"string","description":"The Registro de Comercio's bulletin, where the extract is published."}},"required":["id","filing_type","service","company_name","company_abbreviation","file_number","registered_on","bulletin_period","entry_book","entry_number","incorporation_book","incorporation_number","trade_name","nationality","domicile","department","municipality","address","activities","purpose","term","capital","declared_assets","balance_date","balance_kind","balance_amount","deposit_number","presentation_number","document_url","source_document_url"]},"description":"Every filing of the company the copy holds, newest first: those under its file number, and the balance sheets and corporate acts published under its legal name."}},"required":["as_of","found","file_number","company_name","company_abbreviation","cancelled","count","filings"]},"CnrSvCompanyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CnrSvCompanyData"}}},"TcpBoRulingsSearchData":{"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"}]},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}]},"proceeding_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"reporting_judge":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The resolution's permanent number at the Tribunal Constitucional Plurinacional, e.g. \"202697\". Votes share the number of the ruling they accompany, so the resolution number is not unique."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The resolution number as the court prints it, e.g. \"0049/2024-S2\", \"0092/2024-CA\", \"0741/2003-R\". Null for a vote the court left unnumbered."},"type":{"anyOf":[{"type":"string","enum":["sentencia","auto","declaracion","voto_disidente","voto_aclaratorio","decreto"]},{"type":"null"}],"description":"The kind of resolution: `sentencia` (SC, SCP), `auto` (AC, ACP, autos of the Comisión de Admisión), `declaracion` (DCP), `voto_disidente`, `voto_aclaratorio` or `decreto`. Null when the court does not say."},"type_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of resolution as the court records it, e.g. \"SENTENCIA\", \"AUTO CONST. P.\", \"VOTO DISIDENTE\"."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the court handed the resolution down, Bolivian time."},"year":{"type":"number","description":"The year of the resolution."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber that decided, as the resolution names it, e.g. \"SALA SEGUNDA\", \"SALA PLENA\", \"COMISIÓN DE ADMISIÓN\", \"SALA LIQUIDADORA TRANSITORIA\"."},"proceeding_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The constitutional action or proceeding, e.g. \"Acción de Amparo Constitucional\", \"Acción de Libertad\", \"Acción de Inconstitucionalidad Concreta\", \"Recurso de Habeas Corpus\"."},"reporting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reporting justice (magistrado relator) as the resolution names them; for a vote, the justice or justices who signed it."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department the case came from, e.g. \"La Paz\", \"Santa Cruz\", \"Cochabamba\"."},"case_numbers":{"type":"array","items":{"type":"string"},"description":"The case files (expedientes) the resolution decides, as the court numbers them, e.g. [\"52034-2022-105-AL\"]. Joined cases list several."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the court published the resolution's document with no text alongside it; `missing` when it published neither."},"official_url":{"type":"string","description":"The resolution's page at the Tribunal Constitucional Plurinacional."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the resolution's original document (PDF), byte for byte as the court published it. It stays available whatever happens to the court's own site. Null when the court publishes no document for the resolution."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's own link at the court. Always null: the court serves its documents from the resolution's page, with no link of their own."}},"required":["id","registration_number","type","type_label","ruling_date","year","chamber","proceeding_type","reporting_judge","department","case_numbers","text_status","official_url","document_url","source_document_url"]}}},"required":["as_of","query","type","chamber","proceeding_type","registration_number","case_number","reporting_judge","department","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"TcpBoRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TcpBoRulingsSearchData"}}},"TcpBoRulingData":{"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 resolution's permanent number at the Tribunal Constitucional Plurinacional, e.g. \"202697\". Votes share the number of the ruling they accompany, so the resolution number is not unique."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The resolution number as the court prints it, e.g. \"0049/2024-S2\", \"0092/2024-CA\", \"0741/2003-R\". Null for a vote the court left unnumbered."},"type":{"anyOf":[{"type":"string","enum":["sentencia","auto","declaracion","voto_disidente","voto_aclaratorio","decreto"]},{"type":"null"}],"description":"The kind of resolution: `sentencia` (SC, SCP), `auto` (AC, ACP, autos of the Comisión de Admisión), `declaracion` (DCP), `voto_disidente`, `voto_aclaratorio` or `decreto`. Null when the court does not say."},"type_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of resolution as the court records it, e.g. \"SENTENCIA\", \"AUTO CONST. P.\", \"VOTO DISIDENTE\"."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the court handed the resolution down, Bolivian time."},"year":{"type":"number","description":"The year of the resolution."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber that decided, as the resolution names it, e.g. \"SALA SEGUNDA\", \"SALA PLENA\", \"COMISIÓN DE ADMISIÓN\", \"SALA LIQUIDADORA TRANSITORIA\"."},"proceeding_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The constitutional action or proceeding, e.g. \"Acción de Amparo Constitucional\", \"Acción de Libertad\", \"Acción de Inconstitucionalidad Concreta\", \"Recurso de Habeas Corpus\"."},"reporting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reporting justice (magistrado relator) as the resolution names them; for a vote, the justice or justices who signed it."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department the case came from, e.g. \"La Paz\", \"Santa Cruz\", \"Cochabamba\"."},"case_numbers":{"type":"array","items":{"type":"string"},"description":"The case files (expedientes) the resolution decides, as the court numbers them, e.g. [\"52034-2022-105-AL\"]. Joined cases list several."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the court published the resolution's document with no text alongside it; `missing` when it published neither."},"official_url":{"type":"string","description":"The resolution's page at the Tribunal Constitucional Plurinacional."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the resolution's original document (PDF), byte for byte as the court published it. It stays available whatever happens to the court's own site. Null when the court publishes no document for the resolution."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's own link at the court. Always null: the court serves its documents from the resolution's page, with no link of their own."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the resolution'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 resolution's text, or null when `text_status` is not `ok`."}},"required":["id","registration_number","type","type_label","ruling_date","year","chamber","proceeding_type","reporting_judge","department","case_numbers","text_status","official_url","document_url","source_document_url","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"TcpBoRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TcpBoRulingData"}}},"TsjBoRulingsSearchData":{"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"}]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"reporting_judge":{"anyOf":[{"type":"string"},{"type":"null"}]},"department":{"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The resolution's permanent number in the Tribunal Supremo de Justicia's jurisprudence system, e.g. \"11378\". Each chamber numbers its own resolutions, so the resolution number is not unique."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The resolution number as the court prints it, e.g. \"AS/0001/2010\", \"SE/0001/2023\", \"AS/1922/2023-RA\". Null when the court's record carries none."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number (expediente) as the court prints it, e.g. \"P-07-09-A\"."},"ruling_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the court handed the resolution down."},"year":{"type":"number","description":"The year of the resolution."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber that decided, as the court names it, e.g. \"Sala Civil\", \"Sala Penal 1\", \"Sala Plena\", \"Sala Social Liquidadora\"."},"type":{"anyOf":[{"type":"string","enum":["auto_supremo","sentencia","resolucion"]},{"type":"null"}],"description":"The kind of resolution: `auto_supremo`, `sentencia` or `resolucion`."},"type_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of resolution as the court names it, e.g. \"Auto Supremo\"."},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subtype the court records, e.g. \"Auto Supremo de Fondo\", \"Auto Supremo de Admisión\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the court resolved (forma de resolución), e.g. \"Infundado\", \"Casa\", \"Rechaza\", \"Improcedente\"."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The area of law (materia), e.g. \"Civil\", \"Penal\", \"Familia\", \"Social\", \"Agrario\"."},"proceeding":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The proceeding the case was, as the court records it, e.g. \"Resolución de Contrato\". Often empty."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department the case came from, e.g. \"La Paz\", \"Santa Cruz\", \"Potosi\"."},"reporting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reporting justice (magistrado relator)."},"jurisprudence":{"type":"array","items":{"type":"object","properties":{"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of line the note records, as the court labels it, e.g. \"Fundadora\", \"Modificadora\", \"Reiterativa\"."},"descriptor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the note sits in the court's topic tree, e.g. \"Derecho Civil / Derecho Procesal Civil / Recursos\"."},"restrictor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The narrowing of the topic the note decides."},"ratio_decidendi":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reasoning the decision rests on, in the court's words."},"maxim":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rule the note draws from the resolution (máxima)."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court's summary of the resolution (síntesis)."},"precedent":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The precedent the note states or follows."}},"required":["kind","descriptor","restrictor","ratio_decidendi","maxim","summary","precedent"]},"description":"The court's jurisprudence notes on the resolution: each a topic with its restrictor, ratio decidendi, maxim, summary and precedent. Empty when the court wrote none."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The topics of the notes, in order, each once."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the court published the resolution only as a scan with no text in it; `missing` when it published no readable text."},"document_kind":{"type":"string","enum":["scan","rendering","none"],"description":"`scan` when the document is the court's scan of the signed resolution, `rendering` when it is the court's PDF of the text, `none` when there is no document."},"official_url":{"type":"string","description":"The resolution's page on the court's jurisprudence site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the resolution's document (PDF), byte for byte as the court served it: the scan of the signed resolution when the court published one, otherwise the court's PDF of the text. It stays available whatever happens to the court's own link. Null when the court publishes no document for the resolution."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the court publishes the document: the scan's own link, or the resolution's page on the court's site for the court's PDF of the text. Null when the court publishes none."}},"required":["id","registration_number","case_number","ruling_date","year","chamber","type","type_label","subtype","outcome","subject","proceeding","department","reporting_judge","jurisprudence","descriptors","text_status","document_kind","official_url","document_url","source_document_url"]}}},"required":["as_of","query","chamber","type","subject","outcome","registration_number","case_number","reporting_judge","department","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"TsjBoRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TsjBoRulingsSearchData"}}},"TsjBoRulingData":{"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 resolution's permanent number in the Tribunal Supremo de Justicia's jurisprudence system, e.g. \"11378\". Each chamber numbers its own resolutions, so the resolution number is not unique."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The resolution number as the court prints it, e.g. \"AS/0001/2010\", \"SE/0001/2023\", \"AS/1922/2023-RA\". Null when the court's record carries none."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case file number (expediente) as the court prints it, e.g. \"P-07-09-A\"."},"ruling_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the court handed the resolution down."},"year":{"type":"number","description":"The year of the resolution."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber that decided, as the court names it, e.g. \"Sala Civil\", \"Sala Penal 1\", \"Sala Plena\", \"Sala Social Liquidadora\"."},"type":{"anyOf":[{"type":"string","enum":["auto_supremo","sentencia","resolucion"]},{"type":"null"}],"description":"The kind of resolution: `auto_supremo`, `sentencia` or `resolucion`."},"type_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of resolution as the court names it, e.g. \"Auto Supremo\"."},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subtype the court records, e.g. \"Auto Supremo de Fondo\", \"Auto Supremo de Admisión\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the court resolved (forma de resolución), e.g. \"Infundado\", \"Casa\", \"Rechaza\", \"Improcedente\"."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The area of law (materia), e.g. \"Civil\", \"Penal\", \"Familia\", \"Social\", \"Agrario\"."},"proceeding":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The proceeding the case was, as the court records it, e.g. \"Resolución de Contrato\". Often empty."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The department the case came from, e.g. \"La Paz\", \"Santa Cruz\", \"Potosi\"."},"reporting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reporting justice (magistrado relator)."},"jurisprudence":{"type":"array","items":{"type":"object","properties":{"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of line the note records, as the court labels it, e.g. \"Fundadora\", \"Modificadora\", \"Reiterativa\"."},"descriptor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the note sits in the court's topic tree, e.g. \"Derecho Civil / Derecho Procesal Civil / Recursos\"."},"restrictor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The narrowing of the topic the note decides."},"ratio_decidendi":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reasoning the decision rests on, in the court's words."},"maxim":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rule the note draws from the resolution (máxima)."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court's summary of the resolution (síntesis)."},"precedent":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The precedent the note states or follows."}},"required":["kind","descriptor","restrictor","ratio_decidendi","maxim","summary","precedent"]},"description":"The court's jurisprudence notes on the resolution: each a topic with its restrictor, ratio decidendi, maxim, summary and precedent. Empty when the court wrote none."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The topics of the notes, in order, each once."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the court published the resolution only as a scan with no text in it; `missing` when it published no readable text."},"document_kind":{"type":"string","enum":["scan","rendering","none"],"description":"`scan` when the document is the court's scan of the signed resolution, `rendering` when it is the court's PDF of the text, `none` when there is no document."},"official_url":{"type":"string","description":"The resolution's page on the court's jurisprudence site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the resolution's document (PDF), byte for byte as the court served it: the scan of the signed resolution when the court published one, otherwise the court's PDF of the text. It stays available whatever happens to the court's own link. Null when the court publishes no document for the resolution."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the court publishes the document: the scan's own link, or the resolution's page on the court's site for the court's PDF of the text. Null when the court publishes none."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the resolution'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 resolution's text, or null when `text_status` is not `ok`."}},"required":["id","registration_number","case_number","ruling_date","year","chamber","type","type_label","subtype","outcome","subject","proceeding","department","reporting_judge","jurisprudence","descriptors","text_status","document_kind","official_url","document_url","source_document_url","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"TsjBoRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TsjBoRulingData"}}},"NtaCompaniesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"prefecture":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"change_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"corporate_number":{"type":"string","description":"The 13-digit corporate number (法人番号) the National Tax Agency assigned, e.g. \"1180301018771\". The first digit checks the other twelve."},"name":{"type":"string","description":"The company's name (商号又は名称) as registered, e.g. \"トヨタ自動車株式会社\". Cut at 150 characters by the register; `name_image_url` then carries the whole of it."},"name_kana":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reading of the name in katakana (フリガナ), when the register records one."},"name_en":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name in English, when the company registered one."},"entity_type":{"type":"string","enum":["national_government","local_government","kabushiki_kaisha","yugen_kaisha","gomei_kaisha","goshi_kaisha","godo_kaisha","other_registered","foreign_company","other"],"description":"The legal form: `kabushiki_kaisha` (株式会社), `yugen_kaisha` (有限会社), `gomei_kaisha` (合名会社), `goshi_kaisha` (合資会社), `godo_kaisha` (合同会社), `other_registered` (any other registered entity: 一般社団法人, 医療法人, 学校法人, 宗教法人...), `foreign_company` (外国会社), `national_government`, `local_government` or `other`."},"entity_type_label":{"type":"string","description":"The legal form as the register labels it, e.g. \"株式会社\", \"その他の設立登記法人\"."},"prefecture":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The prefecture of the head office (国内所在地), e.g. \"愛知県\", \"東京都\". Null for a company whose only address is abroad."},"prefecture_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The prefecture's two-digit JIS X 0401 code, e.g. \"23\" for 愛知県, \"13\" for 東京都."},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The city, ward, town or village of the head office, e.g. \"豊田市\", \"千代田区\"."},"city_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`city` folded for matching (compatibility forms normalized, lowercased), which is what the `city` filter matches from the start."},"city_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality's five-digit JIS X 0402 code, e.g. \"23211\"."},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rest of the head office address (丁目番地等), e.g. \"トヨタ町1番地\". Cut at 300 characters by the register; `address_image_url` then carries the whole address."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The seven-digit postal code the register derives from the address. Derived, so it can be wrong or missing."},"prefecture_en":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The prefecture in English, when the company registered its address in English."},"city_en":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The city and the rest of the address in English, when the company registered them."},"address_outside_japan":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address abroad (国外所在地) for a foreign company, as registered."},"address_outside_japan_en":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address abroad in English, when registered."},"status":{"type":"string","enum":["active","closed","deleted"],"description":"`active` while the register record is open, `closed` once it was closed (see `close_reason`), `deleted` when the register removed the number."},"closed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the register record was closed. Null while active."},"close_reason":{"anyOf":[{"type":"string","enum":["liquidation","merger","registrar","other_liquidation"]},{"type":"null"}],"description":"Why the record was closed: `liquidation` (清算の結了等), `merger` (合併による解散等), `registrar` (登記官による閉鎖) or `other_liquidation` (その他の清算の結了等). Null while active."},"successor_corporate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The corporate number of the company this one was merged into, when it closed by merger."},"assigned_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the corporate number was assigned. `2015-10-05` for every company that existed when the system started."},"updated_at":{"type":"string","description":"`yyyy-mm-dd` the register last changed the record; what `from_date` and `to_date` filter on."},"changed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the event behind the last change (the registration date of the change), when the register states it."},"change_type":{"type":"string","enum":["new","name_change","address_change","foreign_address_change","closed","revived","merger","merger_annulled","trade_name_erased","deleted"],"description":"The last change the register recorded: `new`, `name_change`, `address_change`, `foreign_address_change`, `closed`, `revived`, `merger`, `merger_annulled`, `trade_name_erased` or `deleted`."},"change_details":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own note on the last change (変更事由の詳細), when it wrote one."},"hidden":{"type":"boolean","description":"True for a company the register keeps out of its own name search; it is then found only by its corporate number here as well."},"name_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the image the register publishes for a name it cannot print in full (characters outside JIS, or more than 150 characters), byte for byte. Null for almost every company."},"source_name_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own link to that image."},"address_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the image the register publishes for an address it cannot print in full. Null for almost every company."},"source_address_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own link to that image."},"foreign_address_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the image the register publishes for an address abroad it cannot print in full."},"source_foreign_address_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own link to that image."},"official_url":{"type":"string","description":"The company's page at the National Tax Agency's corporate number site."}},"required":["corporate_number","name","name_kana","name_en","entity_type","entity_type_label","prefecture","prefecture_code","city","city_key","city_code","street","postal_code","prefecture_en","city_en","address_outside_japan","address_outside_japan_en","status","closed_at","close_reason","successor_corporate_number","assigned_at","updated_at","changed_at","change_type","change_details","hidden","name_image_url","source_name_image_url","address_image_url","source_address_image_url","foreign_address_image_url","source_foreign_address_image_url","official_url"]}}},"required":["as_of","query","prefecture","city","entity_type","status","change_type","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"NtaCompaniesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/NtaCompaniesSearchData"}}},"NtaCompanyData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"corporate_number":{"type":"string"},"company":{"anyOf":[{"type":"object","properties":{"corporate_number":{"type":"string","description":"The 13-digit corporate number (法人番号) the National Tax Agency assigned, e.g. \"1180301018771\". The first digit checks the other twelve."},"name":{"type":"string","description":"The company's name (商号又は名称) as registered, e.g. \"トヨタ自動車株式会社\". Cut at 150 characters by the register; `name_image_url` then carries the whole of it."},"name_kana":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reading of the name in katakana (フリガナ), when the register records one."},"name_en":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name in English, when the company registered one."},"entity_type":{"type":"string","enum":["national_government","local_government","kabushiki_kaisha","yugen_kaisha","gomei_kaisha","goshi_kaisha","godo_kaisha","other_registered","foreign_company","other"],"description":"The legal form: `kabushiki_kaisha` (株式会社), `yugen_kaisha` (有限会社), `gomei_kaisha` (合名会社), `goshi_kaisha` (合資会社), `godo_kaisha` (合同会社), `other_registered` (any other registered entity: 一般社団法人, 医療法人, 学校法人, 宗教法人...), `foreign_company` (外国会社), `national_government`, `local_government` or `other`."},"entity_type_label":{"type":"string","description":"The legal form as the register labels it, e.g. \"株式会社\", \"その他の設立登記法人\"."},"prefecture":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The prefecture of the head office (国内所在地), e.g. \"愛知県\", \"東京都\". Null for a company whose only address is abroad."},"prefecture_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The prefecture's two-digit JIS X 0401 code, e.g. \"23\" for 愛知県, \"13\" for 東京都."},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The city, ward, town or village of the head office, e.g. \"豊田市\", \"千代田区\"."},"city_key":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`city` folded for matching (compatibility forms normalized, lowercased), which is what the `city` filter matches from the start."},"city_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The municipality's five-digit JIS X 0402 code, e.g. \"23211\"."},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rest of the head office address (丁目番地等), e.g. \"トヨタ町1番地\". Cut at 300 characters by the register; `address_image_url` then carries the whole address."},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The seven-digit postal code the register derives from the address. Derived, so it can be wrong or missing."},"prefecture_en":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The prefecture in English, when the company registered its address in English."},"city_en":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The city and the rest of the address in English, when the company registered them."},"address_outside_japan":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address abroad (国外所在地) for a foreign company, as registered."},"address_outside_japan_en":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address abroad in English, when registered."},"status":{"type":"string","enum":["active","closed","deleted"],"description":"`active` while the register record is open, `closed` once it was closed (see `close_reason`), `deleted` when the register removed the number."},"closed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the register record was closed. Null while active."},"close_reason":{"anyOf":[{"type":"string","enum":["liquidation","merger","registrar","other_liquidation"]},{"type":"null"}],"description":"Why the record was closed: `liquidation` (清算の結了等), `merger` (合併による解散等), `registrar` (登記官による閉鎖) or `other_liquidation` (その他の清算の結了等). Null while active."},"successor_corporate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The corporate number of the company this one was merged into, when it closed by merger."},"assigned_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the corporate number was assigned. `2015-10-05` for every company that existed when the system started."},"updated_at":{"type":"string","description":"`yyyy-mm-dd` the register last changed the record; what `from_date` and `to_date` filter on."},"changed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the event behind the last change (the registration date of the change), when the register states it."},"change_type":{"type":"string","enum":["new","name_change","address_change","foreign_address_change","closed","revived","merger","merger_annulled","trade_name_erased","deleted"],"description":"The last change the register recorded: `new`, `name_change`, `address_change`, `foreign_address_change`, `closed`, `revived`, `merger`, `merger_annulled`, `trade_name_erased` or `deleted`."},"change_details":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own note on the last change (変更事由の詳細), when it wrote one."},"hidden":{"type":"boolean","description":"True for a company the register keeps out of its own name search; it is then found only by its corporate number here as well."},"name_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the image the register publishes for a name it cannot print in full (characters outside JIS, or more than 150 characters), byte for byte. Null for almost every company."},"source_name_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own link to that image."},"address_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the image the register publishes for an address it cannot print in full. Null for almost every company."},"source_address_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own link to that image."},"foreign_address_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the image the register publishes for an address abroad it cannot print in full."},"source_foreign_address_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The register's own link to that image."},"official_url":{"type":"string","description":"The company's page at the National Tax Agency's corporate number site."}},"required":["corporate_number","name","name_kana","name_en","entity_type","entity_type_label","prefecture","prefecture_code","city","city_key","city_code","street","postal_code","prefecture_en","city_en","address_outside_japan","address_outside_japan_en","status","closed_at","close_reason","successor_corporate_number","assigned_at","updated_at","changed_at","change_type","change_details","hidden","name_image_url","source_name_image_url","address_image_url","source_address_image_url","foreign_address_image_url","source_foreign_address_image_url","official_url"]},{"type":"null"}]}},"required":["as_of","found","corporate_number","company"]},"NtaCompanyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/NtaCompanyData"}}},"CourtsJpRulingsSearchData":{"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"}]},"court":{"anyOf":[{"type":"string"},{"type":"null"}]},"case_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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's permanent number at the courts' site, e.g. \"93117\". Unique across every collection."},"collections":{"type":"array","items":{"type":"string"},"description":"The collections the courts publish the ruling in: `supreme` (最高裁判所判例集), `high` (高等裁判所判例集), `lower` (下級裁判所裁判例速報), `administrative` (行政事件裁判例集), `labor` (労働事件裁判例集), `ip` (知的財産裁判例集), `ip_high` (知的財産高等裁判所). One ruling can sit in several."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number as the court prints it, e.g. \"平成21(オ)257\", \"令和7(あ)868\"."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Gregorian year the case was filed, from its number."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case name (事件名), e.g. \"損害賠償請求事件\". Null when the court published none."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"ruling_date_japanese":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The same date in the Japanese calendar, e.g. \"平成22年6月17日\"."},"year":{"type":"number","description":"The year of the ruling."},"court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court, and for the Supreme Court its bench, e.g. \"最高裁判所第一小法廷\", \"東京高等裁判所\", \"大阪地方裁判所\"."},"branch":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The branch of the court (支部), when the ruling names one."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The division of the court (部), when the ruling names one."},"judgment_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision, e.g. \"判決\" (judgment), \"決定\" (decision)."},"result":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The outcome as the court records it, e.g. \"棄却\", \"破棄差戻\", \"却下\", \"その他\"."},"reporter":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The official reports citation (判例集等巻・号・頁), when the ruling is reported."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court whose decision was appealed (原審), when there is one."},"lower_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number at the lower court."},"lower_ruling_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the lower court's decision."},"lower_result":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The lower court's outcome, when the courts state it."},"holding":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court's statement of what was decided (判示事項), when published."},"gist":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court's summary of the reasoning (裁判要旨 or 要旨), when published."},"statutes":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provisions the ruling turns on (参照法条), as the court lists them."},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The field the courts file an administrative or labour case under (分野), when stated."},"right_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an intellectual property case, the right at issue (権利種別), e.g. \"特許権\", \"著作権\", \"商標権\"."},"suit_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an intellectual property case, the kind of suit (訴訟類型), e.g. \"民事訴訟\", \"審決取消\"."},"ip_case_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, the kind of case (事件種別)."},"invention":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, the title of the invention, mark or work (発明等の名称等)."},"issues":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, the main issues (主な争点)."},"appeal":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, whether a further appeal was lodged (上告提起等の有無)."},"appeal_result":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, the result of that appeal (上告審の結果)."},"ip_result":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, the outcome as that court records it (判決結果)."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the court's document carries no text layer; `missing` when the court published no document."},"official_url":{"type":"string","description":"The ruling's page at the courts' site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the court's document (PDF), byte for byte as published. It stays available whatever happens to the court's own site. Null when the court published none."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's own link at the courts' site."}},"required":["id","collections","case_number","case_year","title","ruling_date","ruling_date_japanese","year","court","branch","department","judgment_type","result","reporter","lower_court","lower_case_number","lower_ruling_date","lower_result","holding","gist","statutes","field","right_type","suit_type","ip_case_kind","invention","issues","appeal","appeal_result","ip_result","text_status","official_url","document_url","source_document_url"]}}},"required":["as_of","query","collection","court","case_number","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"CourtsJpRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourtsJpRulingsSearchData"}}},"CourtsJpRulingData":{"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 permanent number at the courts' site, e.g. \"93117\". Unique across every collection."},"collections":{"type":"array","items":{"type":"string"},"description":"The collections the courts publish the ruling in: `supreme` (最高裁判所判例集), `high` (高等裁判所判例集), `lower` (下級裁判所裁判例速報), `administrative` (行政事件裁判例集), `labor` (労働事件裁判例集), `ip` (知的財産裁判例集), `ip_high` (知的財産高等裁判所). One ruling can sit in several."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number as the court prints it, e.g. \"平成21(オ)257\", \"令和7(あ)868\"."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Gregorian year the case was filed, from its number."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case name (事件名), e.g. \"損害賠償請求事件\". Null when the court published none."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"ruling_date_japanese":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The same date in the Japanese calendar, e.g. \"平成22年6月17日\"."},"year":{"type":"number","description":"The year of the ruling."},"court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court, and for the Supreme Court its bench, e.g. \"最高裁判所第一小法廷\", \"東京高等裁判所\", \"大阪地方裁判所\"."},"branch":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The branch of the court (支部), when the ruling names one."},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The division of the court (部), when the ruling names one."},"judgment_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision, e.g. \"判決\" (judgment), \"決定\" (decision)."},"result":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The outcome as the court records it, e.g. \"棄却\", \"破棄差戻\", \"却下\", \"その他\"."},"reporter":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The official reports citation (判例集等巻・号・頁), when the ruling is reported."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court whose decision was appealed (原審), when there is one."},"lower_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number at the lower court."},"lower_ruling_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the lower court's decision."},"lower_result":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The lower court's outcome, when the courts state it."},"holding":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court's statement of what was decided (判示事項), when published."},"gist":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court's summary of the reasoning (裁判要旨 or 要旨), when published."},"statutes":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provisions the ruling turns on (参照法条), as the court lists them."},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The field the courts file an administrative or labour case under (分野), when stated."},"right_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an intellectual property case, the right at issue (権利種別), e.g. \"特許権\", \"著作権\", \"商標権\"."},"suit_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an intellectual property case, the kind of suit (訴訟類型), e.g. \"民事訴訟\", \"審決取消\"."},"ip_case_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, the kind of case (事件種別)."},"invention":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, the title of the invention, mark or work (発明等の名称等)."},"issues":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, the main issues (主な争点)."},"appeal":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, whether a further appeal was lodged (上告提起等の有無)."},"appeal_result":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, the result of that appeal (上告審の結果)."},"ip_result":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For an IP High Court case, the outcome as that court records it (判決結果)."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the court's document carries no text layer; `missing` when the court published no document."},"official_url":{"type":"string","description":"The ruling's page at the courts' site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the court's document (PDF), byte for byte as published. It stays available whatever happens to the court's own site. Null when the court published none."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document's own link at the courts' site."},"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 `text_status` is not `ok`."}},"required":["id","collections","case_number","case_year","title","ruling_date","ruling_date_japanese","year","court","branch","department","judgment_type","result","reporter","lower_court","lower_case_number","lower_ruling_date","lower_result","holding","gist","statutes","field","right_type","suit_type","ip_case_kind","invention","issues","appeal","appeal_result","ip_result","text_status","official_url","document_url","source_document_url","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"CourtsJpRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CourtsJpRulingData"}}},"SiiOficiosSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"subject":{"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The oficio's permanent id in Croma's copy, e.g. `3109` (2019 on) or `renta-2015-ja3298` (earlier years)."},"subject":{"type":"string","enum":["renta","iva","otras"],"description":"The tax the oficio answers about: `renta` (income tax), `iva` (VAT) or `otras` (every other norm)."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The oficio's number, e.g. `2815`. Numbers restart every year."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of oficio as SII names it: \"Oficio Ordinario\", \"Oficio\" or \"Ordinario\"."},"year":{"type":"number","description":"The year SII files the oficio under."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the oficio was issued."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` SII published it (2019 on; null before)."},"legal_references":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norms the oficio interprets, as SII heads it, e.g. \"Renta – Ley sobre Impuesto a la – Art. 31 inciso cuarto N° 4\"."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SII's summary of the question the oficio answers."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when SII publishes no readable document."},"official_url":{"type":"string","description":"The year's listing of oficios on SII's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the oficio's main document (its PDF, or its HTML page in earlier years), byte for byte as SII published it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The oficio's main document on SII's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as SII published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `htm`, `doc`, `zip`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as SII published it. Null when SII no longer serves it."},"source_document_url":{"type":"string","description":"The file on SII's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file SII publishes with the oficio (the text and its Word copy in earlier years)."}},"required":["id","subject","number","document_type","year","issued_at","published_at","legal_references","summary","text_status","official_url","document_url","source_document_url","documents"]}}},"required":["as_of","query","subject","number","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"SiiOficiosSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiiOficiosSearchData"}}},"SiiOficioData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"oficio_id":{"type":"string"},"oficio":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The oficio's permanent id in Croma's copy, e.g. `3109` (2019 on) or `renta-2015-ja3298` (earlier years)."},"subject":{"type":"string","enum":["renta","iva","otras"],"description":"The tax the oficio answers about: `renta` (income tax), `iva` (VAT) or `otras` (every other norm)."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The oficio's number, e.g. `2815`. Numbers restart every year."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of oficio as SII names it: \"Oficio Ordinario\", \"Oficio\" or \"Ordinario\"."},"year":{"type":"number","description":"The year SII files the oficio under."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the oficio was issued."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` SII published it (2019 on; null before)."},"legal_references":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norms the oficio interprets, as SII heads it, e.g. \"Renta – Ley sobre Impuesto a la – Art. 31 inciso cuarto N° 4\"."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SII's summary of the question the oficio answers."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when SII publishes no readable document."},"official_url":{"type":"string","description":"The year's listing of oficios on SII's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the oficio's main document (its PDF, or its HTML page in earlier years), byte for byte as SII published it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The oficio's main document on SII's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as SII published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `htm`, `doc`, `zip`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as SII published it. Null when SII no longer serves it."},"source_document_url":{"type":"string","description":"The file on SII's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file SII publishes with the oficio (the text and its Word copy in earlier years)."},"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 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 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 oficio's text, or null when `text_status` is not `ok`."}},"required":["id","subject","number","document_type","year","issued_at","published_at","legal_references","summary","text_status","official_url","document_url","source_document_url","documents","content"]},{"type":"null"}]}},"required":["as_of","found","oficio_id","oficio"]},"SiiOficioResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiiOficioData"}}},"SiiCircularsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The act's year and number, e.g. `2026-41`."},"number":{"type":"string","description":"The act's number, e.g. `41`. Numbers restart every year."},"year":{"type":"number","description":"The year SII files the act under."},"title":{"type":"string","description":"The act as SII titles it, e.g. \"Circular N° 41 del 15 de Octubre del 2026\"."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was issued."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SII's summary of what the act does."},"issuing_office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office SII names as the act's source (\"Fuente\"), e.g. \"Subdirección Normativa\"."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The note SII prints beside the act, e.g. \"modificada\" or \"dejada sin efecto\". Null when it prints none."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when SII publishes no readable document."},"official_url":{"type":"string","description":"The year's listing on SII's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the act's main document, byte for byte as SII published it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's main document on SII's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as SII published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `htm`, `doc`, `zip`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as SII published it. Null when SII no longer serves it."},"source_document_url":{"type":"string","description":"The file on SII's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file SII publishes with the act: its text, the Word copy, annexes."}},"required":["id","number","year","title","issued_at","summary","issuing_office","status","text_status","official_url","document_url","source_document_url","documents"]}}},"required":["as_of","query","number","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"SiiCircularsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiiCircularsSearchData"}}},"SiiCircularData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"circular_id":{"type":"string"},"circular":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The act's year and number, e.g. `2026-41`."},"number":{"type":"string","description":"The act's number, e.g. `41`. Numbers restart every year."},"year":{"type":"number","description":"The year SII files the act under."},"title":{"type":"string","description":"The act as SII titles it, e.g. \"Circular N° 41 del 15 de Octubre del 2026\"."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was issued."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SII's summary of what the act does."},"issuing_office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office SII names as the act's source (\"Fuente\"), e.g. \"Subdirección Normativa\"."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The note SII prints beside the act, e.g. \"modificada\" or \"dejada sin efecto\". Null when it prints none."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when SII publishes no readable document."},"official_url":{"type":"string","description":"The year's listing on SII's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the act's main document, byte for byte as SII published it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's main document on SII's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as SII published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `htm`, `doc`, `zip`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as SII published it. Null when SII no longer serves it."},"source_document_url":{"type":"string","description":"The file on SII's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file SII publishes with the act: its text, the Word copy, annexes."},"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 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 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 act's text, or null when `text_status` is not `ok`."}},"required":["id","number","year","title","issued_at","summary","issuing_office","status","text_status","official_url","document_url","source_document_url","documents","content"]},{"type":"null"}]}},"required":["as_of","found","circular_id","circular"]},"SiiCircularResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiiCircularData"}}},"SiiResolutionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The act's year and number, e.g. `2026-41`."},"number":{"type":"string","description":"The act's number, e.g. `41`. Numbers restart every year."},"year":{"type":"number","description":"The year SII files the act under."},"title":{"type":"string","description":"The act as SII titles it, e.g. \"Circular N° 41 del 15 de Octubre del 2026\"."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was issued."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SII's summary of what the act does."},"issuing_office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office SII names as the act's source (\"Fuente\"), e.g. \"Subdirección Normativa\"."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The note SII prints beside the act, e.g. \"modificada\" or \"dejada sin efecto\". Null when it prints none."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when SII publishes no readable document."},"official_url":{"type":"string","description":"The year's listing on SII's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the act's main document, byte for byte as SII published it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's main document on SII's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as SII published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `htm`, `doc`, `zip`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as SII published it. Null when SII no longer serves it."},"source_document_url":{"type":"string","description":"The file on SII's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file SII publishes with the act: its text, the Word copy, annexes."}},"required":["id","number","year","title","issued_at","summary","issuing_office","status","text_status","official_url","document_url","source_document_url","documents"]}}},"required":["as_of","query","number","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"SiiResolutionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiiResolutionsSearchData"}}},"SiiResolutionData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"resolution_id":{"type":"string"},"resolution":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The act's year and number, e.g. `2026-41`."},"number":{"type":"string","description":"The act's number, e.g. `41`. Numbers restart every year."},"year":{"type":"number","description":"The year SII files the act under."},"title":{"type":"string","description":"The act as SII titles it, e.g. \"Circular N° 41 del 15 de Octubre del 2026\"."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the act was issued."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SII's summary of what the act does."},"issuing_office":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office SII names as the act's source (\"Fuente\"), e.g. \"Subdirección Normativa\"."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The note SII prints beside the act, e.g. \"modificada\" or \"dejada sin efecto\". Null when it prints none."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when SII publishes no readable document."},"official_url":{"type":"string","description":"The year's listing on SII's site."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the act's main document, byte for byte as SII published it."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The act's main document on SII's own site."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name as SII published it."},"format":{"type":"string","description":"The file's format from its name: `pdf`, `htm`, `doc`, `zip`, ..."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the file, byte for byte as SII published it. Null when SII no longer serves it."},"source_document_url":{"type":"string","description":"The file on SII's own site."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the file in bytes, when the copy was made."}},"required":["name","format","document_url","source_document_url","bytes"]},"description":"Every file SII publishes with the act: its text, the Word copy, annexes."},"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 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 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 act's text, or null when `text_status` is not `ok`."}},"required":["id","number","year","title","issued_at","summary","issuing_office","status","text_status","official_url","document_url","source_document_url","documents","content"]},{"type":"null"}]}},"required":["as_of","found","resolution_id","resolution"]},"SiiResolutionResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiiResolutionData"}}},"SiiRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"court":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's permanent id in SII's compilation, e.g. `3638`."},"code_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ROL` or `RIT`: which kind of case number `registration_number` is."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol or RIT) as the court gives it, e.g. `5501-12`."},"case_ruc":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's RUC (rol único de causa) when the court gives one, e.g. `17-9-0000009-K`."},"ruling_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the ruling."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of the ruling."},"court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court that ruled, e.g. \"Corte Suprema\", \"Corte de Apelaciones de Santiago\"."},"court_group":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court: \"Corte Suprema\", \"Corte de Apelaciones\", \"Tribunal Tributario y Aduanero\", \"Tribunal Constitucional\" and others."},"ruling_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision, e.g. \"Sentencia\"."},"parties":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The parties as SII's compilation names them, e.g. \"Sociedad X con SII\". Null when it names none."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SII's headnote: the topics and norms of the ruling."},"extract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SII's extract of the ruling's reasoning."},"norms":{"type":"array","items":{"type":"object","properties":{"norm_body":{"type":"string","description":"The body of law, e.g. \"Código Tributario\"."},"articles":{"type":"array","items":{"type":"string"},"description":"The articles of it the ruling applies."}},"required":["norm_body","articles"]},"description":"The norms and articles SII indexes the ruling under."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when SII publishes no readable document."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the ruling's text as SII's compilation publishes it (HTML), byte for byte."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ruling's document on SII's own site, when the compilation links one."}},"required":["id","code_type","registration_number","case_ruc","ruling_date","year","court","court_group","ruling_type","parties","summary","extract","norms","text_status","document_url","source_document_url"]}}},"required":["as_of","query","court","registration_number","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"SiiRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiiRulingsSearchData"}}},"SiiRulingData":{"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 permanent id in SII's compilation, e.g. `3638`."},"code_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ROL` or `RIT`: which kind of case number `registration_number` is."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol or RIT) as the court gives it, e.g. `5501-12`."},"case_ruc":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's RUC (rol único de causa) when the court gives one, e.g. `17-9-0000009-K`."},"ruling_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the ruling."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of the ruling."},"court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court that ruled, e.g. \"Corte Suprema\", \"Corte de Apelaciones de Santiago\"."},"court_group":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court: \"Corte Suprema\", \"Corte de Apelaciones\", \"Tribunal Tributario y Aduanero\", \"Tribunal Constitucional\" and others."},"ruling_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision, e.g. \"Sentencia\"."},"parties":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The parties as SII's compilation names them, e.g. \"Sociedad X con SII\". Null when it names none."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SII's headnote: the topics and norms of the ruling."},"extract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SII's extract of the ruling's reasoning."},"norms":{"type":"array","items":{"type":"object","properties":{"norm_body":{"type":"string","description":"The body of law, e.g. \"Código Tributario\"."},"articles":{"type":"array","items":{"type":"string"},"description":"The articles of it the ruling applies."}},"required":["norm_body","articles"]},"description":"The norms and articles SII indexes the ruling under."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the full text is here; `scanned` when the document is an image with no text in it; `missing` when SII publishes no readable document."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the ruling's text as SII's compilation publishes it (HTML), byte for byte."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ruling's document on SII's own site, when the compilation links one."},"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 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 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 `text_status` is not `ok`."}},"required":["id","code_type","registration_number","case_ruc","ruling_date","year","court","court_group","ruling_type","parties","summary","extract","norms","text_status","document_url","source_document_url","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"SiiRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiiRulingData"}}},"SiiMapasPropertyData":{"type":"object","properties":{"found":{"type":"boolean","description":"False when SII's map holds no property under that rol."},"rol":{"type":"string","description":"The rol asked for, as `<comuna code>-<manzana>-<predio>`."},"checked_at":{"type":"string","description":"When SII was last asked for this property."},"served_from":{"type":"string","enum":["copy","upstream","stale"],"description":"`copy`: answered from Croma's stored answer; `upstream`: SII was read for this call; `stale`: SII could not be read and the stored answer stood in."},"property":{"anyOf":[{"type":"object","properties":{"rol":{"type":"string","description":"The property's rol with its comuna: SII comuna code, manzana and predio, e.g. `13101-18-1`."},"comuna_code":{"type":"string","description":"SII's code of the comuna, e.g. `13101` (not INE's code)."},"comuna":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The comuna as SII names it, e.g. \"SANTIAGO\"."},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The region the comuna belongs to, as SII names it."},"block":{"type":"number","description":"The manzana: the rol's first number."},"lot":{"type":"number","description":"The predio: the rol's second number."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The property's address as SII records it."},"zone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`URBANA` or `RURAL`, as SII records it."},"land_use":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The destino SII assigns the property, e.g. \"HABITACIONAL\", \"COMERCIO\", \"OFICINA\", \"EDUCACION Y CULTURA\"."},"appraisal_total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The avalúo fiscal (total), in Chilean pesos."},"appraisal_taxable":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The part of the avalúo subject to the property tax (avalúo afecto), in Chilean pesos."},"appraisal_exempt":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The part of the avalúo exempt from the property tax (avalúo exento), in Chilean pesos."},"land_area":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The land surface in `land_area_unit`. Null when SII records none."},"land_area_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unit of `land_area`, e.g. \"m²\" or hectares for rural land."},"built_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The built surface in square metres."},"built_volume_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The built volume in cubic metres, for constructions SII measures by volume."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude of the property's point on SII's map (WGS84)."},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude of the property's point on SII's map (WGS84)."},"valuation_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The half-year the avalúo is for, e.g. \"SEGUNDO SEMESTRE DE 2026\"."},"valuation_process":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The general reappraisal the land values come from, e.g. \"RAV NO AGRICOLA 2022\"."},"valuation_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of that reappraisal."},"homogeneous_area":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","description":"SII's code for the homogeneous area the land is valued in, e.g. \"CMA019\"."},"area_range":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The range of lot sizes the area's unit value applies to, as SII prints it, e.g. \"290 - 1.970\"."},"unit_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The area's land value per unit of surface, in Chilean pesos."},"median":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The median of the area's sample values, when SII reports one."},"samples":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"How many samples the area's statistics come from."},"coefficient_of_variation":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The coefficient of variation of the samples."}},"required":["code","area_range","unit_value","median","samples","coefficient_of_variation"]},{"type":"null"}],"description":"The homogeneous area the land is valued in, with its unit value and sample statistics. Null when SII reports none."},"checked_at":{"type":"string"}},"required":["rol","comuna_code","comuna","region","block","lot","address","zone","land_use","appraisal_total","appraisal_taxable","appraisal_exempt","land_area","land_area_unit","built_area_m2","built_volume_m3","latitude","longitude","valuation_period","valuation_process","valuation_year","homogeneous_area","checked_at"]},{"type":"null"}]}},"required":["found","rol","checked_at","served_from","property"]},"SiiMapasPropertyResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SiiMapasPropertyData"}}},"ContraloriaClDictamenesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"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"}]},"criterion":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"references":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The dictamen's permanent id at the Contraloría, e.g. \"D428N26\", \"E152884N21\", \"009740N19\": its number, `N`, and the last two digits of its year."},"number":{"type":"string","description":"The dictamen's number as the Contraloría cites it, with its letter prefix and without leading zeros, e.g. \"9740\", \"E152884\", \"OF197180\", \"D428\". Numbers restart every year, so a dictamen is `number` and `year` together."},"year":{"type":"number","description":"The year of the dictamen."},"issued_date":{"type":"string","description":"`yyyy-mm-dd` the dictamen was issued."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The summary of what the dictamen decides (materia), as the Contraloría writes it."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Contraloría's subject descriptors, e.g. \"pensiones CAPREDENA\", \"requisitos\"."},"legal_sources":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provisions the dictamen rests on (fuentes legales), as listed, e.g. \"Ley 18458 art/1, ley 18458 art/3\"."},"criterion":{"anyOf":[{"type":"string","enum":["generates","applies"]},{"type":"null"}],"description":"`generates` when the dictamen sets new jurisprudence (Genera Jurisprudencia), `applies` when it applies existing jurisprudence (Aplica Jurisprudencia). Null when the Contraloría states neither."},"statuses":{"type":"array","items":{"type":"string"},"description":"Every status flag the dictamen carries today, e.g. `[\"reconsidered\"]`; the same as the true values of `status_flags`. Later dictámenes change these."},"status_flags":{"type":"object","properties":{"new":{"type":"boolean","description":"Marked new (nuevo)."},"applied":{"type":"boolean","description":"Applied by a later dictamen (aplicado)."},"reconsidered":{"type":"boolean","description":"Reconsidered by a later dictamen (reconsiderado): its criterion no longer stands."},"partially_reconsidered":{"type":"boolean","description":"Partly reconsidered by a later dictamen (reconsiderado parcialmente)."},"clarified":{"type":"boolean","description":"Clarified by a later dictamen (aclarado)."},"altered":{"type":"boolean","description":"Altered by a later dictamen (alterado)."},"confirmed":{"type":"boolean","description":"Confirmed by a later dictamen (confirmado)."},"complemented":{"type":"boolean","description":"Complemented by a later dictamen (complementado)."},"reactivated":{"type":"boolean","description":"Reactivated by a later dictamen (reactivado)."}},"required":["new","applied","reconsidered","partially_reconsidered","clarified","altered","confirmed","complemented","reactivated"],"description":"Each status flag of the dictamen as a boolean."},"related":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","description":"What this dictamen does to the other one, as the Contraloría words it, e.g. \"Aplica\", \"Reconsidera\", \"Complementa\", \"Aclara\"."},"dictamen_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The other dictamen's `id`, when the Contraloría links it. Pass it to the dictamen endpoint."},"number":{"type":"string","description":"The other dictamen's number, e.g. \"9740\" or \"E152884\"."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The other dictamen's year."}},"required":["action","dictamen_id","number","year"]},"description":"The earlier dictámenes this one acts on (applies, reconsiders, complements, clarifies...), as the Contraloría lists them."},"action_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Contraloría's own sentence on what this dictamen does to earlier ones, e.g. \"Aplica dictámenes 9740/2019; Reconsidera dictámenes 22127/2009\"."},"recipients":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who the dictamen is addressed to (destinatarios)."},"attorneys":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The initials of the Contraloría's attorneys who drafted it (abogados)."},"origin":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Contraloría's unit the dictamen comes from (origen), e.g. \"DFP\", \"DJU\", \"CGR\"."},"origins":{"type":"array","items":{"type":"string"},"description":"Every unit the dictamen comes from, when it names more than one."},"character":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Contraloría's character code for the dictamen (carácter), e.g. \"NNN\", as published."},"protection_appeal":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The protection appeal (recurso de protección) the dictamen relates to, when stated."},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The topic (tema), when the Contraloría assigns one."},"relevant":{"type":"boolean","description":"Whether the Contraloría marks the dictamen as relevant (relevante)."},"bulletin":{"type":"boolean","description":"Whether the dictamen is published in the Contraloría's bulletin (boletín)."},"official_url":{"type":"string","description":"The dictamen's page at the Contraloría."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of an original document. Always null for this source: the Contraloría publishes each dictamen as text, kept whole in `text`; `source_document_url` gives its PDF."},"source_document_url":{"type":"string","description":"The PDF the Contraloría renders for the dictamen."}},"required":["id","number","year","issued_date","subject","descriptors","legal_sources","criterion","statuses","status_flags","related","action_text","recipients","attorneys","origin","origins","character","protection_appeal","topic","relevant","bulletin","official_url","document_url","source_document_url"]}}},"required":["as_of","query","number","year","from_date","to_date","criterion","status","references","total","total_is_exact","page","per_page","total_pages","count","results"]},"ContraloriaClDictamenesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ContraloriaClDictamenesSearchData"}}},"ContraloriaClDictamenData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"dictamen_id":{"type":"string"},"dictamen":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The dictamen's permanent id at the Contraloría, e.g. \"D428N26\", \"E152884N21\", \"009740N19\": its number, `N`, and the last two digits of its year."},"number":{"type":"string","description":"The dictamen's number as the Contraloría cites it, with its letter prefix and without leading zeros, e.g. \"9740\", \"E152884\", \"OF197180\", \"D428\". Numbers restart every year, so a dictamen is `number` and `year` together."},"year":{"type":"number","description":"The year of the dictamen."},"issued_date":{"type":"string","description":"`yyyy-mm-dd` the dictamen was issued."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The summary of what the dictamen decides (materia), as the Contraloría writes it."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Contraloría's subject descriptors, e.g. \"pensiones CAPREDENA\", \"requisitos\"."},"legal_sources":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provisions the dictamen rests on (fuentes legales), as listed, e.g. \"Ley 18458 art/1, ley 18458 art/3\"."},"criterion":{"anyOf":[{"type":"string","enum":["generates","applies"]},{"type":"null"}],"description":"`generates` when the dictamen sets new jurisprudence (Genera Jurisprudencia), `applies` when it applies existing jurisprudence (Aplica Jurisprudencia). Null when the Contraloría states neither."},"statuses":{"type":"array","items":{"type":"string"},"description":"Every status flag the dictamen carries today, e.g. `[\"reconsidered\"]`; the same as the true values of `status_flags`. Later dictámenes change these."},"status_flags":{"type":"object","properties":{"new":{"type":"boolean","description":"Marked new (nuevo)."},"applied":{"type":"boolean","description":"Applied by a later dictamen (aplicado)."},"reconsidered":{"type":"boolean","description":"Reconsidered by a later dictamen (reconsiderado): its criterion no longer stands."},"partially_reconsidered":{"type":"boolean","description":"Partly reconsidered by a later dictamen (reconsiderado parcialmente)."},"clarified":{"type":"boolean","description":"Clarified by a later dictamen (aclarado)."},"altered":{"type":"boolean","description":"Altered by a later dictamen (alterado)."},"confirmed":{"type":"boolean","description":"Confirmed by a later dictamen (confirmado)."},"complemented":{"type":"boolean","description":"Complemented by a later dictamen (complementado)."},"reactivated":{"type":"boolean","description":"Reactivated by a later dictamen (reactivado)."}},"required":["new","applied","reconsidered","partially_reconsidered","clarified","altered","confirmed","complemented","reactivated"],"description":"Each status flag of the dictamen as a boolean."},"related":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","description":"What this dictamen does to the other one, as the Contraloría words it, e.g. \"Aplica\", \"Reconsidera\", \"Complementa\", \"Aclara\"."},"dictamen_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The other dictamen's `id`, when the Contraloría links it. Pass it to the dictamen endpoint."},"number":{"type":"string","description":"The other dictamen's number, e.g. \"9740\" or \"E152884\"."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The other dictamen's year."}},"required":["action","dictamen_id","number","year"]},"description":"The earlier dictámenes this one acts on (applies, reconsiders, complements, clarifies...), as the Contraloría lists them."},"action_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Contraloría's own sentence on what this dictamen does to earlier ones, e.g. \"Aplica dictámenes 9740/2019; Reconsidera dictámenes 22127/2009\"."},"recipients":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who the dictamen is addressed to (destinatarios)."},"attorneys":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The initials of the Contraloría's attorneys who drafted it (abogados)."},"origin":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Contraloría's unit the dictamen comes from (origen), e.g. \"DFP\", \"DJU\", \"CGR\"."},"origins":{"type":"array","items":{"type":"string"},"description":"Every unit the dictamen comes from, when it names more than one."},"character":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Contraloría's character code for the dictamen (carácter), e.g. \"NNN\", as published."},"protection_appeal":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The protection appeal (recurso de protección) the dictamen relates to, when stated."},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The topic (tema), when the Contraloría assigns one."},"relevant":{"type":"boolean","description":"Whether the Contraloría marks the dictamen as relevant (relevante)."},"bulletin":{"type":"boolean","description":"Whether the dictamen is published in the Contraloría's bulletin (boletín)."},"official_url":{"type":"string","description":"The dictamen's page at the Contraloría."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of an original document. Always null for this source: the Contraloría publishes each dictamen as text, kept whole in `text`; `source_document_url` gives its PDF."},"source_document_url":{"type":"string","description":"The PDF the Contraloría renders for the dictamen."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the dictamen'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 dictamen's text, or null when it has none."},"referenced_by":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The later dictamen's `id`."},"number":{"type":"string"},"year":{"type":"number"},"issued_date":{"type":"string"},"actions":{"type":"array","items":{"type":"string"},"description":"What it does to this dictamen, e.g. [\"Reconsidera\"]."}},"required":["id","number","year","issued_date","actions"]},"description":"The later dictámenes that act on this one (apply, reconsider, clarify...), newest first, up to 100."}},"required":["id","number","year","issued_date","subject","descriptors","legal_sources","criterion","statuses","status_flags","related","action_text","recipients","attorneys","origin","origins","character","protection_appeal","topic","relevant","bulletin","official_url","document_url","source_document_url","content","referenced_by"]},{"type":"null"}]}},"required":["as_of","found","dictamen_id","dictamen"]},"ContraloriaClDictamenResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ContraloriaClDictamenData"}}},"CmfRegulationsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"collection":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"related_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The norm's permanent id: `<type>-<number>-<year>` for the CMF (e.g. `ncg-577-2026`, `ofc-1368-1993`), `sbif-<number>` for the SBIF archive (e.g. `sbif-17825`)."},"collection":{"type":"string","enum":["cmf","sbif"],"description":"`cmf` for the CMF's general regulation (and the SVS's before 2018), `sbif` for the banking regulation of the former Superintendencia de Bancos e Instituciones Financieras, up to 2019."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of norm: `NCG` (Norma de Carácter General), `CIR` (Circular) or `OFC` (Oficio Circular) for the CMF; as the archive names it for the SBIF (`Circular`, `Carta Circular`...)."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm's number, e.g. `577`. Numbers repeat across kinds and years."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm as the SBIF archive names it, e.g. \"Circular N° 3.644 Bancos\". Null for the CMF."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the norm was issued."},"year":{"type":"number","description":"The year the norm was issued."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm's title or reference as the CMF publishes it; for the SBIF archive, its description."},"section":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For the SBIF archive, the group of entities the norm is addressed to, e.g. \"Bancos\", \"Auditores Externos\"."},"markets":{"type":"array","items":{"type":"string"},"description":"The markets the norm applies to: `banking`, `securities`, `insurance`, `other`."},"in_force":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"False when the CMF marks the norm as no longer in force, true when it marks it in force, null when it does not say."},"validity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The validity note as the CMF writes it, e.g. \"No Vigente\"."},"resolution":{"anyOf":[{"type":"object","properties":{"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the resolution that issued the norm."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of that resolution."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the resolution says it does."}},"required":["number","date","reference"]},{"type":"null"}],"description":"The resolution that issued the norm, when the CMF lists one."},"amends":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's `id` in this dataset, e.g. `ncg-30-1989`. Null when the CMF does not say which kind of norm it is."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's kind: `NCG`, `CIR` or `OFC`."},"number":{"type":"string","description":"The related norm's number."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the related norm was issued."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's document at the CMF."}},"required":["id","type","number","date","source_document_url"]},"description":"The norms this one amends."},"amended_by":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's `id` in this dataset, e.g. `ncg-30-1989`. Null when the CMF does not say which kind of norm it is."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's kind: `NCG`, `CIR` or `OFC`."},"number":{"type":"string","description":"The related norm's number."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the related norm was issued."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's document at the CMF."}},"required":["id","type","number","date","source_document_url"]},"description":"The norms that amend this one, newest first as the CMF lists them."},"repeals":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's `id` in this dataset, e.g. `ncg-30-1989`. Null when the CMF does not say which kind of norm it is."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's kind: `NCG`, `CIR` or `OFC`."},"number":{"type":"string","description":"The related norm's number."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the related norm was issued."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's document at the CMF."}},"required":["id","type","number","date","source_document_url"]},"description":"The norms this one repeals."},"repealed_by":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's `id` in this dataset, e.g. `ncg-30-1989`. Null when the CMF does not say which kind of norm it is."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's kind: `NCG`, `CIR` or `OFC`."},"number":{"type":"string","description":"The related norm's number."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the related norm was issued."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's document at the CMF."}},"required":["id","type","number","date","source_document_url"]},"description":"The norms that repeal this one."},"attachments":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["consolidated_text","report","resolution","annex"],"description":"`consolidated_text` (texto refundido or replacement pages), `report` (informe normativo or a complementary document), `resolution` (the resolution that issued the norm) or `annex` (the attached sheets of an SBIF norm)."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The link's text as the CMF shows it, e.g. \"Informe Normativo\"."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original file, kept by Croma byte for byte as published. Null while it is still being retrieved."},"source_document_url":{"type":"string","description":"The file's own link at the CMF."}},"required":["kind","label","document_url","source_document_url"]},"description":"The other files the CMF publishes with the norm: consolidated text, regulatory report, resolution, annexes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm's original document (PDF), kept by Croma byte for byte as published. Null when the CMF publishes none, or while it is still being retrieved."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm's document at the CMF."}},"required":["id","collection","type","number","name","issued_at","year","title","section","markets","in_force","validity","resolution","amends","amended_by","repeals","repealed_by","attachments","document_url","source_document_url"]}}},"required":["as_of","query","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","collection","type","number","market","related_to","results"]},"CmfRegulationsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CmfRegulationsSearchData"}}},"CmfRegulationData":{"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":"The norm's permanent id: `<type>-<number>-<year>` for the CMF (e.g. `ncg-577-2026`, `ofc-1368-1993`), `sbif-<number>` for the SBIF archive (e.g. `sbif-17825`)."},"collection":{"type":"string","enum":["cmf","sbif"],"description":"`cmf` for the CMF's general regulation (and the SVS's before 2018), `sbif` for the banking regulation of the former Superintendencia de Bancos e Instituciones Financieras, up to 2019."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of norm: `NCG` (Norma de Carácter General), `CIR` (Circular) or `OFC` (Oficio Circular) for the CMF; as the archive names it for the SBIF (`Circular`, `Carta Circular`...)."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm's number, e.g. `577`. Numbers repeat across kinds and years."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm as the SBIF archive names it, e.g. \"Circular N° 3.644 Bancos\". Null for the CMF."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the norm was issued."},"year":{"type":"number","description":"The year the norm was issued."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm's title or reference as the CMF publishes it; for the SBIF archive, its description."},"section":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For the SBIF archive, the group of entities the norm is addressed to, e.g. \"Bancos\", \"Auditores Externos\"."},"markets":{"type":"array","items":{"type":"string"},"description":"The markets the norm applies to: `banking`, `securities`, `insurance`, `other`."},"in_force":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"False when the CMF marks the norm as no longer in force, true when it marks it in force, null when it does not say."},"validity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The validity note as the CMF writes it, e.g. \"No Vigente\"."},"resolution":{"anyOf":[{"type":"object","properties":{"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the resolution that issued the norm."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of that resolution."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the resolution says it does."}},"required":["number","date","reference"]},{"type":"null"}],"description":"The resolution that issued the norm, when the CMF lists one."},"amends":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's `id` in this dataset, e.g. `ncg-30-1989`. Null when the CMF does not say which kind of norm it is."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's kind: `NCG`, `CIR` or `OFC`."},"number":{"type":"string","description":"The related norm's number."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the related norm was issued."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's document at the CMF."}},"required":["id","type","number","date","source_document_url"]},"description":"The norms this one amends."},"amended_by":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's `id` in this dataset, e.g. `ncg-30-1989`. Null when the CMF does not say which kind of norm it is."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's kind: `NCG`, `CIR` or `OFC`."},"number":{"type":"string","description":"The related norm's number."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the related norm was issued."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's document at the CMF."}},"required":["id","type","number","date","source_document_url"]},"description":"The norms that amend this one, newest first as the CMF lists them."},"repeals":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's `id` in this dataset, e.g. `ncg-30-1989`. Null when the CMF does not say which kind of norm it is."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's kind: `NCG`, `CIR` or `OFC`."},"number":{"type":"string","description":"The related norm's number."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the related norm was issued."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's document at the CMF."}},"required":["id","type","number","date","source_document_url"]},"description":"The norms this one repeals."},"repealed_by":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's `id` in this dataset, e.g. `ncg-30-1989`. Null when the CMF does not say which kind of norm it is."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's kind: `NCG`, `CIR` or `OFC`."},"number":{"type":"string","description":"The related norm's number."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the related norm was issued."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The related norm's document at the CMF."}},"required":["id","type","number","date","source_document_url"]},"description":"The norms that repeal this one."},"attachments":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["consolidated_text","report","resolution","annex"],"description":"`consolidated_text` (texto refundido or replacement pages), `report` (informe normativo or a complementary document), `resolution` (the resolution that issued the norm) or `annex` (the attached sheets of an SBIF norm)."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The link's text as the CMF shows it, e.g. \"Informe Normativo\"."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original file, kept by Croma byte for byte as published. Null while it is still being retrieved."},"source_document_url":{"type":"string","description":"The file's own link at the CMF."}},"required":["kind","label","document_url","source_document_url"]},"description":"The other files the CMF publishes with the norm: consolidated text, regulatory report, resolution, annexes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm's original document (PDF), kept by Croma byte for byte as published. Null when the CMF publishes none, or while it is still being retrieved."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm's document at the CMF."}},"required":["id","collection","type","number","name","issued_at","year","title","section","markets","in_force","validity","resolution","amends","amended_by","repeals","repealed_by","attachments","document_url","source_document_url"]},{"type":"null"}]}},"required":["as_of","found","regulation_id","regulation"]},"CmfRegulationResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CmfRegulationData"}}},"CmfOpinionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"effects":{"anyOf":[{"type":"string"},{"type":"null"}]},"letter_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's document number at the CMF, e.g. `2025120910460`. Unique across every year."},"title":{"type":"string","description":"The act as the CMF identifies it, e.g. \"Oficio Ordinario N°248490 de 31/12/2025\"."},"letter_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the official letter (oficio ordinario) that carries the ruling, e.g. `248490`. Not unique."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the letter was issued."},"year":{"type":"number","description":"The year the letter was issued."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the CMF made the ruling public."},"medium":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the letter was sent, e.g. \"Correo Electrónico\", \"Correo Ordinario\"."},"publication_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where and how it was made public, e.g. \"Sitio Web\"."},"effects":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`particulares` when it answers one party's consultation, `generales` when it binds everyone; null when the CMF does not say."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date of the last update, when the CMF records one."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The CMF's summary of the question and the answer."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original letter (PDF), kept by Croma byte for byte as published. Null while it is still being retrieved."},"source_document_url":{"type":"string","description":"The letter's document at the CMF."}},"required":["id","title","letter_number","issued_at","year","published_at","medium","publication_format","effects","updated_at","summary","document_url","source_document_url"]}}},"required":["as_of","query","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","effects","letter_number","results"]},"CmfOpinionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CmfOpinionsSearchData"}}},"CmfOpinionData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"opinion_id":{"type":"string"},"opinion":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The ruling's document number at the CMF, e.g. `2025120910460`. Unique across every year."},"title":{"type":"string","description":"The act as the CMF identifies it, e.g. \"Oficio Ordinario N°248490 de 31/12/2025\"."},"letter_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of the official letter (oficio ordinario) that carries the ruling, e.g. `248490`. Not unique."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the letter was issued."},"year":{"type":"number","description":"The year the letter was issued."},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the CMF made the ruling public."},"medium":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the letter was sent, e.g. \"Correo Electrónico\", \"Correo Ordinario\"."},"publication_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where and how it was made public, e.g. \"Sitio Web\"."},"effects":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`particulares` when it answers one party's consultation, `generales` when it binds everyone; null when the CMF does not say."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date of the last update, when the CMF records one."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The CMF's summary of the question and the answer."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original letter (PDF), kept by Croma byte for byte as published. Null while it is still being retrieved."},"source_document_url":{"type":"string","description":"The letter's document at the CMF."}},"required":["id","title","letter_number","issued_at","year","published_at","medium","publication_format","effects","updated_at","summary","document_url","source_document_url"]},{"type":"null"}]}},"required":["as_of","found","opinion_id","opinion"]},"CmfOpinionResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CmfOpinionData"}}},"CmfSanctionsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}]},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The resolution's document number at the CMF, e.g. `2026090593551`. Unique across every year."},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The resolution's number, e.g. `11220`. Numbering restarts every year."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the resolution was issued."},"year":{"type":"number","description":"The year the resolution was issued."},"subject":{"type":"string","description":"What the resolution does, as the CMF writes it, e.g. \"APLICA SANCIÓN A ...\", naming the sanctioned party."},"kind":{"type":"string","enum":["sanction","appeal","other"],"description":"`sanction` when it imposes a sanction, `appeal` when it decides an appeal (recurso) against one, `other` otherwise."},"party":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party the resolution names, read from `subject` (\"APLICA SANCIÓN A <party>\"); null when `subject` does not follow that form."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original resolution (PDF), kept by Croma byte for byte as published. Null while it is still being retrieved."},"source_document_url":{"type":"string","description":"The resolution's document at the CMF."}},"required":["id","resolution_number","issued_at","year","subject","kind","party","document_url","source_document_url"]}}},"required":["as_of","query","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","kind","resolution_number","results"]},"CmfSanctionsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CmfSanctionsSearchData"}}},"CmfSanctionData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"sanction_id":{"type":"string"},"sanction":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The resolution's document number at the CMF, e.g. `2026090593551`. Unique across every year."},"resolution_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The resolution's number, e.g. `11220`. Numbering restarts every year."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the resolution was issued."},"year":{"type":"number","description":"The year the resolution was issued."},"subject":{"type":"string","description":"What the resolution does, as the CMF writes it, e.g. \"APLICA SANCIÓN A ...\", naming the sanctioned party."},"kind":{"type":"string","enum":["sanction","appeal","other"],"description":"`sanction` when it imposes a sanction, `appeal` when it decides an appeal (recurso) against one, `other` otherwise."},"party":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The party the resolution names, read from `subject` (\"APLICA SANCIÓN A <party>\"); null when `subject` does not follow that form."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original resolution (PDF), kept by Croma byte for byte as published. Null while it is still being retrieved."},"source_document_url":{"type":"string","description":"The resolution's document at the CMF."}},"required":["id","resolution_number","issued_at","year","subject","kind","party","document_url","source_document_url"]},{"type":"null"}]}},"required":["as_of","found","sanction_id","sanction"]},"CmfSanctionResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CmfSanctionData"}}},"PjudSupremeCourtRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"matter":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status"]}},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["as_of","query","case_number","year","matter","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results","chamber"]},"PjudSupremeCourtRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudSupremeCourtRulingsSearchData"}}},"PjudSupremeCourtRulingData":{"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 permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."},"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 it has none."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"PjudSupremeCourtRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudSupremeCourtRulingData"}}},"PjudAppealsCourtRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"matter":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status"]}},"court":{"anyOf":[{"type":"string"},{"type":"null"}]},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["as_of","query","case_number","year","matter","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results","court","chamber"]},"PjudAppealsCourtRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudAppealsCourtRulingsSearchData"}}},"PjudAppealsCourtRulingData":{"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 permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."},"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 it has none."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"PjudAppealsCourtRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudAppealsCourtRulingData"}}},"PjudCivilCourtRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"matter":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status"]}},"court":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["as_of","query","case_number","year","matter","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results","court"]},"PjudCivilCourtRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudCivilCourtRulingsSearchData"}}},"PjudCivilCourtRulingData":{"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 permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."},"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 it has none."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"PjudCivilCourtRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudCivilCourtRulingData"}}},"PjudCriminalCourtRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"matter":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status"]}},"court":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["as_of","query","case_number","year","matter","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results","court"]},"PjudCriminalCourtRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudCriminalCourtRulingsSearchData"}}},"PjudCriminalCourtRulingData":{"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 permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."},"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 it has none."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"PjudCriminalCourtRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudCriminalCourtRulingData"}}},"PjudFamilyCourtRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"matter":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status"]}},"court":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["as_of","query","case_number","year","matter","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results","court"]},"PjudFamilyCourtRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudFamilyCourtRulingsSearchData"}}},"PjudFamilyCourtRulingData":{"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 permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."},"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 it has none."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"PjudFamilyCourtRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudFamilyCourtRulingData"}}},"PjudLaborCourtRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"matter":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status"]}},"court":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["as_of","query","case_number","year","matter","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results","court"]},"PjudLaborCourtRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudLaborCourtRulingsSearchData"}}},"PjudLaborCourtRulingData":{"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 permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."},"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 it has none."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"PjudLaborCourtRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudLaborCourtRulingData"}}},"PjudLaborCollectionCourtRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"year":{"anyOf":[{"type":"number"},{"type":"null"}]},"matter":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ruling's permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status"]}},"court":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["as_of","query","case_number","year","matter","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results","court"]},"PjudLaborCollectionCourtRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudLaborCollectionCourtRulingsSearchData"}}},"PjudLaborCollectionCourtRulingData":{"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 permanent id at the Poder Judicial, e.g. \"8283326\". Pass it to the ruling endpoint."},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's id for the ruling's document, which can differ from `id` in the Cortes de Apelaciones."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number (rol) as the court writes it, e.g. \"19865-2023\", or with its letter prefix in a first-instance court, e.g. \"C-4513-2026\". Null when the court withholds it."},"case_year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year in the rol, which can be earlier than the ruling."},"ruling_date":{"type":"string","description":"`yyyy-mm-dd` the ruling was handed down."},"court":{"type":"string","description":"The court that ruled, e.g. \"Corte Suprema\", \"C.A. de Valdivia\", \"27º Juzgado Civil de Santiago\"."},"court_code":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Poder Judicial's code for that court."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that ruled, in the Corte Suprema and the Cortes de Apelaciones, e.g. \"SEGUNDA, PENAL\"."},"lower_court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court the case came from, when this one reviews another's decision."},"lower_court_case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case number the case carried in the lower court, e.g. \"C-103-2024\" or \"1620-2022\"."},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case title (carátula), usually the parties, e.g. \"SILVA CON FISCO DE CHILE\". Null when the ruling is anonymized."},"matters":{"type":"array","items":{"type":"string"},"description":"The matters the court classifies the case under, e.g. [\"PATERNIDAD, RECONOCIMIENTO DE\"]."},"book":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The docket book (libro), e.g. \"Civil\", \"FAMILIA\"."},"appeal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of appeal or proceeding, e.g. \"(CIVIL) CASACIÓN FONDO\", \"Familia-apelacion sentencia\"."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the court decided on the appeal, as it writes it, e.g. \"RECHAZA CASACION EN EL FONDO (M)\", \"REVOCADA\"."},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of decision a first-instance court records, e.g. \"Sentencia Condenatoria\"."},"procedural_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's procedural status, e.g. \"Fallada-Terminada\"."},"judges":{"type":"array","items":{"type":"string"},"description":"The judges (ministros or jueces) of the ruling."},"signatories":{"type":"array","items":{"type":"string"},"description":"Who signed the ruling, as listed."},"drafting_judge":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The judge who drafted the ruling (redactor), when identified."},"rapporteur":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court rapporteur (relator), when there is one."},"descriptors":{"type":"array","items":{"type":"string"},"description":"The Poder Judicial's subject descriptors for the ruling."},"cited_norms":{"type":"array","items":{"type":"string"},"description":"The provisions the ruling cites, e.g. \"CODIGO CIVIL ART. 1698\"."},"case_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique case number (RUC) the case carries across courts, when the court records one."},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of court, e.g. \"Juzgado de Garantía.\"."},"publication_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the Poder Judicial publishes the ruling, e.g. \"Con interes jurisprudencial, anonimizada\", \"Publicable\"."},"anonymized":{"type":"boolean","description":"Whether the Poder Judicial publishes the ruling anonymized: names and identifying details replaced by placeholders, in the text and the document."},"anonymization_status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Poder Judicial's anonymization status for the ruling, e.g. \"ANONIMIZADO\", \"NO ANONIMIZABLE\", \"EN PROCESO ANONIMIZACION\"."},"page_count":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages of the original document."},"original_format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The format of the court's original file, e.g. \"application/msword\", \"application/pdf\"."},"citation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The bibliographic citation the Poder Judicial gives the ruling."},"excerpt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening of the ruling's text, as the Poder Judicial previews it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document the Poder Judicial lets anyone download: the anonymized PDF, for anonymized rulings. Null otherwise."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always null: the Poder Judicial gives no permanent public link to its documents."},"document_status":{"type":"string","enum":["kept","not_downloadable","pending"],"description":"`kept` when `document_url` holds Croma's copy of the anonymized PDF; `not_downloadable` when the Poder Judicial lets no one download the ruling's file, so `text` is the whole ruling; `pending` while Croma's copy is still being taken."},"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 it has none."}},"required":["id","document_id","case_number","case_year","ruling_date","court","court_code","chamber","lower_court","lower_court_case_number","case_title","matters","book","appeal_type","outcome","decision","procedural_status","judges","signatories","drafting_judge","rapporteur","descriptors","cited_norms","case_code","jurisdiction","publication_condition","anonymized","anonymization_status","page_count","original_format","citation","excerpt","document_url","source_document_url","document_status","content"]},{"type":"null"}]}},"required":["as_of","found","ruling_id","ruling"]},"PjudLaborCollectionCourtRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PjudLaborCollectionCourtRulingData"}}},"LeychileNormsSearchData":{"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"}]},"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"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"modified_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"norm_id":{"type":"string","description":"BCN's permanent id for the norm (idNorma), e.g. \"1176603\" for Ley 21.450."},"name":{"type":"string","description":"The norm as BCN names it, e.g. \"Ley 21450\", \"DFL 1\", \"Decreto 100\"; several joined with \"; \" when the norm carries more than one identity."},"type":{"type":"string","description":"The kind of norm, e.g. \"Ley\", \"Código\", \"Decreto con Fuerza de Ley\", \"Decreto Ley\", \"Auto Acordado\", \"Tratado\", \"Decreto\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its number, e.g. \"21450\". Null when BCN lists none (\"S/N\")."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm's title."},"common_names":{"type":"array","items":{"type":"string"},"description":"Names it is known by, e.g. \"Código del Trabajo\"."},"issuing_bodies":{"type":"array","items":{"type":"string"},"description":"The bodies that issued it, e.g. \"MINISTERIO DEL TRABAJO Y PREVISIÓN SOCIAL\"."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was published in the Diario Oficial. Null for the few historical norms BCN lists without one."},"promulgation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was promulgated."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Year of publication (of promulgation when there is no publication date)."},"current_version_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the version of the text in force today took effect."},"version_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"BCN's label for the current text: \"Única\" (never modified), \"Última Versión\" (the latest of several), and so on."},"repealed":{"type":"boolean","description":"Whether the norm is repealed (derogada)."},"repeal_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was repealed, when it is."},"treaty":{"type":"boolean","description":"Whether BCN marks it as a treaty."},"subjects":{"type":"array","items":{"type":"string"},"description":"BCN's subject headings (materias)."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"BCN's summary of the norm, when it has one."},"categories":{"type":"array","items":{"type":"string"},"description":"BCN's categories for the norm."},"gazette":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where it was published, e.g. \"Diario Oficial\"."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gazette issue number."},"cve":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Diario Oficial's verification code (CVE) for the publication, when BCN records it."},"version_count":{"type":"number","description":"How many versions the text has had."},"article_count":{"type":"number","description":"How many parts (headings, articles, transitory provisions, annexes) the current text has."},"official_url":{"type":"string","description":"The norm's page at Ley Chile."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of BCN's PDF of the current version. Null when BCN did not hand it over; `source_document_url` still links it."},"xml_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of BCN's XML of the current version, the structured original the text is read from."},"source_document_url":{"type":"string","description":"The norm's page at Ley Chile, where BCN offers the text and its PDF."}},"required":["norm_id","name","type","number","title","common_names","issuing_bodies","publication_date","promulgation_date","year","current_version_date","version_kind","repealed","repeal_date","treaty","subjects","summary","categories","gazette","gazette_number","cve","version_count","article_count","official_url","document_url","xml_url","source_document_url"]}}},"required":["as_of","query","type","number","year","from_date","to_date","status","modified_by","total","total_is_exact","page","per_page","total_pages","count","results"]},"LeychileNormsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/LeychileNormsSearchData"}}},"LeychileNormData":{"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":{"norm_id":{"type":"string","description":"BCN's permanent id for the norm (idNorma), e.g. \"1176603\" for Ley 21.450."},"name":{"type":"string","description":"The norm as BCN names it, e.g. \"Ley 21450\", \"DFL 1\", \"Decreto 100\"; several joined with \"; \" when the norm carries more than one identity."},"type":{"type":"string","description":"The kind of norm, e.g. \"Ley\", \"Código\", \"Decreto con Fuerza de Ley\", \"Decreto Ley\", \"Auto Acordado\", \"Tratado\", \"Decreto\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its number, e.g. \"21450\". Null when BCN lists none (\"S/N\")."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The norm's title."},"common_names":{"type":"array","items":{"type":"string"},"description":"Names it is known by, e.g. \"Código del Trabajo\"."},"issuing_bodies":{"type":"array","items":{"type":"string"},"description":"The bodies that issued it, e.g. \"MINISTERIO DEL TRABAJO Y PREVISIÓN SOCIAL\"."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was published in the Diario Oficial. Null for the few historical norms BCN lists without one."},"promulgation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was promulgated."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Year of publication (of promulgation when there is no publication date)."},"current_version_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the version of the text in force today took effect."},"version_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"BCN's label for the current text: \"Única\" (never modified), \"Última Versión\" (the latest of several), and so on."},"repealed":{"type":"boolean","description":"Whether the norm is repealed (derogada)."},"repeal_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was repealed, when it is."},"treaty":{"type":"boolean","description":"Whether BCN marks it as a treaty."},"subjects":{"type":"array","items":{"type":"string"},"description":"BCN's subject headings (materias)."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"BCN's summary of the norm, when it has one."},"categories":{"type":"array","items":{"type":"string"},"description":"BCN's categories for the norm."},"gazette":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where it was published, e.g. \"Diario Oficial\"."},"gazette_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gazette issue number."},"cve":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Diario Oficial's verification code (CVE) for the publication, when BCN records it."},"versions":{"type":"array","items":{"type":"object","properties":{"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"BCN's label for the version: \"Texto Original\", \"Intermedio\", \"Última Versión\", \"Única\", or a deferred one."},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the version came into force."},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it stopped being in force; null for the current version."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version's page at Ley Chile."},"modified_by":{"type":"array","items":{"type":"object","properties":{"norm_id":{"type":"string","description":"The modifying norm's `norm_id`. Pass it to the norm endpoint."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its kind as BCN abbreviates it, e.g. \"LEY\", \"DTO\", \"DFL\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its number, e.g. \"21798\"."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its title."},"change":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What it did, as BCN records it, e.g. \"MODIFICACION\", \"DEROGACION\"."},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was published."},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` its change took effect."}},"required":["norm_id","type","number","title","change","publication_date","effective_date"]},"description":"The norms whose changes ended this version and produced the next one."}},"required":["kind","from_date","to_date","url","modified_by"]},"description":"Every version of the text, newest first, with the norms that modified each."},"version_count":{"type":"number","description":"How many versions the text has had."},"modified_by_ids":{"type":"array","items":{"type":"string"},"description":"The `norm_id` of every norm that modified this one, which is what the `modified_by` filter matches."},"article_count":{"type":"number","description":"How many parts (headings, articles, transitory provisions, annexes) the current text has."},"official_url":{"type":"string","description":"The norm's page at Ley Chile."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of BCN's PDF of the current version. Null when BCN did not hand it over; `source_document_url` still links it."},"xml_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of BCN's XML of the current version, the structured original the text is read from."},"source_document_url":{"type":"string","description":"The norm's page at Ley Chile, where BCN offers the text and its PDF."},"document_versions":{"type":"array","items":{"type":"object","properties":{"version_date":{"type":"string","description":"`yyyy-mm-dd` of the version these documents render."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of BCN's PDF of that version."},"xml_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of BCN's XML of that version."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the PDF in bytes."}},"required":["version_date","document_url","xml_url","bytes"]},"description":"Every version of the documents Croma has kept, oldest first."},"modifies":{"type":"array","items":{"type":"object","properties":{"norm_id":{"type":"string"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"publication_date":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["norm_id","name","title","publication_date"]},"description":"The norms whose version history lists this norm as modifying them, newest first, up to 100."},"articles":{"type":"array","items":{"type":"object","properties":{"norm_id":{"type":"string","description":"The `norm_id` of the norm the part belongs to."},"norm_name":{"type":"string","description":"The norm's name, e.g. \"Ley 21450\"."},"norm_type":{"type":"string","description":"The kind of norm."},"part_id":{"type":"string","description":"The part's id at BCN (idParte), stable across versions; \"encabezado\" and \"promulgacion\" for the heading and the closing formula."},"position":{"type":"number","description":"The part's place in the text, from 0 (the heading)."},"level":{"type":"number","description":"How deep the part sits: 0 for a part at the top, 1 for an article inside a chapter, and so on."},"parent_part_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The `part_id` of the part that contains it (a chapter, a title), when it is nested."},"kind":{"type":"string","description":"What the part is, as BCN types it: \"Artículo\", \"Capítulo\", \"Título\", \"Disposición Transitoria\", \"Anexo\", \"Encabezado\", \"Promulgación\", \"Otros\"."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The part's name, e.g. \"1\" for Artículo 1."},"heading":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The part's heading, e.g. \"Capítulo I BASES DE LA INSTITUCIONALIDAD\"."},"text":{"type":"string","description":"The part's text in the current version."},"transitory":{"type":"boolean","description":"Whether it is a transitory provision."},"repealed":{"type":"boolean","description":"Whether the part is repealed."},"version_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the version this part's text comes from."}},"required":["norm_id","norm_name","norm_type","part_id","position","level","parent_part_id","kind","name","heading","text","transitory","repealed","version_date"]},"description":"The requested parts of the current text, in order."},"offset":{"type":"number","description":"Position of the first part returned."},"has_more":{"type":"boolean","description":"Whether the text goes on past the parts returned."},"next_offset":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pass this back as `offset` to read on. Null at the end of the text."}},"required":["norm_id","name","type","number","title","common_names","issuing_bodies","publication_date","promulgation_date","year","current_version_date","version_kind","repealed","repeal_date","treaty","subjects","summary","categories","gazette","gazette_number","cve","versions","version_count","modified_by_ids","article_count","official_url","document_url","xml_url","source_document_url","document_versions","modifies","articles","offset","has_more","next_offset"]},{"type":"null"}]}},"required":["as_of","found","norm_id","norm"]},"LeychileNormResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/LeychileNormData"}}},"LeychileArticlesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"norm_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"norm_id":{"type":"string","description":"The `norm_id` of the norm the part belongs to."},"norm_name":{"type":"string","description":"The norm's name, e.g. \"Ley 21450\"."},"norm_type":{"type":"string","description":"The kind of norm."},"part_id":{"type":"string","description":"The part's id at BCN (idParte), stable across versions; \"encabezado\" and \"promulgacion\" for the heading and the closing formula."},"position":{"type":"number","description":"The part's place in the text, from 0 (the heading)."},"level":{"type":"number","description":"How deep the part sits: 0 for a part at the top, 1 for an article inside a chapter, and so on."},"parent_part_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The `part_id` of the part that contains it (a chapter, a title), when it is nested."},"kind":{"type":"string","description":"What the part is, as BCN types it: \"Artículo\", \"Capítulo\", \"Título\", \"Disposición Transitoria\", \"Anexo\", \"Encabezado\", \"Promulgación\", \"Otros\"."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The part's name, e.g. \"1\" for Artículo 1."},"heading":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The part's heading, e.g. \"Capítulo I BASES DE LA INSTITUCIONALIDAD\"."},"text":{"type":"string","description":"The part's text in the current version."},"transitory":{"type":"boolean","description":"Whether it is a transitory provision."},"repealed":{"type":"boolean","description":"Whether the part is repealed."},"version_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the version this part's text comes from."}},"required":["norm_id","norm_name","norm_type","part_id","position","level","parent_part_id","kind","name","heading","text","transitory","repealed","version_date"]}}},"required":["as_of","query","norm_id","total","total_is_exact","page","per_page","total_pages","count","results"]},"LeychileArticlesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/LeychileArticlesSearchData"}}},"TcClRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"rol":{"anyOf":[{"type":"string"},{"type":"null"}]},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}]},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}]},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"rol":{"type":"string","description":"The case's rol number at the Tribunal Constitucional, e.g. \"16770\". The Tribunal cites it with the year and procedure, \"16.770-25-INA\"."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rol with its filing year, e.g. \"17637-2026\", when the case file gives it."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure code, e.g. \"INA\" (inaplicabilidad), \"INC\", \"CPR\" (control preventivo), \"CAA\", \"CPT\", \"CDS\"."},"procedure_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure's full name, e.g. \"Inaplicabilidad de Precepto Legal (Art. 93 N° 6 - STC)\"."},"ruling_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of the latest resolution recorded, e.g. \"INA-STC\" (sentence), \"INA-Inadmisibilidad\"."},"sentence_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the latest sentence the Tribunal records for the case. Null when its only date is not a real one."},"sentence_date_raw":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"That date as the Tribunal records it; kept even when it is mistyped (a year `0205`)."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of `sentence_date`."},"caption":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case caption (carátula): who brings it, against which provision, in which proceeding. From the case file, for recent sentences."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The outcome of the latest resolution, e.g. \"Rechaza\", \"Acoge\", \"Acoge parcialmente\"."},"outcomes":{"type":"array","items":{"type":"string"},"description":"Every outcome the case's resolutions record."},"resolution_types":{"type":"array","items":{"type":"string"},"description":"The type of resolution (tipo de resolución), e.g. \"Sentencia\"."},"requesters":{"type":"array","items":{"type":"string"},"description":"Who filed the requirement (requirente)."},"pending_proceeding":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The proceeding where the provision is to be applied (gestión pendiente), for an inaplicabilidad."},"challenged_provisions":{"type":"array","items":{"type":"object","properties":{"legal_body":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The law or code the provision belongs to (cuerpo legal), e.g. \"Código del Trabajo\"."},"article":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The article (artículo), e.g. \"472\"."},"paragraph":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The paragraph (inciso), e.g. \"final\" or \"1 y 7\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The numeral (numeral), when stated."},"letter":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The letter (letra), when stated."},"section":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The párrafo, when stated."},"phrase":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The phrase challenged (frase), quoted as the Tribunal records it."},"text":{"type":"string","description":"The provision in one line, e.g. \"Código del Trabajo, artículo 470, inciso 1\"."}},"required":["legal_body","article","paragraph","number","letter","section","phrase","text"]},"description":"The legal provisions challenged (precepto legal impugnado)."},"challenged_laws":{"type":"array","items":{"type":"string"},"description":"The laws and codes of `challenged_provisions`, once each."},"constitutional_articles":{"type":"array","items":{"type":"string"},"description":"The articles of the Constitution at issue, e.g. \"Artículo 19, inciso primero, numeral 3, inciso sexto\"."},"keywords":{"type":"array","items":{"type":"string"},"description":"The Tribunal's keywords (palabras clave), e.g. \"Debido Proceso\"."},"majority":{"type":"array","items":{"type":"string"},"description":"The justices of the majority vote (voto mayoría)."},"majority_author":{"type":"array","items":{"type":"string"},"description":"Who wrote the majority vote (redactor)."},"dissent":{"type":"array","items":{"type":"string"},"description":"The dissenting justices (voto disidencia)."},"dissent_author":{"type":"array","items":{"type":"string"},"description":"Who wrote the dissent."},"concurrence":{"type":"array","items":{"type":"string"},"description":"Justices with a concurring opinion (prevención)."},"concurrence_author":{"type":"array","items":{"type":"string"},"description":"Who wrote the concurring opinion."},"bench":{"type":"array","items":{"type":"string"},"description":"The justices who sat (integración de sala)."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that decided, e.g. \"Pleno\", \"Primera Sala\", when recorded."},"related_rulings":{"type":"array","items":{"type":"string"},"description":"The earlier sentences the Tribunal lists as related, as it writes them."},"doctrine":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The doctrine the Tribunal draws from the sentence, as it summarizes it."},"justices":{"type":"array","items":{"type":"string"},"description":"Every justice named on the case, once each."},"fichas":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"The ficha's number in the Tribunal's case-law search. A case can have more than one."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of resolution the ficha records, e.g. \"INA-STC\", \"CPR\", \"INA-Inadmisibilidad\"."},"type_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its full name, e.g. \"Inaplicabilidad de Precepto Legal (Art. 93 N° 6 - STC)\"."},"sentence_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the resolution. Null when the Tribunal's date is not a real one (see `sentence_date_raw`)."},"sentence_date_raw":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date exactly as the Tribunal records it, e.g. \"2026-03-18\" or a mistyped \"0205-03-26\"."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ficha's status in the Tribunal's search, e.g. \"Ingresado\"."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Tribunal last edited the ficha."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The field's name as the Tribunal labels it, e.g. \"Requirente\", \"Resultado\", \"Voto disidencia\"."},"values":{"type":"array","items":{"type":"string"},"description":"Its values, in the Tribunal's order."}},"required":["name","values"]},"description":"Every field of the ficha with a value, as the Tribunal publishes it."}},"required":["id","type","type_name","sentence_date","sentence_date_raw","status","updated_at","fields"]},"description":"Every ficha the Tribunal's case-law search holds for the case, newest first, with all its fields."},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The document's own id: `doc-<n>` for the case-file copy (the Tribunal's document number), `sha256-<hex>` for the case-law copy (its content hash)."},"collection":{"type":"string","enum":["case_file","case_law"],"description":"`case_file` for the signed resolution from the case file, `case_law` for the copy in the Tribunal's case-law search."},"name":{"type":"string","description":"The file name the Tribunal publishes it under, e.g. \"STC_Rol_17_637-26_CAA.pdf\" or \"2026-05-28 17637.pdf\"."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Tribunal gives the document: the resolution date for the case file, the date in the file name for the case-law copy."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages in the PDF, when it could be read."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The file's size in bytes."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the PDF carries readable text, `scanned` for an image with no text, `missing` when it could not be read or kept."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document. Null only while the copy is pending."},"source_document_url":{"type":"string","description":"The document's link at the Tribunal."}},"required":["id","collection","name","date","pages","bytes","text_status","document_url","source_document_url"]},"description":"Every distinct document kept for the case, the case-file sentences first, newest first."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when `text` holds the sentence's text, `scanned` when the document is an image with no text, `missing` when the case has no document yet."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the first document in `documents`."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"That document's link at the Tribunal."}},"required":["rol","case_number","procedure","procedure_name","ruling_type","sentence_date","sentence_date_raw","year","caption","outcome","outcomes","resolution_types","requesters","pending_proceeding","challenged_provisions","challenged_laws","constitutional_articles","keywords","majority","majority_author","dissent","dissent_author","concurrence","concurrence_author","bench","chamber","related_rulings","doctrine","justices","fichas","documents","text_status","document_url","source_document_url"]}}},"required":["as_of","query","rol","procedure","outcome","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"TcClRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TcClRulingsSearchData"}}},"TcClRulingData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"rol":{"type":"string"},"ruling":{"anyOf":[{"type":"object","properties":{"rol":{"type":"string","description":"The case's rol number at the Tribunal Constitucional, e.g. \"16770\". The Tribunal cites it with the year and procedure, \"16.770-25-INA\"."},"case_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The rol with its filing year, e.g. \"17637-2026\", when the case file gives it."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure code, e.g. \"INA\" (inaplicabilidad), \"INC\", \"CPR\" (control preventivo), \"CAA\", \"CPT\", \"CDS\"."},"procedure_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure's full name, e.g. \"Inaplicabilidad de Precepto Legal (Art. 93 N° 6 - STC)\"."},"ruling_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of the latest resolution recorded, e.g. \"INA-STC\" (sentence), \"INA-Inadmisibilidad\"."},"sentence_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the latest sentence the Tribunal records for the case. Null when its only date is not a real one."},"sentence_date_raw":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"That date as the Tribunal records it; kept even when it is mistyped (a year `0205`)."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of `sentence_date`."},"caption":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case caption (carátula): who brings it, against which provision, in which proceeding. From the case file, for recent sentences."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The outcome of the latest resolution, e.g. \"Rechaza\", \"Acoge\", \"Acoge parcialmente\"."},"outcomes":{"type":"array","items":{"type":"string"},"description":"Every outcome the case's resolutions record."},"resolution_types":{"type":"array","items":{"type":"string"},"description":"The type of resolution (tipo de resolución), e.g. \"Sentencia\"."},"requesters":{"type":"array","items":{"type":"string"},"description":"Who filed the requirement (requirente)."},"pending_proceeding":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The proceeding where the provision is to be applied (gestión pendiente), for an inaplicabilidad."},"challenged_provisions":{"type":"array","items":{"type":"object","properties":{"legal_body":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The law or code the provision belongs to (cuerpo legal), e.g. \"Código del Trabajo\"."},"article":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The article (artículo), e.g. \"472\"."},"paragraph":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The paragraph (inciso), e.g. \"final\" or \"1 y 7\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The numeral (numeral), when stated."},"letter":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The letter (letra), when stated."},"section":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The párrafo, when stated."},"phrase":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The phrase challenged (frase), quoted as the Tribunal records it."},"text":{"type":"string","description":"The provision in one line, e.g. \"Código del Trabajo, artículo 470, inciso 1\"."}},"required":["legal_body","article","paragraph","number","letter","section","phrase","text"]},"description":"The legal provisions challenged (precepto legal impugnado)."},"challenged_laws":{"type":"array","items":{"type":"string"},"description":"The laws and codes of `challenged_provisions`, once each."},"constitutional_articles":{"type":"array","items":{"type":"string"},"description":"The articles of the Constitution at issue, e.g. \"Artículo 19, inciso primero, numeral 3, inciso sexto\"."},"keywords":{"type":"array","items":{"type":"string"},"description":"The Tribunal's keywords (palabras clave), e.g. \"Debido Proceso\"."},"majority":{"type":"array","items":{"type":"string"},"description":"The justices of the majority vote (voto mayoría)."},"majority_author":{"type":"array","items":{"type":"string"},"description":"Who wrote the majority vote (redactor)."},"dissent":{"type":"array","items":{"type":"string"},"description":"The dissenting justices (voto disidencia)."},"dissent_author":{"type":"array","items":{"type":"string"},"description":"Who wrote the dissent."},"concurrence":{"type":"array","items":{"type":"string"},"description":"Justices with a concurring opinion (prevención)."},"concurrence_author":{"type":"array","items":{"type":"string"},"description":"Who wrote the concurring opinion."},"bench":{"type":"array","items":{"type":"string"},"description":"The justices who sat (integración de sala)."},"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The chamber (sala) that decided, e.g. \"Pleno\", \"Primera Sala\", when recorded."},"related_rulings":{"type":"array","items":{"type":"string"},"description":"The earlier sentences the Tribunal lists as related, as it writes them."},"doctrine":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The doctrine the Tribunal draws from the sentence, as it summarizes it."},"justices":{"type":"array","items":{"type":"string"},"description":"Every justice named on the case, once each."},"fichas":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"The ficha's number in the Tribunal's case-law search. A case can have more than one."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of resolution the ficha records, e.g. \"INA-STC\", \"CPR\", \"INA-Inadmisibilidad\"."},"type_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its full name, e.g. \"Inaplicabilidad de Precepto Legal (Art. 93 N° 6 - STC)\"."},"sentence_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the resolution. Null when the Tribunal's date is not a real one (see `sentence_date_raw`)."},"sentence_date_raw":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date exactly as the Tribunal records it, e.g. \"2026-03-18\" or a mistyped \"0205-03-26\"."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ficha's status in the Tribunal's search, e.g. \"Ingresado\"."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Tribunal last edited the ficha."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The field's name as the Tribunal labels it, e.g. \"Requirente\", \"Resultado\", \"Voto disidencia\"."},"values":{"type":"array","items":{"type":"string"},"description":"Its values, in the Tribunal's order."}},"required":["name","values"]},"description":"Every field of the ficha with a value, as the Tribunal publishes it."}},"required":["id","type","type_name","sentence_date","sentence_date_raw","status","updated_at","fields"]},"description":"Every ficha the Tribunal's case-law search holds for the case, newest first, with all its fields."},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The document's own id: `doc-<n>` for the case-file copy (the Tribunal's document number), `sha256-<hex>` for the case-law copy (its content hash)."},"collection":{"type":"string","enum":["case_file","case_law"],"description":"`case_file` for the signed resolution from the case file, `case_law` for the copy in the Tribunal's case-law search."},"name":{"type":"string","description":"The file name the Tribunal publishes it under, e.g. \"STC_Rol_17_637-26_CAA.pdf\" or \"2026-05-28 17637.pdf\"."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the Tribunal gives the document: the resolution date for the case file, the date in the file name for the case-law copy."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages in the PDF, when it could be read."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The file's size in bytes."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when the PDF carries readable text, `scanned` for an image with no text, `missing` when it could not be read or kept."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the document. Null only while the copy is pending."},"source_document_url":{"type":"string","description":"The document's link at the Tribunal."}},"required":["id","collection","name","date","pages","bytes","text_status","document_url","source_document_url"]},"description":"Every distinct document kept for the case, the case-file sentences first, newest first."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when `text` holds the sentence's text, `scanned` when the document is an image with no text, `missing` when the case has no document yet."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the first document in `documents`."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"That document's link at the Tribunal."},"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, 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 sentence's text, or null when it has none."}},"required":["rol","case_number","procedure","procedure_name","ruling_type","sentence_date","sentence_date_raw","year","caption","outcome","outcomes","resolution_types","requesters","pending_proceeding","challenged_provisions","challenged_laws","constitutional_articles","keywords","majority","majority_author","dissent","dissent_author","concurrence","concurrence_author","bench","chamber","related_rulings","doctrine","justices","fichas","documents","text_status","document_url","source_document_url","content"]},{"type":"null"}]}},"required":["as_of","found","rol","ruling"]},"TcClRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TcClRulingData"}}},"DtClPronouncementsSearchData":{"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"}]},"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","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The pronouncement's permanent id at the Dirección del Trabajo, e.g. `129643`."},"type":{"type":"string","enum":["dictamen","ordinario","circular","orden_de_servicio","resolucion"],"description":"`dictamen` (sets the DT's doctrine, numbered `<number>/<correlative>`), `ordinario` (an opinion answering a consultation), `circular`, `orden_de_servicio` or `resolucion`."},"title":{"type":"string","description":"The title as the DT publishes it, e.g. \"ORD.N°388/32\", \"Circular Nº 075\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number, normalized: `388/32` for a dictamen, `493` for an ordinario. Numbers repeat across years and kinds."},"correlative":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A dictamen's correlative, the part after `/` (`32` in `388/32`). Null for other kinds."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was issued."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year it was issued."},"subjects":{"type":"array","items":{"type":"string"},"description":"The materias the DT files it under, e.g. \"Prevención de riesgos laborales\"."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The DT's summary of the doctrine or the answer."},"keywords":{"type":"array","items":{"type":"string"},"description":"The DT's descriptors for it, in lower case."},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ACTUACIÓN: what the pronouncement does, e.g. \"Fija doctrina.\", \"Aplica doctrina.\"."},"background":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ANTECEDENTES: the request, letters and memos it answers."},"legal_sources":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"FUENTES: the legal provisions it rests on."},"concordances":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CONCORDANCIA: the earlier pronouncements it agrees with or replaces, as the DT cites them."},"sender":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DE: who signs it, e.g. \"DIRECTOR NACIONAL DEL TRABAJO\"."},"recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A: who it is addressed to, with the address as the DT publishes it."},"sections":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label as the DT heads the part, e.g. `FUENTES`, `CONCORDANCIA`, `MAT`, `ANT`."},"text":{"type":"string","description":"The part's text."}},"required":["label","text"]},"description":"Every labelled part at the head of the text, in order, as published."},"concordance_tags":{"type":"array","items":{"type":"string"},"description":"The DT's index of the pronouncements this one is concordant with, as it labels them, e.g. \"dictamen 2852/158 de 30.08.2002\"."},"legal_references":{"type":"array","items":{"type":"string"},"description":"The DT's index of the legal provisions it cites, e.g. \"código del trabajo, articulo 184\"."},"related":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The related pronouncement's `id`."},"type":{"anyOf":[{"type":"string","enum":["dictamen","ordinario","circular","orden_de_servicio","resolucion"]},{"type":"null"}],"description":"Its kind."},"title":{"type":"string","description":"Its title, e.g. \"ORD. N°84/4\"."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was issued."}},"required":["id","type","title","issued_at"]},"description":"The other pronouncements the DT lists as concordant with this one."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name the Dirección del Trabajo published it under, e.g. `articles-129643_recurso_pdf.pdf`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The link's text as the DT shows it, e.g. \"ORD.N°388/32\"."},"format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file's format as the DT labels it: `pdf`, `doc`, `jpg`..."},"size_kb":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The file's size in KB as the DT states it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original file, kept by Croma byte for byte as published. Null while it is still being retrieved, or when the DT's link leads nowhere."},"source_document_url":{"type":"string","description":"The file's own link at the DT."}},"required":["name","label","format","size_kb","document_url","source_document_url"]},"description":"Every file the DT publishes with it (PDF or Word, sometimes an image)."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the first file in `documents`. Null when the DT publishes none, or while it is still being retrieved."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"That file's link at the DT."},"text_source":{"anyOf":[{"type":"string","enum":["page","document"]},{"type":"null"}],"description":"`page` when the text is the one the DT publishes with the pronouncement, `document` when the DT publishes it only as a file and the text was read from that file, null when there is no text."}},"required":["id","type","title","number","correlative","issued_at","year","subjects","summary","keywords","action","background","legal_sources","concordances","sender","recipient","sections","concordance_tags","legal_references","related","documents","document_url","source_document_url","text_source"]}}},"required":["as_of","query","type","number","year","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"DtClPronouncementsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DtClPronouncementsSearchData"}}},"DtClPronouncementData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"pronouncement_id":{"type":"string"},"pronouncement":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The pronouncement's permanent id at the Dirección del Trabajo, e.g. `129643`."},"type":{"type":"string","enum":["dictamen","ordinario","circular","orden_de_servicio","resolucion"],"description":"`dictamen` (sets the DT's doctrine, numbered `<number>/<correlative>`), `ordinario` (an opinion answering a consultation), `circular`, `orden_de_servicio` or `resolucion`."},"title":{"type":"string","description":"The title as the DT publishes it, e.g. \"ORD.N°388/32\", \"Circular Nº 075\"."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number, normalized: `388/32` for a dictamen, `493` for an ordinario. Numbers repeat across years and kinds."},"correlative":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A dictamen's correlative, the part after `/` (`32` in `388/32`). Null for other kinds."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was issued."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year it was issued."},"subjects":{"type":"array","items":{"type":"string"},"description":"The materias the DT files it under, e.g. \"Prevención de riesgos laborales\"."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The DT's summary of the doctrine or the answer."},"keywords":{"type":"array","items":{"type":"string"},"description":"The DT's descriptors for it, in lower case."},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ACTUACIÓN: what the pronouncement does, e.g. \"Fija doctrina.\", \"Aplica doctrina.\"."},"background":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ANTECEDENTES: the request, letters and memos it answers."},"legal_sources":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"FUENTES: the legal provisions it rests on."},"concordances":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CONCORDANCIA: the earlier pronouncements it agrees with or replaces, as the DT cites them."},"sender":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DE: who signs it, e.g. \"DIRECTOR NACIONAL DEL TRABAJO\"."},"recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A: who it is addressed to, with the address as the DT publishes it."},"sections":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label as the DT heads the part, e.g. `FUENTES`, `CONCORDANCIA`, `MAT`, `ANT`."},"text":{"type":"string","description":"The part's text."}},"required":["label","text"]},"description":"Every labelled part at the head of the text, in order, as published."},"concordance_tags":{"type":"array","items":{"type":"string"},"description":"The DT's index of the pronouncements this one is concordant with, as it labels them, e.g. \"dictamen 2852/158 de 30.08.2002\"."},"legal_references":{"type":"array","items":{"type":"string"},"description":"The DT's index of the legal provisions it cites, e.g. \"código del trabajo, articulo 184\"."},"related":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The related pronouncement's `id`."},"type":{"anyOf":[{"type":"string","enum":["dictamen","ordinario","circular","orden_de_servicio","resolucion"]},{"type":"null"}],"description":"Its kind."},"title":{"type":"string","description":"Its title, e.g. \"ORD. N°84/4\"."},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was issued."}},"required":["id","type","title","issued_at"]},"description":"The other pronouncements the DT lists as concordant with this one."},"documents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The file name the Dirección del Trabajo published it under, e.g. `articles-129643_recurso_pdf.pdf`."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The link's text as the DT shows it, e.g. \"ORD.N°388/32\"."},"format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file's format as the DT labels it: `pdf`, `doc`, `jpg`..."},"size_kb":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The file's size in KB as the DT states it."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original file, kept by Croma byte for byte as published. Null while it is still being retrieved, or when the DT's link leads nowhere."},"source_document_url":{"type":"string","description":"The file's own link at the DT."}},"required":["name","label","format","size_kb","document_url","source_document_url"]},"description":"Every file the DT publishes with it (PDF or Word, sometimes an image)."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's copy of the first file in `documents`. Null when the DT publishes none, or while it is still being retrieved."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"That file's link at the DT."},"text_source":{"anyOf":[{"type":"string","enum":["page","document"]},{"type":"null"}],"description":"`page` when the text is the one the DT publishes with the pronouncement, `document` when the DT publishes it only as a file and the text was read from that file, null when there is no text."},"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, 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 full text, or null when it has none."}},"required":["id","type","title","number","correlative","issued_at","year","subjects","summary","keywords","action","background","legal_sources","concordances","sender","recipient","sections","concordance_tags","legal_references","related","documents","document_url","source_document_url","text_source","content"]},{"type":"null"}]}},"required":["as_of","found","pronouncement_id","pronouncement"]},"DtClPronouncementResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DtClPronouncementData"}}},"SusesoDictamenesSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"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"}]},"topic":{"anyOf":[{"type":"string"},{"type":"null"}]},"related_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The dictamen's permanent id at SUSESO, e.g. \"758965\". Pass it to the dictamen endpoint."},"number":{"type":"string","description":"The dictamen's number as SUSESO publishes it, with its year, e.g. \"150250-2026\", \"O-01-S-04558-2026\", \"4268-1988\". SUSESO has used several numbering schemes over the years."},"title":{"type":"string","description":"The dictamen's title at SUSESO, e.g. \"Dictamen O-01-S-04558-2026\"."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of the dictamen: of its date, or of its number when SUSESO gives no date."},"issued_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the dictamen was issued. Null for the few SUSESO publishes without a date."},"recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who the dictamen is addressed to (destinatario), e.g. \"CAJA DE COMPENSACIÓN DE ASIGNACIÓN FAMILIAR\", \"COMPIN\", \"MUTUAL DE SEGURIDAD\"."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SUSESO's summary of what the dictamen decides (observación). Most dictámenes before 2019 have none."},"topics":{"type":"array","items":{"type":"string"},"description":"The topics SUSESO files the dictamen under, e.g. [\"Licencias médicas\", \"Subsidio Incapacidad Laboral (SIL)\"]. Older dictámenes carry the topic of their era too, e.g. \"LICENCIAS MÉDICAS\" or \"Ley N° 16.744\"."},"descriptors":{"type":"array","items":{"type":"string"},"description":"SUSESO's descriptors for the dictamen, e.g. [\"CCAF\", \"Crédito Social\"]."},"legal_sources":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provisions the dictamen rests on (fuentes), as listed, e.g. \"Ley 16.395, artículo 23; Ley 18.833, artículo 21\"."},"departments":{"type":"array","items":{"type":"string"},"description":"The SUSESO units that issued it, e.g. [\"INTENDENCIA DE BENEFICIOS SOCIALES - NORMATIVO\"]."},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the dictamen does (acción), when stated, e.g. \"Instruye\"."},"criterion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its criterion (criterio), when stated, e.g. \"Antiguo\"."},"validity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether it still stands (vigencia), when stated, e.g. \"No Alterado\"."},"related_circulars_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The circulars SUSESO states the dictamen agrees with (concordancia con circulares), as written."},"related_oficios_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The oficios SUSESO states the dictamen agrees with (concordancia con oficios), as written."},"other_fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label as SUSESO prints it."},"value":{"type":"string","description":"Its value, as one line of text."}},"required":["label","value"]},"description":"Any other labelled field SUSESO prints for the dictamen."},"related_dictamenes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The related item's `id` at SUSESO. For a dictamen, pass it to the dictamen endpoint."},"title":{"type":"string","description":"Its title as SUSESO lists it, e.g. \"Dictamen O-01-S-00541-2025\" or \"Circular 3906\"."},"issued_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was issued, when SUSESO lists it."}},"required":["id","title","issued_date"]},"description":"The dictámenes SUSESO lists as related to this one."},"related_circulars":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The related item's `id` at SUSESO. For a dictamen, pass it to the dictamen endpoint."},"title":{"type":"string","description":"Its title as SUSESO lists it, e.g. \"Dictamen O-01-S-00541-2025\" or \"Circular 3906\"."},"issued_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was issued, when SUSESO lists it."}},"required":["id","title","issued_date"]},"description":"The circulars SUSESO lists as related to this one."},"related_legislation":{"type":"array","items":{"type":"string"},"description":"The provisions SUSESO links the dictamen to, e.g. [\"Ley 16.395, artículo 23\"]."},"attachments":{"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What SUSESO calls the file, e.g. \"Ejemplo numérico\"."},"name":{"type":"string","description":"The file's name as SUSESO publishes it."},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file's type, read from its bytes (e.g. `application/pdf`, `image/png`)."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The file's size in bytes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-for-byte copy of the file. Null while the copy is pending."},"source_document_url":{"type":"string","description":"The file at SUSESO."}},"required":["title","name","content_type","bytes","document_url","source_document_url"]},"description":"Files SUSESO publishes with the dictamen (an annex, a table, a worked example). Most have none."},"official_url":{"type":"string","description":"The dictamen's page at SUSESO."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-for-byte copy of the dictamen's page at SUSESO, which holds its text: the latest version kept."},"source_document_url":{"type":"string","description":"The dictamen's page at SUSESO, the document Croma keeps."},"document_versions":{"type":"array","items":{"type":"object","properties":{"document_url":{"type":"string","description":"Croma's copy of this version of the dictamen's page."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When SUSESO last updated the page, as it reported it when Croma kept this copy (ISO timestamp)."}},"required":["document_url","modified_at"]},"description":"Every version of the page Croma has kept, newest first. A new one is kept only when the dictamen itself changes, not when SUSESO adds to its related lists."}},"required":["id","number","title","year","issued_date","recipient","summary","topics","descriptors","legal_sources","departments","action","criterion","validity","related_circulars_text","related_oficios_text","other_fields","related_dictamenes","related_circulars","related_legislation","attachments","official_url","document_url","source_document_url","document_versions"]}}},"required":["as_of","query","number","year","from_date","to_date","topic","related_to","total","total_is_exact","page","per_page","total_pages","count","results"]},"SusesoDictamenesSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SusesoDictamenesSearchData"}}},"SusesoDictamenData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"dictamen_id":{"type":"string"},"dictamen":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The dictamen's permanent id at SUSESO, e.g. \"758965\". Pass it to the dictamen endpoint."},"number":{"type":"string","description":"The dictamen's number as SUSESO publishes it, with its year, e.g. \"150250-2026\", \"O-01-S-04558-2026\", \"4268-1988\". SUSESO has used several numbering schemes over the years."},"title":{"type":"string","description":"The dictamen's title at SUSESO, e.g. \"Dictamen O-01-S-04558-2026\"."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of the dictamen: of its date, or of its number when SUSESO gives no date."},"issued_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the dictamen was issued. Null for the few SUSESO publishes without a date."},"recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who the dictamen is addressed to (destinatario), e.g. \"CAJA DE COMPENSACIÓN DE ASIGNACIÓN FAMILIAR\", \"COMPIN\", \"MUTUAL DE SEGURIDAD\"."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SUSESO's summary of what the dictamen decides (observación). Most dictámenes before 2019 have none."},"topics":{"type":"array","items":{"type":"string"},"description":"The topics SUSESO files the dictamen under, e.g. [\"Licencias médicas\", \"Subsidio Incapacidad Laboral (SIL)\"]. Older dictámenes carry the topic of their era too, e.g. \"LICENCIAS MÉDICAS\" or \"Ley N° 16.744\"."},"descriptors":{"type":"array","items":{"type":"string"},"description":"SUSESO's descriptors for the dictamen, e.g. [\"CCAF\", \"Crédito Social\"]."},"legal_sources":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provisions the dictamen rests on (fuentes), as listed, e.g. \"Ley 16.395, artículo 23; Ley 18.833, artículo 21\"."},"departments":{"type":"array","items":{"type":"string"},"description":"The SUSESO units that issued it, e.g. [\"INTENDENCIA DE BENEFICIOS SOCIALES - NORMATIVO\"]."},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the dictamen does (acción), when stated, e.g. \"Instruye\"."},"criterion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its criterion (criterio), when stated, e.g. \"Antiguo\"."},"validity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether it still stands (vigencia), when stated, e.g. \"No Alterado\"."},"related_circulars_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The circulars SUSESO states the dictamen agrees with (concordancia con circulares), as written."},"related_oficios_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The oficios SUSESO states the dictamen agrees with (concordancia con oficios), as written."},"other_fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label as SUSESO prints it."},"value":{"type":"string","description":"Its value, as one line of text."}},"required":["label","value"]},"description":"Any other labelled field SUSESO prints for the dictamen."},"related_dictamenes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The related item's `id` at SUSESO. For a dictamen, pass it to the dictamen endpoint."},"title":{"type":"string","description":"Its title as SUSESO lists it, e.g. \"Dictamen O-01-S-00541-2025\" or \"Circular 3906\"."},"issued_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was issued, when SUSESO lists it."}},"required":["id","title","issued_date"]},"description":"The dictámenes SUSESO lists as related to this one."},"related_circulars":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The related item's `id` at SUSESO. For a dictamen, pass it to the dictamen endpoint."},"title":{"type":"string","description":"Its title as SUSESO lists it, e.g. \"Dictamen O-01-S-00541-2025\" or \"Circular 3906\"."},"issued_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` it was issued, when SUSESO lists it."}},"required":["id","title","issued_date"]},"description":"The circulars SUSESO lists as related to this one."},"related_legislation":{"type":"array","items":{"type":"string"},"description":"The provisions SUSESO links the dictamen to, e.g. [\"Ley 16.395, artículo 23\"]."},"attachments":{"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What SUSESO calls the file, e.g. \"Ejemplo numérico\"."},"name":{"type":"string","description":"The file's name as SUSESO publishes it."},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The file's type, read from its bytes (e.g. `application/pdf`, `image/png`)."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The file's size in bytes."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-for-byte copy of the file. Null while the copy is pending."},"source_document_url":{"type":"string","description":"The file at SUSESO."}},"required":["title","name","content_type","bytes","document_url","source_document_url"]},"description":"Files SUSESO publishes with the dictamen (an annex, a table, a worked example). Most have none."},"official_url":{"type":"string","description":"The dictamen's page at SUSESO."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-for-byte copy of the dictamen's page at SUSESO, which holds its text: the latest version kept."},"source_document_url":{"type":"string","description":"The dictamen's page at SUSESO, the document Croma keeps."},"document_versions":{"type":"array","items":{"type":"object","properties":{"document_url":{"type":"string","description":"Croma's copy of this version of the dictamen's page."},"modified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When SUSESO last updated the page, as it reported it when Croma kept this copy (ISO timestamp)."}},"required":["document_url","modified_at"]},"description":"Every version of the page Croma has kept, newest first. A new one is kept only when the dictamen itself changes, not when SUSESO adds to its related lists."},"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","description":"The requested character range of the dictamen'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 dictamen's text, or null when it has none."}},"required":["id","number","title","year","issued_date","recipient","summary","topics","descriptors","legal_sources","departments","action","criterion","validity","related_circulars_text","related_oficios_text","other_fields","related_dictamenes","related_circulars","related_legislation","attachments","official_url","document_url","source_document_url","document_versions","content"]},{"type":"null"}]}},"required":["as_of","found","dictamen_id","dictamen"]},"SusesoDictamenResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SusesoDictamenData"}}},"TtaRulingsSearchData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"query":{"type":"string"},"case_ruc":{"anyOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"court_id":{"anyOf":[{"type":"number"},{"type":"null"}]},"agency":{"anyOf":[{"type":"string"},{"type":"null"}]},"jurisprudence_only":{"type":"boolean"},"from_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"to_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number","description":"Matches, counted up to 1000."},"total_is_exact":{"type":"boolean","description":"False when more than 1000 match: `total` is then 1000, and the pages go on."},"page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number","description":"Pages over `total`; there are more when `total_is_exact` is false."},"count":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The sentencia's id at the Tribunales Tributarios y Aduaneros: 32 hexadecimal characters, e.g. `ff8080813ecc6f1d013ed1f2633c13b7`."},"case_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id of the case file (expediente) the sentencia belongs to, 32 hexadecimal characters."},"case_ruc":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's RUC (rol único de causa), e.g. \"13-9-0000546-0\"."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's RIT (rol interno del tribunal), e.g. \"GR-14-00071-2013\": the procedure's letters, the court's number, the case number and the filing year."},"caption":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case caption (carátula): the claimant against the tax or customs office, e.g. \"decristal s.a. con servicio de aduanas direccion regional d\". The TTA lists it in lower case."},"court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court that ruled, e.g. \"Tribunal de Valparaiso\", \"Tribunal R. Metropolitana. Primero\"."},"court_id":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The court's number at the TTA, e.g. `14` for Valparaíso. The `court_id` filter matches it."},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The region the court sits in, e.g. \"Región de Valparaíso\"."},"agency":{"anyOf":[{"type":"string","enum":["SII","SNA"]},{"type":"null"}],"description":"The office whose act is challenged: `SII` (Servicio de Impuestos Internos, tax) or `SNA` (Servicio Nacional de Aduanas, customs)."},"agency_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office's full name, e.g. \"Servicio de Impuestos Internos\"."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure, e.g. \"Procedimiento general de reclamación\", \"Procedimiento de reclamo de los avalúos de bienes raíces\"."},"procedure_id":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The procedure's number at the TTA."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subject matter (materia), e.g. \"Liquidación\", \"Giro\", \"Tasación general bien raíz no agrícola\"."},"subject_id":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The subject matter's number at the TTA."},"sentence_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the sentencia."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of `sentence_date`."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the claim was filed (fecha de presentación)."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court's extract (extracto) of the sentencia, in lower case, as the TTA lists it. Null when it gives none."},"jurisprudence":{"type":"boolean","description":"Whether the TTA publishes the sentencia in its jurisprudence collection. The rest are first-instance final judgments it publishes in its sentencias listing only."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages in the sentencia's PDF, when it could be read."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The PDF's size in bytes."},"text_truncated":{"type":"boolean","description":"Whether `text` stops short of the whole sentencia: texts over 600,000 characters are cut there. The PDF is always whole."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when `text` holds the sentencia's text, `scanned` when the PDF is an image with no text, `missing` when it could not be read or the copy is still pending."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the sentencia's PDF, as the TTA publishes it (digitally signed). Null only while the copy is pending."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sentencia's link at the source. Always null: the TTA publishes no direct link to the file."}},"required":["id","case_file_id","case_ruc","registration_number","caption","court","court_id","region","agency","agency_name","procedure","procedure_id","subject","subject_id","sentence_date","year","filing_date","summary","jurisprudence","pages","bytes","text_truncated","text_status","document_url","source_document_url"]}}},"required":["as_of","query","case_ruc","registration_number","court_id","agency","jurisprudence_only","from_date","to_date","total","total_is_exact","page","per_page","total_pages","count","results"]},"TtaRulingsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TtaRulingsSearchData"}}},"TtaRulingData":{"type":"object","properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How current the data in this response is."},"found":{"type":"boolean"},"id":{"type":"string"},"ruling":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The sentencia's id at the Tribunales Tributarios y Aduaneros: 32 hexadecimal characters, e.g. `ff8080813ecc6f1d013ed1f2633c13b7`."},"case_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id of the case file (expediente) the sentencia belongs to, 32 hexadecimal characters."},"case_ruc":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's RUC (rol único de causa), e.g. \"13-9-0000546-0\"."},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case's RIT (rol interno del tribunal), e.g. \"GR-14-00071-2013\": the procedure's letters, the court's number, the case number and the filing year."},"caption":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The case caption (carátula): the claimant against the tax or customs office, e.g. \"decristal s.a. con servicio de aduanas direccion regional d\". The TTA lists it in lower case."},"court":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court that ruled, e.g. \"Tribunal de Valparaiso\", \"Tribunal R. Metropolitana. Primero\"."},"court_id":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The court's number at the TTA, e.g. `14` for Valparaíso. The `court_id` filter matches it."},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The region the court sits in, e.g. \"Región de Valparaíso\"."},"agency":{"anyOf":[{"type":"string","enum":["SII","SNA"]},{"type":"null"}],"description":"The office whose act is challenged: `SII` (Servicio de Impuestos Internos, tax) or `SNA` (Servicio Nacional de Aduanas, customs)."},"agency_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The office's full name, e.g. \"Servicio de Impuestos Internos\"."},"procedure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The procedure, e.g. \"Procedimiento general de reclamación\", \"Procedimiento de reclamo de los avalúos de bienes raíces\"."},"procedure_id":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The procedure's number at the TTA."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The subject matter (materia), e.g. \"Liquidación\", \"Giro\", \"Tasación general bien raíz no agrícola\"."},"subject_id":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The subject matter's number at the TTA."},"sentence_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` of the sentencia."},"year":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The year of `sentence_date`."},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`yyyy-mm-dd` the claim was filed (fecha de presentación)."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The court's extract (extracto) of the sentencia, in lower case, as the TTA lists it. Null when it gives none."},"jurisprudence":{"type":"boolean","description":"Whether the TTA publishes the sentencia in its jurisprudence collection. The rest are first-instance final judgments it publishes in its sentencias listing only."},"pages":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pages in the sentencia's PDF, when it could be read."},"bytes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The PDF's size in bytes."},"text_truncated":{"type":"boolean","description":"Whether `text` stops short of the whole sentencia: texts over 600,000 characters are cut there. The PDF is always whole."},"text_status":{"type":"string","enum":["ok","scanned","missing"],"description":"`ok` when `text` holds the sentencia's text, `scanned` when the PDF is an image with no text, `missing` when it could not be read or the copy is still pending."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Croma's byte-identical copy of the sentencia's PDF, as the TTA publishes it (digitally signed). Null only while the copy is pending."},"source_document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sentencia's link at the source. Always null: the TTA publishes no direct link to the file."},"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, 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 sentencia's text, or null when `text_status` is not `ok`."}},"required":["id","case_file_id","case_ruc","registration_number","caption","court","court_id","region","agency","agency_name","procedure","procedure_id","subject","subject_id","sentence_date","year","filing_date","summary","jurisprudence","pages","bytes","text_truncated","text_status","document_url","source_document_url","content"]},{"type":"null"}]}},"required":["as_of","found","id","ruling"]},"TtaRulingResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TtaRulingData"}}},"SeniatRifData":{"type":"object","properties":{"found":{"type":"boolean","description":"false when the registry has no taxpayer with this RIF; the other fields are then null or empty."},"rif":{"type":"string","description":"The RIF that was checked, uppercase and without separators."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The taxpayer's name as registered."},"trade_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The trade name the registry prints in parentheses after the name, or null when it prints none."},"economic_activity":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registered economic activity, or null when the registry says \"INFORMACION NO DISPONIBLE\"."},"vat_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The taxpayer's VAT condition as printed, e.g. \"Contribuyente Ordinario del IVA y Agente de Retención del IVA\". Null when the registry prints none."},"vat_withholding_rate":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The share of VAT a withholding agent must retain from this taxpayer, in percent (75 or 100)."},"vat_withholding_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The registry's withholding sentence, verbatim."},"personal_firms":{"type":"array","items":{"type":"string"},"description":"The personal firms (firmas personales) the registry lists under this taxpayer, one line each. Empty when it lists none."},"message":{"type":"string","description":"The registry's full answer in plain text, for audit or display."}},"required":["found","rif","name","trade_name","economic_activity","vat_condition","vat_withholding_rate","vat_withholding_note","personal_firms","message"]},"SeniatRifResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SeniatRifData"}}},"BancolombiaAccountsData":{"type":"object","properties":{"count":{"type":"number","description":"Number of accounts returned."},"accounts":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string","description":"The account number."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The product's name as Bancolombia shows it, usually the holder's name."},"custom_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The nickname the customer gave the account, when they set one."},"type":{"type":"string","enum":["savings","checking","credit_card","other"],"description":"The account kind: `savings` (ahorros), `checking` (corriente), `credit_card`, or `other`."},"type_raw":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bancolombia's own account-type label, e.g. `CUENTA_DE_AHORRO`."},"currency":{"type":"string","description":"The account's currency, ISO 4217, e.g. `COP`."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The account's status as Bancolombia reports it, e.g. `ACTIVO`."},"plan_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The product plan, e.g. `PLAN PREMIUM`, when given."},"available_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The available balance (saldo disponible), in the account's currency."},"current_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The current balance (saldo actual), in the account's currency."},"effective_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The effective balance (saldo efectivo), in the account's currency."},"allow_credit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the account can receive credits."},"allow_debit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the account can be debited."},"holder_relation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The connected customer's relation to the account, e.g. `TITULAR`."},"joint_holder":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the account has more than one holder."},"opening_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the account was opened, `yyyy-mm-dd`, when given."},"office":{"anyOf":[{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The branch office code, when given."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The branch office name, e.g. `CALLE 79`, when given."}},"required":["code","name"]},{"type":"null"}],"description":"The branch office the account belongs to."}},"required":["number","name","custom_name","type","type_raw","currency","status","plan_name","available_balance","current_balance","effective_balance","allow_credit","allow_debit","holder_relation","joint_holder","opening_date","office"]}},"checked_at":{"type":"string","description":"When Bancolombia was read (ISO 8601)."}},"required":["count","accounts","checked_at"]},"BancolombiaAccountsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/BancolombiaAccountsData"}}},"BancolombiaTransactionsData":{"type":"object","properties":{"account_number":{"type":"string","description":"Echoes the account the movements are for."},"from":{"type":"string","description":"Echoes the first day of the window, `yyyy-mm-dd`."},"to":{"type":"string","description":"Echoes the last day of the window, `yyyy-mm-dd`."},"count":{"type":"number","description":"Number of movements returned."},"transactions":{"type":"array","items":{"type":"object","properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The movement's date, `yyyy-mm-dd`."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The movement's description, as Bancolombia shows it."},"amount":{"type":"number","description":"The movement's amount, in the account's currency. Positive is money into the account, negative is money out."},"direction":{"type":"string","enum":["credit","debit"],"description":"Direction from the account holder's view: `credit` (money in) or `debit` (money out), derived from the amount's sign. Use this rather than `movement_type`."},"movement_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bancolombia's own raw label, e.g. `DEBITO` or `CREDITO`. It is the bank's ledger-side view and is the OPPOSITE of the holder's direction (money in is labelled `DEBITO`), so prefer `direction`. Kept for provenance."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The movement's reference, when Bancolombia gives one."},"office":{"anyOf":[{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The branch office code, when given."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The branch office name, e.g. `CALLE 79`, when given."}},"required":["code","name"]},{"type":"null"}],"description":"The branch office tied to the movement, when given."}},"required":["date","description","amount","direction","movement_type","reference","office"]}},"checked_at":{"type":"string","description":"When Bancolombia was read (ISO 8601)."}},"required":["account_number","from","to","count","transactions","checked_at"]},"BancolombiaTransactionsResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/BancolombiaTransactionsData"}}},"MonitorCreateRequest":{"type":"object","required":["name","endpoint","recipients"],"properties":{"name":{"type":"string","minLength":1,"maxLength":120,"example":"Contrato AD9-111"},"endpoint":{"type":"string","description":"The endpoint to watch, by path or catalog id. Only endpoints with `monitorable: true` in `/catalog` are accepted: every data source, served from a Croma dataset or queried live. A search reports its new results; a lookup (one case, company, vehicle or person) reports what changed in that record.","example":"/co/anm/notices-search/v1"},"query":{"type":"object","description":"The request body the monitor sends to the endpoint, validated exactly as a direct request would be. `page` and `per_page` are not allowed.","additionalProperties":true,"example":{"title_number":"AD9-111"}},"schedule":{"type":"object","description":"When the monitor runs. `source` (the default) runs right after the endpoint's own refresh completes, and is only available on endpoints with `served_from: \"dataset\"`; `hourly`, `daily` and `weekly` run on the clock, never faster than the source refreshes. An endpoint with `served_from: \"live\"` queries the source on every run, so it takes `daily` or `weekly`.","properties":{"cadence":{"type":"string","enum":["source","hourly","daily","weekly"],"default":"source"},"at":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"Time of day for daily and weekly, HH:MM. Default 08:00.","example":"08:00"},"weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"description":"Day for weekly. Default monday."},"timezone":{"type":"string","description":"IANA timezone for `at`. Defaults to the dataset's own.","example":"America/Bogota"}},"additionalProperties":false},"recipients":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":3,"description":"Up to three addresses that receive the results."},"notify":{"type":"string","enum":["always","on_new"],"default":"always","description":"`always` sends an email on every run, including one that found nothing new; `on_new` only when there is something to report."},"language":{"type":"string","enum":["es","en"],"default":"es","description":"Language of the emails."},"relevance":{"type":["string","null"],"maxLength":500,"description":"Optional instruction, in plain language, that filters new results by relevance before they are sent (e.g. \"solo avisos sobre suspensión o caducidad del título\"). Results the filter discards stay available under `GET /monitors/{id}/matches?relevant=false`."}},"additionalProperties":false},"MonitorUpdateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"query":{"type":"object","additionalProperties":true},"schedule":{"type":"object","description":"When the monitor runs. `source` (the default) runs right after the endpoint's own refresh completes, and is only available on endpoints with `served_from: \"dataset\"`; `hourly`, `daily` and `weekly` run on the clock, never faster than the source refreshes. An endpoint with `served_from: \"live\"` queries the source on every run, so it takes `daily` or `weekly`.","properties":{"cadence":{"type":"string","enum":["source","hourly","daily","weekly"],"default":"source"},"at":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"Time of day for daily and weekly, HH:MM. Default 08:00.","example":"08:00"},"weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"description":"Day for weekly. Default monday."},"timezone":{"type":"string","description":"IANA timezone for `at`. Defaults to the dataset's own.","example":"America/Bogota"}},"additionalProperties":false},"recipients":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":3,"description":"Up to three addresses that receive the results."},"notify":{"type":"string","enum":["always","on_new"],"default":"always","description":"`always` sends an email on every run, including one that found nothing new; `on_new` only when there is something to report."},"language":{"type":"string","enum":["es","en"],"default":"es","description":"Language of the emails."},"relevance":{"type":["string","null"],"maxLength":500,"description":"Optional instruction, in plain language, that filters new results by relevance before they are sent (e.g. \"solo avisos sobre suspensión o caducidad del título\"). Results the filter discards stay available under `GET /monitors/{id}/matches?relevant=false`."},"status":{"type":"string","enum":["active","paused"],"description":"Pause or resume the monitor."}},"additionalProperties":false},"MonitorLastRun":{"type":["object","null"],"required":["id","at","status","new_results","relevant_results","source_as_of","source_stale"],"properties":{"id":{"type":"string"},"at":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["running","completed","failed","skipped_plan_limit"]},"new_results":{"type":"integer"},"relevant_results":{"type":"integer"},"source_as_of":{"type":["string","null"]},"source_stale":{"type":"boolean"}}},"Monitor":{"type":"object","required":["id","name","endpoint","query","relevance","schedule","recipients","notify","language","status","created_at","updated_at","last_run"],"properties":{"id":{"type":"string","example":"mon_5f1c2c0a-9d1e-4a3b-8c7d-1e2f3a4b5c6d"},"name":{"type":"string"},"endpoint":{"type":"object","required":["id","path","source","name"],"properties":{"id":{"type":"string","example":"anm-notices-search"},"path":{"type":"string","example":"/co/anm/notices-search/v1"},"source":{"type":"string","example":"ANM"},"name":{"type":"string"}}},"query":{"type":"object","additionalProperties":true},"relevance":{"type":["string","null"]},"schedule":{"type":"object","required":["cadence","timezone","cron","next_run_at"],"properties":{"cadence":{"type":"string","enum":["source","hourly","daily","weekly"]},"at":{"type":"string"},"weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"timezone":{"type":"string"},"cron":{"type":"string","description":"The compiled schedule, five-field cron in `timezone`.","example":"30 7 * * *"},"next_run_at":{"type":["string","null"],"format":"date-time"}}},"recipients":{"type":"array","items":{"type":"string"}},"notify":{"type":"string","enum":["always","on_new"]},"language":{"type":"string","enum":["es","en"]},"status":{"type":"string","enum":["active","paused"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"last_run":{"$ref":"#/components/schemas/MonitorLastRun"}}},"MonitorRun":{"type":"object","required":["id","reason","status","started_at","finished_at","new_results","relevant_results","truncated","source_as_of","source_stale","email_status","error"],"properties":{"id":{"type":"string"},"reason":{"type":"string","enum":["scheduled","manual","baseline"]},"status":{"type":"string","enum":["running","completed","failed","skipped_plan_limit"]},"started_at":{"type":"string","format":"date-time"},"finished_at":{"type":["string","null"],"format":"date-time"},"new_results":{"type":"integer"},"relevant_results":{"type":"integer"},"truncated":{"type":"boolean","description":"The run hit its row cap; more rows matched than were reported."},"source_as_of":{"type":["string","null"]},"source_stale":{"type":"boolean","description":"The source had not published a refresh when the run had to go ahead."},"email_status":{"type":["string","null"],"enum":["sent","skipped_no_new","skipped_no_recipients","skipped_baseline","failed",null]},"error":{"type":["string","null"],"enum":["source_unavailable","source_busy","query_too_broad","internal_error",null],"description":"Why a failed run failed. `source_unavailable`: the source did not answer; the next run tries again. `source_busy`: the source's request budget was spent. `query_too_broad`: the source refused a query this broad; narrow it. `internal_error`: ours to fix."}}},"MonitorMatch":{"type":"object","required":["id","record_key","record","changes","relevant","relevance_reason","first_seen_at","run_id"],"properties":{"id":{"type":"string"},"record_key":{"type":"string"},"record":{"type":"object","additionalProperties":true,"description":"The row as the endpoint returned it. On a monitor that watches one record (a lookup), a match is either an item of one of the record's lists or a reading of the record itself without its lists."},"changes":{"type":["array","null"],"description":"On a reading of a watched record after the first: each value that moved, by its path in the record. Null on a new row or item.","items":{"type":"object","required":["path","before","after"],"properties":{"path":{"type":"string","example":"primary_case.court"},"before":{"description":"The value on the previous reading; null when it was absent."},"after":{"description":"The value on this reading; null when it is gone."}}}},"relevant":{"type":["boolean","null"],"description":"The relevance filter's verdict; null when the monitor has no filter or the filter was unavailable."},"relevance_reason":{"type":["string","null"]},"first_seen_at":{"type":"string","format":"date-time"},"run_id":{"type":"string"}}},"MonitorResponse":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Monitor"}}},"MonitorListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["results","pagination"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Monitor"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}},"MonitorRunListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["results","pagination"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MonitorRun"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}},"MonitorMatchListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["results","pagination"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MonitorMatch"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}},"MonitorRunAccepted":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["run_id","monitor_id","status"],"properties":{"run_id":{"type":"string"},"monitor_id":{"type":"string"},"status":{"type":"string","enum":["queued"]}}}}},"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 spend no credits, but still count toward an hourly ceiling.","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=100;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"}}}}}