Data Dictionary

This detailed reference table provides developers with complete specifications for each field available in the Buró de Ingresos API — including data types, requirements, example values, and usage notes.

Verification

Field NameTypeDescriptionExampleNotes
idstring (UUID)Unique verification identifier"bd830637-ea6e-4888-80ab-a09f01fc9209"Auto-generated
identifierstringPrimary key - CURP or RFC"OICE940722HGFRST08"18 chars for CURP, 12-13 chars for RFC
statusstringVerification status"completed""in_progress" or "completed"
data_availablebooleanIf any data was found using this IdentifierTrueTrue or False
can_retrybooleanIf the verification can be retriedFalseTrue or False
entitiesarrayType of Data Available["profile", ,"employment","employment_files" "invoices"]
consent_idstring (UUID)Consent reference"92d78902-61e0-4fc1-93e6-243519259cb3"Required for any verification

Profile

Personal Info

Field NameTypeDescriptionExampleNotes
first_namestringFirst Name"María Jose"
last_namestringLast Name"Pérez Estrada"
curpstringIndividual's CURPMAPE850312HDFRRR02
nssstringSocial Security Number65189234567May be null
rfcstringTax ID numberMAPE850312F23
phonestringContact phone525540235678May be null
emailstringContact email"[email protected]"May be null

Address

Field NameTypeDescriptionExampleNotes
streetstringStreet address"Valle del Olmo 28"Address component
neighborhoodstringNeighborhood"Nueva Santa María"Address component
municipalitystringMunicipality"Azcapotzalco"Address component
statestringState/entity"CDMX"Address component
zip_codestringPostal code"52340"Address component

Employment Status

We determine an individual’s employment status based on their Employment and Invoice records.

The possible values are: employed, self_employed, unemployed or unknown

Employment Files

Official employment documentation files from IMSS and ISSSTE. These are downloadable PDF documents that provide verifiable proof of employment records and contribution history.

Field NameTypeDescriptionExampleNotes
identifierstringCURP or RFC associated with the files"MAPE850312HDFRRR02"Same as verification identifier
employment_filesarray[object]Array of employment document filesSee belowMay be empty if no files available

Employment File Object

Each item in the employment_files array contains:

Field NameTypeDescriptionExampleNotes
urlstring (URL)Pre-signed download URL"https://storage.googleapis.com/...?X-Amz-..."Temporary URL, expires after 15 minutes
namestringDocument name"Constancia de Semanas Cotizadas en el IMSS"Human-readable document description
institutionstringSource institution"imss" or "issste"Government agency that issued document
uploaded_atstring (ISO 8601)When the file was uploaded/generated"2025-10-02T01:23:41Z"Full timestamp in UTC

Document Types by Institution

InstitutionDocument NameDescription
imssConstancia de Semanas Cotizadas en el IMSSShows entire employment history as reported to IMSS
imssReporte de Cotización al IMSSShows current employment status and salary as reported to IMSS.
imssConstancia de No DerechohabienteCertificate attesting that the user is not registered in IMSS.
isssteExpediente Electrónico Único del ISSSTEUnique electronic file from ISSSTE

Important Notes

  • The url field contains a pre-signed URL that expires after 15 minutes (X-Amz-Expires=900)
  • Files are in PDF format
  • Each verification may return multiple files depending on which institutions have data for the identifier
  • If no employment files are available, the employment_files array will be empty: []

Employment

These fields are exclusively obtained from IMSS and/or ISSSTE.

Field NameTypeDescriptionExampleNotes
semanas_cotizadasnumberNumber of weeks been paid into IMSS447This could be used as a proxy indicator of how long a worker has been in formal employment.
employerstringCompany name"CONSTRUCCIONES YAMILE"
employer_registrationstringCompany registration"Y606341210"
start_datestring(date)Employment start"2020-02-22"YYYY-MM-DD format
end_datestring (date)Employment end"2020-02-15"Null = current job
federal_entitystringWork location"CIUDAD DE MÉXICO"State/region
base_salarynumberDaily salary116.02in MXN
monthly_salarynumberMonthly salary3529.33in MXN
pdf_linkstring (URL)Document link"https://link_to_pdf.com"May be null

Earnings

Platform economy income data from ride-sharing and delivery services. These fields provide monthly earnings history from connected platforms.

Field NameTypeDescriptionExampleNotes
identifierstringCURP or RFC associated with earnings"CURP123456HDFLRS09"Same as verification identifier
updated_atstring (ISO 8601)When earnings data was last updated"2025-11-06T22:04:24.174750Z"Full timestamp in UTC
earnings_historyarray[object]Array of monthly earnings recordsSee belowSorted by period (most recent first)
paginationobjectPagination informationSee Pagination sectionStandard pagination object

Earnings Period Object

Each item in the earnings_history array contains:

Field NameTypeDescriptionExampleNotes
periodstringMonth and year of earnings"2025-03"YYYY-MM format
amountnumberTotal earnings for the period21000.00Decimal format
currencystringCurrency code"MXN"Usually MXN
platformstringPlatform where earnings were generated"uber"e.g., uber, didi

Example Earnings History

PeriodAmountCurrencyPlatform
2025-0321,000.00MXNuber
2025-0218,500.75MXNuber
2025-0115,000.50MXNuber

Important Notes

  • Earnings data is aggregated by month (period in YYYY-MM format)
  • Each platform reports separately (e.g., Uber and Didi earnings appear as separate records)
  • Historical data availability varies by platform and user
  • This data complements traditional employment records by capturing gig economy income

Invoice

Field NameTypeDescriptionExampleNotes
typestringInvoice type"nomina"See Invoices Types
amountnumberTotal amount42487.53
currencystringCurrency code"mxn"Usually MXN
folio_fiscalstringFiscal identifier of invoice"7A9F33E4-892C-4B8D-A9E1-2F6F0001"May be null
issue_datestring (ISO 8601)Official issue time"2025-04-01T10:00:00Z"Full timestamp
rfc_issuerstringIssuer's RFC"CYA010101AAA"Who issued the invoice
issuer_namestringIssuer's name"Construcciones Yamile S.A. de C.V."Name of individual or company issuing the invoice
rfc_receiverstringReceiver's RFC"OICE940722GHW"Who received the invoice
receiver_namestringReceiver's name"José Carlos Aguilar Rincón"Name of individual or company receiving the invoice

Incomes and Deductions

Field NameTypeDescriptionExampleNotes
incomesarray[object]Income breakdown[{"amount": 35000, "currency": "MXN", "detail": "base salary"}]Array of income items
deductionsarray[object]Deduction breakdown[{"amount": 5832.23, "currency": "MXN", "detail": "IMSS"}]Array of deduction items

Keep in mind that the detail field can contain any value — it is not limited to a fixed list. This is an example:

CategoryDetailCurrencyAmount
incomesRAYA ORDINARIA 6 DIAMXN1,943.40
incomesSEPTIMO DIAMXN323.9
deductionsIMSSMXN69.33
deductionsISRMXN188.47

Invoice Types

Below is a reference table for the invoice types supported by the SAT and returned by the API:

CodeMeaningTypeDescriptionCurrently Available
nominaNóminaPayrollPayroll receipts issued to employeesYes
ingresoIngresoIncomeInvoice for sales of goods or servicesYes
egresoEgresoCredit NoteIssued for returns, discounts, or invoice correctionsYes
trasladoTrasladoTransferTransfer of goods without sale (internal movements)No
pagoPagoPaymentPayment complement for previously issued invoicesNo