# Obter os detalhes de um registro de emprego Obtenha os detalhes de um registro de emprego específico. Endpoint: GET /api/employment-records/{id}/ Version: 1.223.0 Security: basicAuth ## Path parameters: - `id` (string, required) O sobre o qual você deseja obter informações detalhadas. ## Query parameters: - `omit` (string) Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal. - `fields` (string) Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas. ## Response 200 fields (application/json): - `id` (string) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `link` (string,null) O ao qual os dados pertencem. Example: "30cb4806-6e00-48a4-91c9-ca55968576c8" - `created_at` (string) O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo. Example: "2022-02-09T08:45:50.406032Z" - `collected_at` (string) O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado. Example: "2022-02-09T08:45:50.406032Z" - `report_date` (string) A data em que o relatório de registro de emprego foi gerado, no formato . Example: "2023-01-19" - `internal_identification` (string) ID único para o usuário de acordo com a instituição. Para IMSS e ISSSTE México, este é o CURP. Example: "BLPM951331IONVGR54" - `personal_data` (object) Detalhes sobre as informações pessoais do indivíduo. - `personal_data.official_name` (string,null) O nome legal do indivíduo. Example: "Bruce Banner del Torro" - `personal_data.first_name` (string,null) O primeiro nome do indivíduo. Example: "Bruce" - `personal_data.last_name` (string,null) O sobrenome do indivíduo. Example: "Banner del Torro" - `personal_data.birth_date` (string,null) A data de nascimento do indivíduo, no formato . Example: "2022-02-09" - `personal_data.entitlements` (object) Detalhes sobre os benefícios aos quais o indivíduo tem direito. - `personal_data.entitlements.entitled_to_health_insurance` (boolean) Indica se o indivíduo tem ou não direito a seguro de saúde. Example: true - `personal_data.entitlements.entitled_to_company_benefits` (boolean) Indica se o indivíduo tem ou não direito aos benefícios da empresa. Example: true - `personal_data.entitlements.valid_until` (string,null) Data até quando o indivíduo está coberto pelo seguro de saúde e/ou benefícios da empresa. Se for , o funcionário está atualmente trabalhando e não é necessária uma data de término. - `personal_data.entitlements.status` (string) Indica o status de emprego do indivíduo. Retornamos uma das seguintes respostas: - - - - Enum: "EMPLOYED", "RETIRED", "UNEMPLOYED", "null" - `personal_data.document_ids` (array) Detalhes sobre os documentos de identificação do indivíduo. - `personal_data.document_ids.document_type` (string,null) O tipo de documento relacionado ao indivíduo. Retornamos um dos seguintes valores: - - - Enum: "NSS", "CURP", "RFC" - `personal_data.document_ids.document_number` (string,null) O número do documento de identidade (como uma string). Example: "10277663582" - `personal_data.email` (string,null) O endereço de e-mail do indivíduo. Example: "bruce.banner@avengers.com" - `social_security_summary` (object,null) Detalhes sobre as contribuições previdenciárias do indivíduo, de acordo com o IMSS. >: Para o ISSSTE México, este valor retornará . - `social_security_summary.weeks_redeemed` (integer,null) Número de semanas que o indivíduo precisou retirar de sua aposentadoria. - `social_security_summary.weeks_reinstated` (integer,null) Número de semanas que o indivíduo contribuiu novamente para o seu fundo de pensão (), após tê-lo resgatado anteriormente. - `social_security_summary.weeks_contributed` (integer,null) Número de semanas que o indivíduo contribuiu para a sua previdência social, com base no número de semanas que o indivíduo trabalhou de acordo com o IMSS. Example: 188 - `employment_records` (array) Detalhes sobre o histórico de emprego do indivíduo. - `employment_records.employer` (string) O nome oficial do empregador. >: Para o ISSSTE México, este é o nome oficial da entidade junto com a entidade responsável por gerenciar as informações do empregado, separados por um ponto e vírgula (). Por exemplo: SECRETARIA DE EDUCACION PUBLICA (SEP);SECRETARIA DE EDUCACION PUBLICA (SEP). Example: "Batman Enterprises CDMX" - `employment_records.employer_id` (string,null) O ID oficial do empregador, de acordo com o país. >: Para ISSSTE México, este valor retornará . Example: "780-BAT-88769-CDMX" - `employment_records.start_date` (string) Data de início do emprego, no formato . Example: "2019-10-10" - `employment_records.end_date` (string,null) Data de término do emprego, no formato . >: Este campo retornará para o emprego atual do usuário. Example: "2019-12-31" - `employment_records.weeks_employed` (integer) Número de semanas em que o indivíduo esteve empregado. Example: 12 - `employment_records.state` (string,null) Em que estado geográfico o indivíduo estava empregado, de acordo com o país. >: Para ISSSTE México, este valor retornará . Example: "DISTRITO FEDERAL" - `employment_records.most_recent_base_salary` (number) O salário base mais recente que o indivíduo recebeu. - Para o IMSS México, esse valor é calculado incluindo os benefícios aos quais o indivíduo tem direito ao longo do ano. - Para o ISSSTE México, esse valor é calculado dividindo o por 30 (dias) e exclui os benefícios do indivíduo. Example: 762.54 - `employment_records.monthly_salary` (number) O salário mensal do indivíduo, incluindo quaisquer benefícios adicionais. - Para o IMSS México, este valor é calculado incluindo os benefícios aos quais o indivíduo tem direito ao longo do ano. - Para o ISSSTE México, este valor é calculado excluindo os benefícios. Example: 23193.925 - `employment_records.currency` (string) O código de moeda de três letras em que o salário é pago. Example: "MXN" - `employment_records.employment_status_updates` (array,null) Detalhes sobre quaisquer mudanças de emprego do indivíduo. - `employment_records.employment_status_updates.event` (string,null) Para o IMSS México, este é o evento que causou a mudança no status de emprego ou salário. Retornamos um dos seguintes valores: - : O funcionário foi demitido ou pediu demissão. - : O funcionário recebeu uma modificação salarial (aumento ou diminuição). - : O funcionário foi contratado. - : O funcionário fez uma contribuição voluntária ao IMSS. - : O funcionário estava ausente (como em férias). - : O funcionário estava de licença médica. Para o ISSSTE México, esta é a fonte de informação sobre a mudança no status de emprego ou salário. Retornamos um dos seguintes valores: - : Indica que a informação foi recebida do . - : Indica que a informação foi recebida do banco de dados central, . - : Indica que a informação foi recebida de uma instituição afiliada, . Enum: "DISMISSED_RESIGNED", "SALARY_MODIFICATION", "HIRED", "VOLUNTARY_CONTRIBUTION", "ABSENCE", "SICK_LEAVE", "NORMAL", "BDUTA_CERTIFICATE", "DYE_CERTIFICATE" - `employment_records.employment_status_updates.base_salary` (number) O salário base do indivíduo, atualizado na . - Para o IMSS México, esse valor é calculado incluindo os benefícios aos quais o indivíduo tem direito ao longo do ano. - Para o ISSSTE México, esse valor é calculado excluindo os benefícios do indivíduo. Example: 1033.09 - `employment_records.employment_status_updates.update_date` (string) A data em que o evento de emprego ocorreu, no formato . Example: "2021-09-01" - `employment_scores` (array,null) Um array de pontuações de . Cada pontuação fornece uma visão sobre a empregabilidade e o potencial de geração de renda em um determinado período. > : Este campo está disponível apenas para links criados com o IMSS do México. Para outras instituições, este campo retornará . > : Este campo retornará para registros de emprego recuperados antes de 16-04-2024. Para registros de emprego gerados antes de 16-04-2024, será necessário fazer uma nova solicitação POST para recuperar os registros de emprego e calcular as pontuações. Example: [{"score":722,"period":3,"version":"1.0.0"},{"score":612,"period":6,"version":"1.0.0"},{"score":570,"period":12,"version":"1.0.0"}] - `employment_scores.score` (integer,null) Uma pontuação entre 300 e 900 que fornece uma visão sobre a empregabilidade e o potencial de geração de renda. - Uma pontuação baixa (próxima de 300) pode indicar uma empregabilidade e potencial de geração de renda previstos mais baixos, sugerindo possíveis desafios para conseguir emprego ou alcançar níveis de renda mais altos no futuro. - Uma pontuação alta (próxima de 900) pode sugerir uma maior probabilidade de conseguir emprego e gerar níveis de renda mais altos. A pontuação pode retornar se o indivíduo não tiver histórico de emprego. Example: 612 - `employment_scores.period` (integer) O número de meses (no futuro) para os quais a pontuação é calculada. Por exemplo, um período de indica que a pontuação é calculada para os próximos meses. > : Atualmente, a Belvo calcula a pontuação para 3, 6 e 12 meses. Example: 6 - `employment_scores.version` (string) A versão do nosso modelo de pontuação de emprego usada para realizar o cálculo. Example: "1.0.0" - `files` (array,null) Arquivos binários PDF adicionais relacionados ao emprego do indivíduo. - `files.type` (string) O título do documento. Example: "ReporteSemanasCotizadas_190123" - `files.value` (string,null) O binário PDF do arquivo (como uma string). > : Em nosso ambiente sandbox, este campo retornará . Example: "=PDF_BINARY=" ## Response 403 fields (application/json): - `code` (string) Um código de erro único () que permite classificar e tratar o erro programaticamente. ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied. Example: "access_to_resource_denied" - `message` (string) Uma breve descrição do erro. Para erros , a descrição é: - . Example: "You don't have access to this resource." - `request_id` (string) Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 404 fields (application/json): - `code` (string) Um código de erro único () que permite classificar e lidar com o erro programaticamente. Example: "not_found" - `message` (string) Uma breve descrição do erro. Para erros , a descrição é: - Example: "Not found" - `request_id` (string) Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 408 fields (application/json): - `code` (string) Um código de erro único () que permite classificar e lidar com o erro programaticamente. ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout. Example: "request_timeout" - `message` (string) Uma breve descrição do erro. Para erros de , a descrição é: - . Example: "The request timed out, you can retry asking for less data by changing your query parameters" - `request_id` (string) Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 500 fields (application/json): - `code` (string) Um código de erro único () que permite classificar e tratar o erro de forma programática. ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error. Example: "unexpected_error" - `message` (string) Uma breve descrição do erro. Para erros , a descrição é: - . Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution" - `request_id` (string) Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações. Example: "9e7b283c6efa449c9c028a16b5c249fb"