Query and Sort Parameters Reference for POST /v1/search

POST /v1/search accepts a query object and an optional sort object in the request body. Before forwarding the request to the provider, the gateway runs two middleware functions — createQuery and createOrder — that map the flat input fields supplied by the client into the nested structure that provider APIs expect. This page documents every field those functions recognise.

Query Fields

Query fields are passed inside the query key of the request body. Any field whose value is null, undefined, an empty string "", or the string "0" is silently ignored and will not be forwarded to the provider.

Top-Level Fields

string

Record identifier. Targets a specific declaration record when known.

nombres

string

Given names of the public servant. Partial matches may be supported depending on the provider’s search implementation.

primerApellido

string

First (paternal) surname of the public servant.

segundoApellido

string

Second (maternal) surname of the public servant.

escolaridadNivel

string

Highest education level attained by the public servant (e.g. "licenciatura", "maestría", "doctorado").

Employment Fields (`datosEmpleoCargoComision`)

The following fields are grouped under datosEmpleoCargoComision in the query forwarded to the provider. Supply them as flat keys on the query object — the gateway nests them automatically.

Show datosEmpleoCargoComision fields

nombreEntePublico

string

Name of the public entity or institution where the servant is employed.

entidadFederativa

string

Federal state (entidad federativa) in which the position is held.

municipioAlcaldia

string

Municipality or borough (alcaldía) where the position is located.

empleoCargoComision

string

Job title, position name, or commission held by the public servant.

nivelOrdenGobierno

string

Order of government to which the position belongs (e.g. "federal", "estatal", "municipal").

nivelEmpleoCargoComision

string

Hierarchical level of the employment or position within its institution.

Real-Estate and Income Range Fields

Range fields are expressed as a pair of Min / Max suffixed keys. Both are optional; you may supply only one bound. Values are coerced to Number by the gateway.

`bienesInmuebles` Range Fields

The following range fields, together with formaAdquisicion, are nested under bienesInmuebles in the forwarded query.

Show bienesInmuebles range fields

formaAdquisicion

string

Method by which the property was acquired (e.g. "compra", "herencia", "donación"). Exact values depend on the provider’s catalogue.

superficieConstruccionMin

number

Minimum building/construction area (square metres).

superficieConstruccionMax

number

Maximum building/construction area (square metres).

superficieTerrenoMin

number

Minimum land/plot area (square metres).

superficieTerrenoMax

number

Maximum land/plot area (square metres).

valorAdquisicionMin

number

Minimum acquisition value of the property (Mexican pesos).

valorAdquisicionMax

number

Maximum acquisition value of the property (Mexican pesos).

Net Income Range

totalIngresosNetosMin

number

Minimum net income (ingresos netos totales) in Mexican pesos. Mapped to a top-level totalIngresosNetos.min field in the forwarded query.

totalIngresosNetosMax

number

Maximum net income in Mexican pesos. Mapped to totalIngresosNetos.max in the forwarded query.

Sort Fields

Pass sorting preferences in the sort object of the request body. Each key is a sortable field name and the value controls direction:

Value	Direction
`1`	Ascending
`-1`	Descending

If sort is absent, empty, or null, no sort instruction is forwarded to the provider.

Top-Level Sortable Fields

Field	Description
`nombres`	Given names
`primerApellido`	Paternal surname
`segundoApellido`	Maternal surname
`escolaridadNivel`	Education level
`totalIngresosNetos`	Total net income

`datosEmpleoCargoComision` Sortable Fields

These are passed as flat keys on the sort object; the gateway nests them under datosEmpleoCargoComision automatically.

Field	Description
`nombreEntePublico`	Public entity name
`entidadFederativa`	Federal state
`municipioAlcaldia`	Municipality / borough
`empleoCargoComision`	Job title / position
`nivelEmpleoCargoComision`	Employment level
`nivelOrdenGobierno`	Government order level

`bienesInmuebles` Sortable Fields

These are passed as flat keys on the sort object; the gateway nests them under bienesInmuebles automatically.

Field	Description
`superficieConstruccion`	Building area
`superficieTerreno`	Land area
`formaAdquisicion`	Acquisition method
`valorAdquisicion`	Acquisition value

Complete Example Request

{
  "supplier_id": "EDOMEX",
  "page": 1,
  "pageSize": 20,
  "query": {
    "nombres": "María",
    "entidadFederativa": "Estado de México",
    "totalIngresosNetosMin": 50000
  },
  "sort": {
    "primerApellido": 1,
    "totalIngresosNetos": -1
  }
}

page defaults to 1 and pageSize defaults to 10 when either field is absent, null, or not a valid number. These defaults are applied in the route handler after createQuery and createOrder have run.

Overview

Endpoints

Data Models

Query and Sort Parameters Reference for POST /v1/search

Query Fields

Top-Level Fields

Employment Fields (`datosEmpleoCargoComision`)

Real-Estate and Income Range Fields

`bienesInmuebles` Range Fields

Net Income Range

Sort Fields

Top-Level Sortable Fields

`datosEmpleoCargoComision` Sortable Fields

`bienesInmuebles` Sortable Fields

Complete Example Request

Build docs developers (and LLMs) love

Overview

Endpoints

Data Models

Documentation Index

​Query Fields

​Top-Level Fields

​Employment Fields (datosEmpleoCargoComision)

​Real-Estate and Income Range Fields

​bienesInmuebles Range Fields

​Net Income Range

​Sort Fields

​Top-Level Sortable Fields

​datosEmpleoCargoComision Sortable Fields

​bienesInmuebles Sortable Fields

​Complete Example Request

Build docs developers (and LLMs) love

Query Fields

Top-Level Fields

Employment Fields (`datosEmpleoCargoComision`)

Real-Estate and Income Range Fields

`bienesInmuebles` Range Fields

Net Income Range

Sort Fields

Top-Level Sortable Fields

`datosEmpleoCargoComision` Sortable Fields

`bienesInmuebles` Sortable Fields

Complete Example Request