idstring uuid required
Belvo's unique identifier for the current item.
linkstring uuid nullable required
The link.id the data belongs to.
collected_atstring date-time required
The ISO-8601 timestamp when the data point was collected.
created_atstring date-time required
The ISO-8601 timestamp of when the data point was created in Belvo's database.
updated_atstring date-time nullable required
The ISO-8601 timestamp of when the employment metrics calculation was last updated.
reference_datestring date nullable required
The reference_date your provided in your request. If you didn't provide one, this field will return null, indicating that the calculations are performed up until the date of the request.
Note: All calculations are relative to this date.
ageinteger required
The age of the individual.
current_status'EMPLOYED' | 'RETIRED' | 'UNEMPLOYED' | 'null' required
Indicates the employment status of the individual. We return one of the following responses:
- EMPLOYED
- RETIRED
- UNEMPLOYED
- null
current_employer_countinteger nullable required
The number of employers the individual has right now.
base_salary_lastnumber float nullable required
The user's latest base salary. If current_status is EMPLOYED, this is the user's current base salary.
weeks_employed_last_jobnumber float nullable required
The number of weeks the user was employed in their last job. If current_status is EMPLOYED, then this field indicates the number of weeks the user has been employed with his current job.
weeks_since_last_jobnumber float nullable required
The number of weeks since their last job. If the value of this field is 0, this indicates that the user is currently employed.
weeks_employed_totalnumber float nullable required
The total number of weeks the user has been employed, according to the institution.
Note:
In the case that the user is employed at two or more places at the same time, we still calculate those weeks as one week. For example, if a user has three concurrent jobs for a month, this is calculated as 4 weeks.
weeks_with_multiple_employersnumber float nullable required
The number of the weeks that the individual has had more than one employer at the same time.
employer_countinteger nullable required
The total number of employers the user has had. Useful to indicate employment stability over the course of their lifetime.
unique_employer_countinteger nullable required
The number of unique employers that the individual has had.
Note:
If the user left one company and returned, for example, six months later to the same company, this is counted as one employer.
employers_per_yearnumber float nullable required
Number of employers per year. Useful to indicate employment stability over the course of a year.
Note:
If the user left one company and returned, for example, six months later to the same company, this is counted as one employer.
weeks_between_jobsnumber float nullable required
The total number of weeks the individual was unemployed.
max_weeks_between_jobsnumber float nullable required
The maximum number of weeks that the individual was unemployed.
increases_last_jobinteger nullable required
The total number of salary increases the user had in their last job. If current_status is EMPLOYED, this refers to the user's current job.
Note:
For all salary increases or decreases, we only take into account those where the change in salary is greater than 2%.
decreases_last_jobinteger nullable required
The total number of salary increases the user had in their last job. If current_status is EMPLOYED, this refers to the user's current job.
increases_after_changeinteger nullable required
The total number of salary increases between the individual's penultimate job and the last (or current) job.
decreases_after_changeinteger nullable required
The total number of salary decreases between the individual's penultimate job and the last (or current) job.
increases_overallinteger nullable required
The total number of salary increases throughout the individual's working career.
decreases_overallinteger nullable required
The total number of salary decreases throughout the individual's working career.
increases_1yinteger nullable required
The total number of salary increases throughout the individual's last year (YTD).
decreases_1yinteger nullable required
The total number of salary decreases throughout the individual's last year (YTD).
increases_3yinteger nullable required
The total number of salary increases throughout the individual's last three years.
Note:
If the individual's working career is less than three years, we return null.
decreases_3yinteger nullable required
The total number of salary decreases throughout the individual's last three years.
Note:
If the individual's working career is less than three years, we return null.
increases_5yinteger nullable required
The total number of salary increases throughout the individual's last five years.
Note:
If the individual's working career is less than five years, we return null.
decreases_5yinteger nullable required
The total number of salary decreases throughout the individual's last five years.
Note:
If the individual's working career is less than five years, we return null.
yearly_change_1ynumber float nullable required
The individual's salary percentage change for the last year (YTD).
yearly_change_3ynumber float nullable required
The individual's salary percentage change for the last three years.
Note:
If the individual's working career is less than three years, we return null.
yearly_change_5ynumber float nullable required
The individual's salary percentage change for the last five years.
Note:
If the individual's working career is less than five years, we return null.
min_monthly_salary_1ynumber float nullable required
The individual's minimum monthly salary for the last year.
min_monthly_salary_3ynumber float nullable required
The individual's minimum monthly salary for the last three years.
min_monthly_salary_5ynumber float nullable required
The individual's minimum monthly salary for the last five years.
average_monthly_salary_1ynumber float nullable required
The individual's average monthly salary for the last year.
average_monthly_salary_3ynumber float nullable required
The individual's average monthly salary for the last three years.
average_monthly_salary_5ynumber float nullable required
The individual's average monthly salary for the last five years.
max_monthly_salary_1ynumber float nullable required
The individual's maximum monthly salary for the last year.
max_monthly_salary_3ynumber float nullable required
The individual's maximum monthly salary for the last three years.
max_monthly_salary_5ynumber float nullable required
The individual's maximum monthly salary for the last five years.