Skip to main content

​
Overview

The References Data Capture API manages both work-related (laborales) and personal references for candidates. The system requires:
  • 3 Work References (laborales): From previous employers or supervisors
  • 3 Personal References (personales): From non-family members who know the candidate
The system handles different reference requirements for Permanencia (current employees) vs Nuevo Ingreso (new hires).

​
Authentication

All endpoints require authentication via the isLoggedIn middleware. Users must have an active session to access these endpoints.

​
Get References Data

Retrieves existing reference information for a specific evaluation.

​
Path Parameters

​
encryptedData
string
required
Encrypted evaluation ID

​
Response

For Permanencia (current employees):
​
referenciasLaborales
object
Complete set of work and personal references
​
permanencia
string
Flag indicating permanencia evaluation type
For Nuevo Ingreso (new hires):
​
referenciasLaborales
object
Complete set of work and personal references
​
GetEmpleosToReferencias
array
Previous employment records to help identify work references
​
ni
string
Flag indicating nuevo ingreso evaluation type

​
Save References

Saves all reference information (work and personal references).

​
Request Body

​
evalID
string
required
Evaluation ID for the candidate

​
Work Reference 1

​
referenciasNombre1
string
required
Full name of first work reference
​
referenciasPuesto1
string
required
Position/title of first work reference
​
referenciasEmpresa1
string
required
Company/organization of first work reference
​
referenciasTelefono1
string
required
Phone number of first work reference

​
Work Reference 2

​
referenciasNombre2
string
required
Full name of second work reference
​
referenciasPuesto2
string
required
Position/title of second work reference
​
referenciasEmpresa2
string
required
Company/organization of second work reference
​
referenciasTelefono2
string
required
Phone number of second work reference

​
Work Reference 3

​
referenciasNombre3
string
required
Full name of third work reference
​
referenciasPuesto3
string
required
Position/title of third work reference
​
referenciasEmpresa3
string
required
Company/organization of third work reference
​
referenciasTelefono3
string
required
Phone number of third work reference

​
Personal Reference 1

​
referenciasNombreP1
string
required
Full name of first personal reference
​
referenciasFijoP1
string
Landline phone number of first personal reference
​
referenciasCelularP1
string
required
Mobile phone number of first personal reference

​
Personal Reference 2

​
referenciasNombreP2
string
required
Full name of second personal reference
​
referenciasFijoP2
string
Landline phone number of second personal reference
​
referenciasCelularP2
string
required
Mobile phone number of second personal reference

​
Personal Reference 3

​
referenciasNombreP3
string
required
Full name of third personal reference
​
referenciasFijoP3
string
Landline phone number of third personal reference
​
referenciasCelularP3
string
required
Mobile phone number of third personal reference
​
encryptedData
string
required
Encrypted evaluation data for redirection

​
Response

​
success
string
“Referencias guardadas con exito !” - References saved successfully
Successful save redirects to the evaluation view page.

​
Example Request

{
  "evalID": "12345",
  "referenciasNombre1": "Lic. Roberto Martínez",
  "referenciasPuesto1": "Director de Recursos Humanos",
  "referenciasEmpresa1": "Seguridad Estatal",
  "referenciasTelefono1": "6181234567",
  "referenciasNombre2": "Ing. Carmen López",
  "referenciasPuesto2": "Jefa de Departamento",
  "referenciasEmpresa2": "Policía Preventiva",
  "referenciasTelefono2": "6189876543",
  "referenciasNombre3": "Cap. Miguel Hernández",
  "referenciasPuesto3": "Comandante",
  "referenciasEmpresa3": "CEACC Durango",
  "referenciasTelefono3": "6185554321",
  "referenciasNombreP1": "Jorge Ramírez Soto",
  "referenciasFijoP1": "6183334455",
  "referenciasCelularP1": "6181112233",
  "referenciasNombreP2": "Ana María Gutiérrez",
  "referenciasFijoP2": "",
  "referenciasCelularP2": "6182223344",
  "referenciasNombreP3": "Pedro Sánchez Villa",
  "referenciasFijoP3": "6184445566",
  "referenciasCelularP3": "6183334455"
}

​
Update References

Updates existing reference information. Contains all the same fields as SaveReferencias.

​
Request Body

Same fields as SaveReferencias endpoint.

​
Response

​
success
string
“Referencias guardadas con exito !” - References updated successfully
Successful update redirects to the evaluation view page.

​
Error Responses

All endpoints return:
​
message
string
“Algo salio mal !” - Generic error message indicating something went wrong
The endpoint will redirect back to the previous page with the error message displayed as a flash message.

​
Reference Requirements

​
Work References (Laborales)

All three work references must include:
  • Full name
  • Current position/title
  • Company/organization name
  • Contact phone number
Work references should be:
  • Former supervisors or managers
  • Colleagues from previous positions
  • HR representatives from previous employers
  • NOT family members
  • NOT friends (use personal references for this)

​
Personal References (Personales)

All three personal references must include:
  • Full name
  • At least one phone number (mobile required, landline optional)
Personal references should be:
  • Non-family members who have known the candidate for a significant period
  • Friends, neighbors, or acquaintances who can vouch for character
  • Community leaders or professionals who know the candidate
  • NOT current or former supervisors (use work references for this)
  • NOT family members

​
Workflow

  1. Retrieve existing reference data using GET endpoint
  2. For new hire candidates, review previous employment records to identify potential work references
  3. Collect all six references (3 work + 3 personal)
  4. Save all references using a single SaveReferencias request
  5. Update references if information changes

​
Best Practices

​
Data Collection

  • Verify all phone numbers are correct and active
  • Ensure work references are from different employers or departments
  • Confirm personal references are not related to the candidate
  • Obtain permission from references before submitting their information

​
Data Quality

  • Use complete, formal names (not nicknames)
  • Include area codes with all phone numbers
  • Verify company names are spelled correctly
  • Ensure position titles are accurate

​
Validation

  • All three work references must be provided
  • All three personal references must be provided
  • Each personal reference must have at least a mobile phone number
  • References will be contacted during the background investigation process

​
Integration Notes

  • This is typically the final step in the data capture process
  • Successfully saving references redirects to the evaluation view (not back to the form)
  • The system distinguishes between permanencia and nuevo ingreso evaluation types
  • For nuevo ingreso candidates, previous employment records are displayed to assist in identifying appropriate work references

​
Common Issues

Missing Phone Numbers: Ensure all work references have at least one phone number and all personal references have at least a mobile number.
Family Members as References: Do not include family members as either work or personal references. The system tracks family members separately.
Incomplete Data: All six references (3 work + 3 personal) must be provided in a single submission. Partial submissions are not supported.

Build docs developers (and LLMs) love

Get started for freeTalk to us