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.
Core Identifier & Verification Fields
| Field Name | Type | Description | Example | Notes |
|---|---|---|---|---|
identifier | string | Primary key - CURP or RFC | "OICE940722HGFRST08" | 18 chars for CURP, 12-13 chars for RFC |
status | string | Verification status | "success" | Refer to 'Status Responses' table for more info. |
verification_id | string (UUID) | Unique verification identifier | "bd830637-ea6e-4888-80ab-a09f01fc9209" | Auto-generated |
consent_id | string (UUID) | Consent reference | "92d78902-61e0-4fc1-93e6-243519259cb3" | Required for verification |
Status Responses
| Status | Description |
|---|---|
| Success | We were able to retrieve at least one invoice or employment record for the identifier provided. |
| No Data | We were able to consult all our available data sources but none of them returned at least one invoice or employment record for the identifier provided. |
| Error | There was an internal error with our API or our data source. |
| In Progress | The verification process is in progress. We're requesting information from our data partners. |
Profile Fields
| Field Name | Type | Description | Example | Notes |
|---|---|---|---|---|
full_name | string | Complete legal name | "José Carlos Aguilar Rincón" | |
curp | string | Individual's CURP | OICE940722HGFRST08 | |
nss | string | Social Security Number | 02189216878 | May be null |
rfc | string | Tax ID number | OICE940722GHW | |
phone | string | Contact phone | 525540235678 | May be null |
email | string | Contact email | "[email protected] " | May be null |
street | string | Street address | "Valle del Olmo 28" | Address component |
neighborhood | string | Neighborhood | "Nueva Santa María" | Address component |
municipality | string | Municipality | "Azcapotzalco" | Address component |
state | string | State/entity | "CDMX" | Address component |
zip\_code | string | Postal code | "52340" | Address component |
Income History Fields
| Field Name | Type | Description | Example | Notes |
|---|---|---|---|---|
date | string (date) | Income period | "2024-04-01" | Monthly records |
amount | number | Income amount | 15000 | Based on invoices and employment records. |
Employment Fields
These fields are exclusively obtained from IMSS and/or ISSSTE.
| Field Name | Type | Description | Example | Notes |
|---|---|---|---|---|
employment_status | string | Current status | "employed" , "unemployed" | Calculated field based on whether the user has an employment record or invoice for the current month. |
employer | string | Company name | "CONSTRUCCIONES YAMILE" | |
employer_registration | string | Company registration | "Y606341210" | |
start_date | string(date) | Employment start | "2020-02-22" | YYYY-MM-DD format |
end_date | string (date) | Employment end | "2020-02-15" | Null = current job |
federal_entity | string | Work location | "CIUDAD DE MÉXICO" | State/region |
base_salary | number | Daily salary | 116.02 | in MXN |
monthly_salary | number | Monthly salary | 3529.33 | in MXN |
data_source | string | Source of employment record info | "imss_quoted_weeks" , "imss_rpci" , "issste" | Refer to 'Employment Data Sources' table for more info. |
requested_at | string (ISO 8601) | Data retrieval time | "2025-04-29T10:34:15Z" | Timestamp |
pdf_link | string (URL) | Document link | "https://link_to_pdf.com" | May be null |
Employment Data Sources
| Source | Description |
|---|---|
"imss_quoted_weeks" | This refers to the Reporte de Semanas Cotizadas provided by IMSS. This provides a full employment history of the worker as per IMSS. |
"imss_rpci" | This refers to the Reporte de Cotización al IMSS. This provides a current employment status and salary of the worker as per IMSS. |
"issste" | This refers to the information obtained from the ISSSTE worker's portal. |
Invoice Fields
| Field Name | Type | Description | Example | Notes |
|---|---|---|---|---|
type | string | Invoice type | Invoice types based on SAT codes: N = Nómina, I = Ingreso, E = Egreso, T = Traslado, P = Pago | |
amount | number | Total amount | 42487.53 | |
currency | string | Currency code | "mxn" | Usually MXN |
datestr | string (date) | Invoice date | "2025-04-01" | YYYY-MM-DD |
folio_fiscal | string | Fiscal identifier of invoice | "7A9F33E4-892C-4B8D-A9E1-2F6F0001" | May be null |
issue_date | string (ISO 8601) | Official issue time | "2025-04-01T10:00:00Z" | Full timestamp |
rfc_issuer | string | Issuer's RFC | "CYA010101AAA" | Who issued the invoice |
issuer_name | string | Issuer's name | "Construcciones Yamile S.A. de C.V." | Name of individual or company issuing the invoice |
rfc_receiver | string | Receiver's RFC | "OICE940722GHW" | Who received the invoice |
receiver_name | string | Receiver's name | "José Carlos Aguilar Rincón" | Name of individual or company receiving the invoice |
Invoice Line Items
| Field Name | Type | Description | Example | Notes |
|---|---|---|---|---|
incomes | array[object] | Income breakdown | [{"amount": 35000, "currency": "MXN", "detail": "base salary"}] | Array of income items |
deductions | array[object] | Deduction breakdown | [{"amount": 5832.23, "currency": "MXN", "detail": "IMSS"}] | Array of deduction items |
This is an example
| Category | Detail | Currency | Amount |
|---|---|---|---|
incomes | RAYA ORDINARIA 6 DIA | MXN | 1,943.40 |
incomes | SEPTIMO DIA | MXN | 323.9 |
deductions | IMSS | MXN | 69.33 |
deductions | ISR | MXN | 188.47 |
Invoice Types
Below is a reference table for the invoice types supported by the SAT and returned by the API:
| Code | Meaning | Type | Description | Currently Available |
|---|---|---|---|---|
N | Nómina | Payroll | Payroll receipts issued to employees | Yes |
I | Ingreso | Income | Invoice for sales of goods or services | Yes |
E | Egreso | Credit Note | Issued for returns, discounts, or invoice corrections | Yes |
T | Traslado | Transfer | Transfer of goods without sale (internal movements) | No |
P | Pago | Payment | Payment complement for previously issued invoices | No |
Updated 1 day ago