Overview
The Economic Data Capture API manages comprehensive financial information for background evaluations. This includes:- Monthly income and expenses
- Bank accounts
- Credit cards and loans
- Real estate properties (inmuebles)
- Personal property/vehicles (muebles)
- Additional income sources
Authentication
All endpoints require authentication via theisLoggedIn middleware. Users must have an active session to access these endpoints.
Get Economic Data
Retrieves all economic and financial data for a specific evaluation.Path Parameters
Encrypted evaluation ID
Response
Main economic data including income and expenses
Available banks for selection
Candidate’s bank accounts
Credit cards and loans
Real estate properties
Available vehicle models
Personal property and vehicles
Additional income sources
Save Economic Data
Saves income and expense information.Request Body
Evaluation ID
Income Information
Monthly base salary/income
Additional income amount
Description of what additional income consists of
Total monthly income
Expense Categories
Food expenses
Transportation expenses
Utilities (water, electricity, gas, etc.)
Phone, internet, communications
Credit card payments
Loan payments
Clothing expenses
Medical/health expenses
Savings circles (tandas)
Savings contributions
School/education expenses
Rent or mortgage payment
Pension or alimony payments
Other/miscellaneous expenses
Total monthly expenses
Property Information
Type of residence (“Propia”, “Rentada”, “Familiar”)
Property regime if married (“Sociedad Conyugal”, “Separación de Bienes”)
Any economic problems or issues
Response
“Se guardaron economicos correctamente !” - Economic data saved successfully
Example Request
Update Economic Data
Updates existing economic data. Contains the same fields as SaveEconomicos.Response
“Se actualizarón economicos correctamente !” - Economic data updated successfully
Save Bank Account
Adds a bank account to the candidate’s profile.Request Body
Evaluation ID
Account type (e.g., “Cuenta de Ahorro”, “Cuenta de Cheques”, “Inversión”)
Bank name
Account opening date
Opening balance
Current balance
Response
“Se guardaron los bancos correctamente !” - Bank account saved
Delete Bank Account
Request Body
Bank account ID to delete
Response
“Cuenta borrada” - Account deleted
Save Credit/Loan
Adds a credit card or loan record.Request Body
Evaluation ID
Type of credit (e.g., “Tarjeta de Crédito”, “Préstamo Personal”, “Crédito Automotriz”)
Financial institution name
Date credit was obtained
Current debt amount
Monthly payment
Original loan/credit amount
Response
“Se guardaron creditos correctamente !” - Credit saved successfully
Delete Credit/Loan
Request Body
Credit ID to delete
Response
“Credito borrado” - Credit deleted
Save Real Estate Property
Adds a real estate property (house, land, commercial property, etc.).Request Body
Evaluation ID
Property type (e.g., “Casa”, “Terreno”, “Departamento”, “Local Comercial”)
Date of acquisition
How acquired (e.g., “Compra”, “Herencia”, “Donación”)
Property location/address
Purchase value
Current estimated value
Documentation (e.g., “Escritura”, “Contrato”)
Response
“Inmueble guardado !” - Property saved
Delete Real Estate Property
Request Body
Property ID to delete
Response
“Inmueble borrado” - Property deleted
Save Personal Property
Adds personal property such as vehicles, equipment, etc.Request Body
The request accepts the complete object from the form. Common fields include:Evaluation ID
Type of property (e.g., “Vehículo”, “Motocicleta”, “Equipo”)
Brand
Model
Year
Current value
Response
“Bien mueble guardado !” - Personal property saved
Delete Personal Property
Request Body
Property ID to delete
Response
“Mueble borrado” - Property deleted
Save Additional Income
Adds an additional income source.Request Body
Evaluation ID
Name/description of the income source
Monthly income amount from this source
Response
“Ingreso extra guardado !” - Additional income saved
Example Request
Delete Additional Income
Request Body
Income record ID to delete
Response
“Ingreso extra borrado” - Additional income deleted
Error Responses
All endpoints return:“Algo salio mal !” - Generic error message
Workflow
- Retrieve existing economic data using GET endpoint
- Save or update main economic data (income/expenses)
- Add bank accounts
- Add credits/loans
- Add real estate properties
- Add personal property (vehicles, etc.)
- Add additional income sources
- Delete records as needed
Best Practices
- Ensure total income equals the sum of base salary and additional income
- Total expenses should equal the sum of all expense categories
- Update bank account balances regularly
- Include all debts and liabilities
- Document all significant assets
- Verify all financial information is accurate and current