Get position
Exibe a posição selecionada.
GET
Url Produção: https://api.acessorh.com.br
Url Homologação: https://api.rh.homolog.acesso.io
Endpoint:/v1/positions/:position
Headers
Key
Type
Description
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Path Parameters
Key
Type
Description
Query Parameters
Key
Type
Description
includes
string
Lista com os campos opcionais que podem ser visualizados separados por vírgula
Campos opcionais | includes
"role","benefits","department","persons","unit","attachments","decline"Exemplo de requisição
curl --location 'https://api.acessorh.com.br/v1/positions/UID DO CANDIDATO?includes=role%2Cbenefits%2Cdepartment%2Cpersons%2Cunit%2Cattachments%2Cdecline' \
--header 'Authorization: Bearer token de autorização' \
--data ''Exemplos de response
O retorno de todos metadados dos documentos e os paths dos arquivos anexados pelos candidatos é enviado na resposta do parâmetro "includes > persons" dentro de cada person do cadastro. Cada "kind" de documento tem uma estrutura diferente para o retorno dos metadados hardcoded (Padrão): Para a maioria dos documentos, como RG e CPF, as informações preenchidas pelo candidato são exibidas diretamente no campo data em um formato de chave-valor.
dictionary_specification (Dicionário): Documentos como os certificados (CPA-20, CEA, CGA) têm uma estrutura diferente. O campo data contém uma estrutura completa do documento, e os valores preenchidos pelo candidato estão aninhados no sub-objeto validator.
dynamic-document (Dinâmico): Este tipo, como o comprovante de Graduação, também armazena os dados no campo data, mas com uma estrutura que inclui um dicionário de valores (values) e uma lista de comprovantes.
Exemplo de resposta com todos os campos opcionais solicitados.
200 OK - Expandir para mais detalhes
{
"account": {
"address": null,
"address2": "",
"brand": {
"url": ""
},
"city": null,
"cnpj": null,
"district": "",
"email": null,
"id": "8eff6480-1e71-468b-ae4d-eefe3cd3e03d",
"name": "Disenchantment",
"org": "896ffd1d-a3a9-43df-a2e8-eed057fe40e6",
"phone_number": null,
"state": null,
"trading_name": null,
"zip_code": null
},
"admission_date": "2019-05-24T00:00:00Z",
"attachments": [
{
"category": "7e332162-a0e9-4aa1-bedd-dd485cc09a9e",
"file": {
"path": "organization/7c15017b-3c9f-45e9-9833-53fcc82247a8/attachments/category/7e332162-a0e9-4aa1-bedd-dd485cc09a9e/attachment/da047c0c-befc-462f-9035-09a9f7857302/68897c45-f4a1-4f80-81fa-a5ac4d37d6e7.png",
"mime": "image/png",
"size": 67329,
"name": "Captura de Tela 2022-01-12 às 12.39.17.png"
}
},
{
"category": "80405369-7beb-4f11-988f-49a9138e9e37",
"file": {
"path": "organization/7c15017b-3c9f-45e9-9833-53fcc82247a8/attachments/category/80405369-7beb-4f11-988f-49a9138e9e37/attachment/c478d866-4627-4b52-8d15-acd388da2a72/c861b4f4-b853-424e-8403-3d991f326914.png",
"mime": "image/png",
"size": 67329,
"name": "Captura de Tela 2022-01-12 às 12.39.17.png"
}
}
],
"benefits": null,
"cost_center": null,
"data_admissao": "0001-01-01T00:00:00Z",
"department": {
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"code": "",
"id": "4da70bb2-803c-4de5-81b7-c96423fb9127",
"name": "TI",
"safedoc": ""
},
"exame": {
"clinica": null,
"comprovante": {
"filename": null,
"id": null,
"mimetype": null,
"path": null
},
"data": null,
"hora": null,
"nome": null,
"observacoes": null
},
"dates": {
"limit_date": "2019-05-30T00:00:00Z",
"admission_date": "2019-05-24T00:00:00Z"
},
"id": "6f2c7be8-66a0-42c7-bb74-654236b8c3db",
"jornada": "",
"num_matricula": null,
"pagamento": {
"agente_integrador": null,
"data_inicio": null,
"data_termino": null,
"deficiencia": false,
"recorrencia": "mensalista",
"valor": 3500,
"vinculo": "clt"
},
"persons": [{
"personId": "50251e56-86fe-4311-a1f2-fc0a96d37772",
"personType": "candidate",
"personData": {
"nome": "John Doe",
"nomeSocial": null,
"sexo": "masculino",
"dataNascimento": "1987-07-09",
"etnia": "parda",
"estadoCivil": "casado",
"uniaoEstavel": null,
"celular": null,
"nacionalidade": null,
"tipoNacionalidade": "brasileiro",
"incapaz": null,
"nomeMae": "Melania Mickle",
"nomePai": null,
"aposentado": false,
"dataAposentadoria": null,
"numeroBeneficio": null,
"paisNascimento": null,
"paisOrigem": null,
"dataNaturalizacao": null,
"foto": {
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/person/brazil/f1849d41-baf8-48fd-85e5-1718099c6d47.png",
"mime": "image/png",
"size": 56060,
"name": "foto-perfil.png"
},
"order": 0,
"type": "selfie",
"view": null
}
},
"personCode": 200,
"candidate": {
"dependente": true,
"primeiroEmprego": null,
"filhosBrasileiros": false
},
"dependent": null,
"spouse": null,
"responsible": null,
"documents": [{
"id": "dd07f9c4-c76e-4024-a3f4-506692cb349d",
"type": "6d58e6f3-5501-40b3-b1fb-3e6949d19960",
"slug": "cpf",
"exist": true,
"additional": false,
"validations": null,
"title": {
"pt_BR": "CPF"
},
"code": 200,
"options": [],
"timestamp": "2019-05-23T19:07:53.717Z",
"data": {
"numero": "47779132951",
"comprovantes": [{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/6d58e6f3-5501-40b3-b1fb-3e6949d19960/362f2583-a537-4a99-9329-7b56ffb77bfa.jpg",
"mime": "image/jpeg",
"size": 298601,
"name": "cpf.jpg"
},
"order": 0,
"type": "frente",
"view": null
}]
}
},
{
"id": "19aa1b91-08a3-467f-83c5-03a19a657116",
"type": "32e00f6d-e847-4ac8-be6e-13b8c36b7a27",
"slug": "sus",
"exist": true,
"additional": false,
"validations": null,
"title": {
"pt_BR": "Cartão Nacional de Saúde"
},
"code": 200,
"options": [],
"timestamp": "2019-05-23T19:11:02.959Z",
"data": {
"numero": "934823995090006",
"comprovantes": [{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/32e00f6d-e847-4ac8-be6e-13b8c36b7a27/5850f673-4c1b-4421-9c1d-5ffb0b440954.jpg",
"mime": "image/jpeg",
"size": 2115913,
"name": "sus-verso.jpg"
},
"order": 1,
"type": "verso",
"view": null
},
{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/32e00f6d-e847-4ac8-be6e-13b8c36b7a27/eeeb2211-4aa5-40d5-ba6b-09d5d758b79a.jpg",
"mime": "image/jpeg",
"size": 26228,
"name": "sus-frente.jpg"
},
"order": 0,
"type": "frente",
"view": null
}
]
}
}
]
},
{
"personId": "bb9bf92d-0a80-4fb2-84e9-c3ed0e8b0c01",
"personType": "spouse",
"personData": {
"nome": "Lisbeth Madewell",
"nomeSocial": null,
"sexo": "feminino",
"dataNascimento": "1990-08-09",
"etnia": null,
"estadoCivil": null,
"uniaoEstavel": null,
"celular": null,
"nacionalidade": null,
"tipoNacionalidade": "brasileiro",
"incapaz": false,
"nomeMae": "Maria Madewell",
"nomePai": null,
"aposentado": null,
"dataAposentadoria": null,
"numeroBeneficio": null,
"paisNascimento": null,
"paisOrigem": "",
"dataNaturalizacao": null,
"foto": null
},
"personCode": 200,
"candidate": null,
"dependent": null,
"spouse": {
"relacionamento": "casado",
"dependente": true,
"dataCasamento": "2013-05-23"
},
"responsible": null,
"documents": [{
"id": "834ab6af-9c14-456a-8cde-1b2dfe21d681",
"type": "6d58e6f3-5501-40b3-b1fb-3e6949d19960",
"slug": "cpf",
"exist": true,
"additional": false,
"validations": null,
"title": {
"pt_BR": "CPF"
},
"code": 200,
"options": [],
"timestamp": "2019-05-23T19:13:53.927Z",
"data": {
"numero": "57435244082",
"comprovantes": [{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/6d58e6f3-5501-40b3-b1fb-3e6949d19960/a2c7b76a-b9fd-4992-ae32-157b7bb2c97f.jpg",
"mime": "image/jpeg",
"size": 298601,
"name": "cpf.jpg"
},
"order": 0,
"type": "frente",
"view": null
}]
}
},
{
"id": "d77497ca-1a9e-49ef-944e-532b5ae6fd60",
"type": "c2069ecf-ea5d-4029-9960-6f802392c6d7",
"slug": "rg",
"exist": true,
"additional": false,
"validations": null,
"title": {
"pt_BR": "RG"
},
"code": 200,
"options": [],
"timestamp": "2019-05-23T19:13:54.124Z",
"data": {
"numero": "438902853",
"orgaoEmissor": null,
"uf": null,
"dataExpedicao": null,
"naturalidadeEstado": null,
"naturalidadeCidade": null,
"filiacao1": "Maria Madewell",
"filiacao2": "",
"comprovantes": [{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/c2069ecf-ea5d-4029-9960-6f802392c6d7/9b9b820f-8cfc-48bc-b51e-5930d44578fc.jpg",
"mime": "image/jpeg",
"size": 1940441,
"name": "rg-verso.jpg"
},
"order": 1,
"type": "verso",
"view": null
},
{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/c2069ecf-ea5d-4029-9960-6f802392c6d7/7c31f607-0477-4318-aacf-be7627695061.jpg",
"mime": "image/jpeg",
"size": 1960026,
"name": "rg-frente.jpg"
},
"order": 0,
"type": "frente",
"view": null
}
]
}
},
{
"id": "d6fdd271-866f-4b4c-a233-30c392bf8828",
"type": "32e00f6d-e847-4ac8-be6e-13b8c36b7a27",
"slug": "sus",
"exist": true,
"additional": false,
"validations": null,
"title": {
"pt_BR": "Cartão Nacional de Saúde"
},
"code": 200,
"options": [],
"timestamp": "2019-05-23T19:13:54.031Z",
"data": {
"numero": "256902775310001",
"comprovantes": [{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/32e00f6d-e847-4ac8-be6e-13b8c36b7a27/1ab7a5cb-d4c0-4a68-bd2d-c636cdb81fb1.jpg",
"mime": "image/jpeg",
"size": 2115913,
"name": "sus-verso.jpg"
},
"order": 1,
"type": "verso",
"view": null
},
{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/32e00f6d-e847-4ac8-be6e-13b8c36b7a27/dd9fbe09-3f23-41c9-b500-aa9c7a08c2e6.jpg",
"mime": "image/jpeg",
"size": 26228,
"name": "sus-frente.jpg"
},
"order": 0,
"type": "frente",
"view": null
}
]
}
},
{
"id": "712d1eba-9407-43cd-8127-2786aa3d07ef",
"type": "7dff436c-d450-4a75-8af5-7934ab1bb71c",
"slug": "certidao-casamento",
"exist": true,
"additional": false,
"validations": null,
"title": {},
"code": 200,
"options": [],
"timestamp": "2019-05-23T19:13:53.191Z",
"data": {
"comprovantes": [{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/7dff436c-d450-4a75-8af5-7934ab1bb71c/ba97e8c6-2b2c-42e0-b790-a82f4e71694c.jpg",
"mime": "image/jpeg",
"size": 2277398,
"name": "nascimento.jpg"
},
"order": 0,
"type": "frente",
"view": null
}]
}
}
]
},
{
"personId": "bb9bf92d-0a80-4fb2-84e9-c3ed0e8b0c01",
"personType": "dependent",
"personData": {
"nome": "Lisbeth Madewell",
"nomeSocial": null,
"sexo": "feminino",
"dataNascimento": "1990-08-09",
"etnia": null,
"estadoCivil": null,
"uniaoEstavel": null,
"celular": null,
"nacionalidade": null,
"tipoNacionalidade": "brasileiro",
"incapaz": false,
"nomeMae": "Maria Madewell",
"nomePai": null,
"aposentado": null,
"dataAposentadoria": null,
"numeroBeneficio": null,
"paisNascimento": null,
"paisOrigem": "",
"dataNaturalizacao": null,
"foto": null
},
"personCode": 200,
"candidate": null,
"dependent": {
"parentesco": "conjuge",
"naoPossuiRg": null,
"ensinoSuperior": null,
"impostoRenda": true,
"salarioFamilia": false
},
"spouse": null,
"responsible": null,
"documents": [{
"id": "834ab6af-9c14-456a-8cde-1b2dfe21d681",
"type": "6d58e6f3-5501-40b3-b1fb-3e6949d19960",
"slug": "cpf",
"exist": true,
"additional": false,
"validations": null,
"title": {
"pt_BR": "CPF"
},
"code": 200,
"options": [],
"timestamp": "2019-05-23T19:13:53.927Z",
"data": {
"numero": "57435244082",
"comprovantes": [{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/6d58e6f3-5501-40b3-b1fb-3e6949d19960/a2c7b76a-b9fd-4992-ae32-157b7bb2c97f.jpg",
"mime": "image/jpeg",
"size": 298601,
"name": "cpf.jpg"
},
"order": 0,
"type": "frente",
"view": null
}]
}
},
{
"id": "d77497ca-1a9e-49ef-944e-532b5ae6fd60",
"type": "c2069ecf-ea5d-4029-9960-6f802392c6d7",
"slug": "rg",
"exist": true,
"additional": false,
"validations": null,
"title": {
"pt_BR": "RG"
},
"code": 200,
"options": [],
"timestamp": "2019-05-23T19:13:54.124Z",
"data": {
"numero": "438902853",
"orgaoEmissor": null,
"uf": null,
"dataExpedicao": null,
"naturalidadeEstado": null,
"naturalidadeCidade": null,
"filiacao1": "Maria Madewell",
"filiacao2": "",
"comprovantes": [{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/c2069ecf-ea5d-4029-9960-6f802392c6d7/9b9b820f-8cfc-48bc-b51e-5930d44578fc.jpg",
"mime": "image/jpeg",
"size": 1940441,
"name": "rg-verso.jpg"
},
"order": 1,
"type": "verso",
"view": null
},
{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/c2069ecf-ea5d-4029-9960-6f802392c6d7/7c31f607-0477-4318-aacf-be7627695061.jpg",
"mime": "image/jpeg",
"size": 1960026,
"name": "rg-frente.jpg"
},
"order": 0,
"type": "frente",
"view": null
}
]
}
},
{
"id": "d6fdd271-866f-4b4c-a233-30c392bf8828",
"type": "32e00f6d-e847-4ac8-be6e-13b8c36b7a27",
"slug": "sus",
"exist": true,
"additional": false,
"validations": null,
"title": {
"pt_BR": "Cartão Nacional de Saúde"
},
"code": 200,
"options": [],
"timestamp": "2019-05-23T19:13:54.031Z",
"data": {
"numero": "256902775310001",
"comprovantes": [{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/32e00f6d-e847-4ac8-be6e-13b8c36b7a27/1ab7a5cb-d4c0-4a68-bd2d-c636cdb81fb1.jpg",
"mime": "image/jpeg",
"size": 2115913,
"name": "sus-verso.jpg"
},
"order": 1,
"type": "verso",
"view": null
},
{
"file": {
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/document/32e00f6d-e847-4ac8-be6e-13b8c36b7a27/dd9fbe09-3f23-41c9-b500-aa9c7a08c2e6.jpg",
"mime": "image/jpeg",
"size": 26228,
"name": "sus-frente.jpg"
},
"order": 0,
"type": "frente",
"view": null
}
]
}
}
]
}
],
"position_number": "1234890",
"profile": {
"email": "[email protected]",
"id": "50251e56-86fe-4311-a1f2-fc0a96d37772",
"mobile": "11911111111",
"name": "John Doe",
"photo": {
"filename": "foto-perfil.png",
"id": "f1849d41-baf8-48fd-85e5-1718099c6d47",
"mimetype": "image/png",
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/person/brazil/f1849d41-baf8-48fd-85e5-1718099c6d47.png"
}
},
"role": {
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"cbo": "",
"code": "",
"escolaridade_min": "",
"id": "1f67b9f3-314f-45a5-b098-7ec236c6c963",
"index": null,
"name": "Analista Programador",
"safedoc": ""
},
"decline": {
"type": "DECLINED_BY_USER",
"reason": "motivos-pessoais",
"description": "descricao",
"message": "candidato declinou da posicao",
"creationDate": "31/03/2023 16:43:40"
},
"status": {
"code": 240,
"name": "completed"
},
"track_status": [{
"Code": 220,
"Ts": "2019-05-23T19:04:03.68Z"
},
{
"Code": 240,
"Ts": "2019-05-23T19:18:00.07Z"
}
],
"updated": "2019-05-23T19:18:00.07Z",
"validation": {
"esocial": {
"approved": false
}
}
}Exemplo de tipo de deficiência para candidatos PCD
200 OK
{
"timestamp": "2025-10-06T14:45:49.418Z",
"schema": null,
"type": "313c92f4-f293-4849-bba5-3083960b24cf",
"id": "XXXXXXX-ce73-434f-ab4f-XXXXXXX",
"slug": "laudo-medico",
"kind": "hardcoded",
"validations": null,
"title": {
"pt_BR": "Exame médico PCD"
},
"options": [],
"code": 120,
"exist": true,
"goToAnalysis": true,
"additional": false,
"data": {
"deficiencias": [
"paraplegia",
"unilateral",
"baixa_visao",
"comunicacao",
"paraparesia",
"monoplegia",
"monoparesia",
"tetraplegia",
"tetraparesia",
"triplegia",
"triparesia",
"hemiplegia",
"hemiparesia",
"ostomia",
"amp_ausencia_membro",
"paralisia_cerebral",
"nanismo",
"deformidade_cong_adqu",
"bilateral",
"cegueira",
"soma_camp_vis_igual_ou_inf_60",
"monocular",
"trabalho",
"media_lazer",
"hab_academica",
"saude_seguran",
"util_rec_comu",
"habl_social",
"cuidado_pesso",
"reabilitado_inss"
],Atualizado
Isto foi útil?