> For the complete documentation index, see [llms.txt](https://acessorh.gitbook.io/project/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://acessorh.gitbook.io/project/api/posicoes.md).

# Posições

Posições são as vagas, convites para os candidatos iniciarem o preenchimento do *"application"*  (formulário). A criação da posição é uma replica do preenchimento no Dashboard, passando as informações básicas para a identificação do candidato e geração do check-list.

Caso utilize as funcionalidades de Guia de Exame Médico e Carta de Abertura de Conta Bancária, será necessário antes criá-las através da chamada de [Upload de Arquivos](/project/api/arquivos.md) e então referenciar seus UIDs nos campos de Guia e Carta.

## Create position

<mark style="color:green;">`POST`</mark> `https://api.acessorh.com.br/v1/account/:unit/json/position`

Cria uma posição na filial selecionada.

#### Path Parameters

| Name | Type   | Description                               |
| ---- | ------ | ----------------------------------------- |
| unit | string | UID da filial onde a posição será criada. |

#### Headers

| Name          | Type   | Description                                                   |
| ------------- | ------ | ------------------------------------------------------------- |
| Authorization | string | Token de acesso adquirido pela plataforma Identity (*bearer*) |

{% tabs %}
{% tab title="200 " %}

```javascript
"ok"
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
Caso a requisição seja realizada com sucesso, o header `position-id`, contendo o UID da position criada, será enviado na resposta.
{% endhint %}

* [Descrição do body JSON da request](/project/api/posicoes.md#descricao-do-body-json-da-request)
* [Exemplo de requisição](/project/api/posicoes.md#exemplo-de-requisicao)

### Descrição do body JSON da request

| Chave                                                                                                                                              | Tipo                         | Descrição                                                                          |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ---------------------------------------------------------------------------------- |
| <p><strong>num\_matricula</strong></p><p>optional</p>                                                                                              | string                       | Número da matrícula                                                                |
| <p><strong>limit\_date</strong></p><p><em>required</em></p>                                                                                        | string, format("YYYY-mm-dd") | Data limite para o preenchimento do cadastro                                       |
| <p><strong>admission\_date</strong></p><p><em>optional</em></p>                                                                                    | string, format("YYYY-mm-dd") | Data de admissão                                                                   |
| <p><strong>cost\_center</strong></p><p><em>optional</em></p>                                                                                       | string                       | Centro de custo                                                                    |
| <p><strong>pos\_number</strong></p><p><em>optional</em></p>                                                                                        | string                       | Número da posição                                                                  |
| <p><strong>role</strong></p><p><em>required</em></p>                                                                                               | string                       | UID ou código do cargo indicado para a vaga                                        |
| <p><strong>department</strong></p><p><em>required</em></p>                                                                                         | string                       | UID ou código do departamento indicado para a vaga                                 |
| <p><a href="/pages/-Lch6l0paus90ymSyWPz#pagamento"><strong>pagamento</strong></a></p><p><em>required</em></p>                                      | object                       | Informações sobre o pagamento                                                      |
| <p><strong>deficiencia</strong></p><p><em>required</em></p>                                                                                        | boolean                      | Indica se a vaga é PCD                                                             |
| <p><strong>jornada</strong></p><p><em>optional</em></p>                                                                                            | string                       | Informações sobre a jornada de trabalho                                            |
| <p><a href="/pages/-Lch6l0paus90ymSyWPz#profile"><strong>profile</strong></a></p><p><em>required</em></p>                                          | object                       | Informações de contato do candidato                                                |
| <p><a href="#exame"><strong>exame</strong></a></p><p><em>optional</em></p>                                                                         | object                       | Informações sobre o agendamento de exame médico                                    |
| <p><a href="https://acessorh.gitbook.io/project/v/v2/referencias/documentos/brasil-1/brasil"><strong>docs</strong></a></p><p><em>optional</em></p> | array\[string]               | UIDs dos documentos adicionais a serem solicitados para a vaga                     |
| **benefits**                                                                                                                                       | array\[string]               | UIDs dos grupos de benefícios.(Obs.: Deverá ter apenas um por categoria.)          |
| <p><strong>send\_sms</strong></p><p><em>required</em></p>                                                                                          | boolean                      | Indica a necessidade do envio da notificação para o candidato através de um SMS    |
| <p><strong>send\_email</strong></p><p><em>required</em></p>                                                                                        | boolean                      | Indica a necessidade do envio da notificação para o candidato através de um e-mail |

#### Pagamento

| Chave                                                                                                                  | Tipo                                                                    | Descrição                                                       |
| ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------- |
| <p><strong>vinculo</strong></p><p><em>required</em></p>                                                                | string ([options](/project/api/posicoes.md#opcoes-de-vinculo))          | Vínculo empregatício                                            |
| <p><strong>valor</strong></p><p><em>optional\*</em></p>                                                                | string                                                                  | Valor da remuneração                                            |
| <p><strong>recorrencia</strong></p><p><em>optional\*</em></p>                                                          | string ([options](/project/api/posicoes.md#opcoes-de-recorrencia))      | Recorrência do pagamento                                        |
| <p><strong>dataInicio</strong></p><p><em>optional</em></p>                                                             | string, format("YYYY-mm-dd")                                            | Data de início do contrato de estágio ou aprendiz               |
| <p><strong>dataTermino</strong></p><p><em>optional</em></p>                                                            | string, format("YYYY-mm-dd")                                            | Data de término do contrato de estágio ou aprendiz              |
| <p><strong>agenteIntegrador</strong></p><p><em>optional</em></p>                                                       | string([options](/project/api/posicoes.md#opcoes-de-agente-integrador)) | Agente integrador do contrato de estágio ou aprendiz            |
| <p><a href="/pages/-Lch6l0paus90ymSyWPz#conta-bancaria"><strong>contaBancaria</strong></a></p><p><em>optional</em></p> | object                                                                  | Dados referentes à  configuração de cartas de abertura de conta |

{% hint style="info" %}
Os campos de `recorrencia` e de `valor` são interdependentes. Caso um seja preenchido o outro se torna *required*.
{% endhint %}

#### Opções de vínculo

```
"clt", "estagio", "aprendiz", "autonomo", "temporario", "verde-amarelo", "intermitente", "estatuario"
```

#### Opções de recorrência

```
"horista", "mensalista", "aulista", "comissionista", "diarista"
```

#### Opções de agente integrador

```
"ciee", "nube", "senai", "senac", "mudes", "coep", "rede_cidada", "espro", "guarda_mirim", "iel", "iaq", "apae_jo_clemente", "gerar_guarapuva_ponta", "instituto_ser", "perfil_talentos", "pestalozzi", "renapsi", "elo", "pastoral", "via_de_acesso", "geec", "outros"
```

#### Conta bancária

| Chave                                                      | Tipo                                                        | Descrição                                                      |
| ---------------------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------- |
| <p><strong>banco</strong></p><p><em>required</em></p>      | string([options](/project/api/posicoes.md#opcoes-de-banco)) | Código do banco do qual a carta de abertura de conta se refere |
| <p><strong>carta</strong></p><p><em>optional\*</em></p>    | string                                                      | UID do arquivo contendo a carta de abertura de conta           |
| <p><strong>template</strong></p><p><em>optional\*</em></p> | string                                                      | UID do modelo de abertura de conta                             |

{% hint style="info" %}
Caso queira criar a posição com uma carta de abertura de conta anexada, é necessário realizar o seu upload antes.

Apenas uma opção deve ser escolhida: carta ou template.

O ID do modelo de carta pode ser encontrado no próprio módulo de criação dentro do Acesso RH.
{% endhint %}

#### Opções de banco

```
"001", "033", "041", "047", "104", "151", "237", "341", "399", "735", "745", "748", "755"
```

#### Profile

| Chave                                                  | Tipo                          | Descrição                      |
| ------------------------------------------------------ | ----------------------------- | ------------------------------ |
| <p><strong>name</strong></p><p><em>required</em></p>   | string                        | Nome do candidato              |
| <p><strong>email</strong></p><p><em>required</em></p>  | string                        | E-mail do candidato            |
| <p><strong>mobile</strong></p><p><em>required</em></p> | string, format("11911111111") | Número do celular do candidato |

#### Exame

| Chave                                                   | Tipo                         | Descrição                                      |
| ------------------------------------------------------- | ---------------------------- | ---------------------------------------------- |
| <p><strong>clinica</strong></p><p><em>required</em></p> | string                       | UID ou código da clínica                       |
| <p><strong>data</strong></p><p><em>optional</em></p>    | string, format("YYYY-mm-dd") | Data do agendamento                            |
| <p><strong>hora</strong></p><p><em>optional</em></p>    | string, format("HH:MM")      | Hora do agendamento                            |
| <p><strong>obs</strong></p><p><em>optional</em></p>     | string                       | Observações do agendamento                     |
| <p><strong>guia</strong></p><p><em>optional\*</em></p>  | string                       | UID do arquivo contendo a guia do exame médico |

{% hint style="info" %}
**Obs:** Os campos *data, hora e obs,* não são obrigatórios mas é indicado que eles sejam preenchidos pois são essas informações que serão disponibilizadas para os candidatos no momento do preenchimento da vaga.\
\
\&#xNAN;**\*guia:** Caso queira criar a posição com uma guia de exame médico anexada, é necessário realizar o seu upload antes.
{% endhint %}

### Exemplo de requisição

```javascript
{
  "num_matricula": "4242424",
  "limit_date": "2018-01-01",
  "admission_date": "2018-01-01",
  "cost_center": "anywhere",
  "pos_number": "pos-test",
  "role": "b63e065f-d7e0-49e1-91b7-88f74516e3fe",
  "department": "bf559996-a8b9-4f5e-af57-86111b0dbde3",
  "pagamento": {
    "vinculo": "clt",
    "valor": "4200",
    "recorrencia": "mensalista",
    "contaBancaria": {
      "banco": "001",
      "carta": "c9160763-db6c-4e8c-a1ad-ad8709c99be2"
    }
  },
  "deficiencia": false,
  "jornada": "De segunda a sexta das 15 as 19",
  "profile": {
    "name": "John Doe",
    "email": "john.doe@acessodigital.com.br",
    "mobile": "11911111111"
  },
  "exame": {
    "clinica": "6dc84ce4-7d9f-48ec-b9b1-a8a895a21fd4",
    "data": "2018-01-01",
    "hora": "14:00",
    "obs": "Comparecer de manhã",
    "guia": "e37dab24-c7a4-4b92-b9d1-32ed538b8300",
  },
  "docs": ["c9e26093-5e0c-4bd2-bea3-ac5182a6179f"],
  "send_sms": true,
  "send_email": true
}
```

## Get position

<mark style="color:blue;">`GET`</mark> `https://api.acessorh.com.br/v1/positions/:position`

Exibe a posição selecionada.

#### Path Parameters

| Name                                       | Type   | Description                       |
| ------------------------------------------ | ------ | --------------------------------- |
| position<mark style="color:red;">\*</mark> | string | UID ou código da posição desejada |

#### Query Parameters

| Name                                   | Type   | Description                                                                                         |
| -------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| unit<mark style="color:red;">\*</mark> | string | UID da filial do qual a posição pertence                                                            |
| includes                               | string | Lista com os [campos opcionais ](#campos-opcionais)que podem ser visualizados separados por vírgula |

#### Headers

| Name                                            | Type   | Description                                                   |
| ----------------------------------------------- | ------ | ------------------------------------------------------------- |
| Authorization<mark style="color:red;">\*</mark> | string | Token de acesso adquirido pela plataforma Identity *(bearer)* |

{% tabs %}
{% tab title="200 Exemplo com todos os campos opcionais solicitados" %}

```
{
    "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": "john.doe@acessodigital.com.br",
        "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
        }
    }
}
```

{% endtab %}
{% endtabs %}

#### Campos opcionais | includes

```
"role","benefits","department","persons","unit","attachments","decline"
```

## List positions

<mark style="color:blue;">`GET`</mark> `https://api.acessorh.com.br/v1/positions`

Lista posições na empresa ou filial selecionada.

#### Query Parameters

| Name             | Type   | Description                                                                                                                     |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------- |
| admission\_date  | string | <p>Data de admissão início e fim<br>Formato: <strong>AAAA-MM-DD,AAAA-MM-DD</strong></p>                                         |
| acc              | string | UID da empresa ou da filial que será filtrada                                                                                   |
| status           | string | Filtro de [status](#lista-de-status) das posições                                                                               |
| position\_number | string | Código da posição desejada                                                                                                      |
| limit            | string | Limite de posições que serão listadas (paginação)                                                                               |
| skip             | string | Indica a quantidade de posições que serão puladas (paginação)                                                                   |
| sort             | string | Configura um parâmetro de ordenação do resultado da listagem de posições com base nas [opções](#opcoes-ordenacao-das-posicoes). |
| order            | string | Ordena o resultado de forma crescente e decrescente (["asc" e "desc"](#undefined)).                                             |

#### Headers

| Name          | Type   | Description                                                   |
| ------------- | ------ | ------------------------------------------------------------- |
| Authorization | string | Token de acesso adquirido pela plataforma Identity *(bearer)* |

{% tabs %}
{% tab title="200 " %}

```javascript
{
    "offset": 0,
    "limit": 100,
    "count": 1,
    "positions": [
        {
            "admission_date": "2019-05-17T00:00:00Z", //deprecated
            "cost_center": "anywhere",
            "exame": {
                "clinica": "bcaaf3a8-b682-4809-83a7-83a73e867cb6",
                "comprovante": {
                    "filename": "exame.jpg",
                    "id": "5f0676ab-648a-4c3f-92c7-eedd1802d719",
                    "mimetype": "image/jpeg",
                    "path": "organization/896ffd1d-a3a9-43df-a2e8-eed057fe40e6/position/9e70b644-fce0-442a-af8a-40b00cbbb437/context/brazil/exame/5f0676ab-648a-4c3f-92c7-eedd1802d719.jpg"
                },
                "data": "2019-05-11T00:00:00Z",
                "hora": "2006-01-02T13:04:00Z",
                "nome": "Clinica Saude",
                "observacoes": "chegar cedo"
            },
            "id": "e8efddec-4a9e-4153-9e61-ce0056edf542",
            "jornada": "De segunda a sexta das 15 as 19",
            "num_matricula": "4242424",
            "pagamento": {
                "agente_integrador": null,
                "data_inicio": null,
                "data_termino": null,
                "deficiencia": false,
                "recorrencia": "mensalista",
                "valor": 4200,
                "vinculo": "clt"
            },
            "position_number": "pos-test",
            "profile": {
                "email": "john.doe@acessodigital.com.br",
                "id": "72421b50-c882-4684-8e10-c5a0522978e1",
                "mobile": "11991111111",
                "name": "John Doe",
                "photo": {
                    "filename": "foto-perfil.png",
                    "id": "c8d1c2a7-75d2-4615-a9e1-d93bd09570b6",
                    "mimetype": "image/png",
                    "path": "individual/23beac75-4722-4e14-96a4-72f69322471e/person/brazil/c8d1c2a7-75d2-4615-a9e1-d93bd09570b6.png"
                }
            },
            "decline": {
                "type": "DECLINED_BY_HR",
                "reason": "sem-retorno-candidato",
                "description": "descricao",
                "message": "declinado pela empresa",
                "creationDate": "31/03/2023 16:42:44"
            },
            "dates": {
                "limit_date": "2019-05-30T00:00:00Z",
                "admission_date": "2019-05-17T00:00:00Z"
            },
            "status": {
                "code": 501,
                "name": "decline"
            },
            "updated": "2019-04-23T18:10:16.892Z"
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
Caso não seja inserido os parâmetros `limit` e `skip` , os valores padrões serão, respectivamente, 100 e 0.

O parâmetro `limit` tem o seu valor máximo como 100.
{% endhint %}

#### Parâmetros para ordenação das posições

| Chave           | Tipo   | Descrição                                        |
| --------------- | ------ | ------------------------------------------------ |
| limit\_date     | string | Data limite para o preenchimento do cadastro.    |
| admission\_date | string | Data de admissão preenchida no cadastro da vaga. |
| created\_date   | string | Data em que o cadastro foi criado.               |
| updated\_date   | string | Ultima data de atualização do cadastro.          |
| completed\_date | string | Data de finalização do cadastro.                 |

#### Opções de ordenação

| Chave | Tipo   | Descrição                    |
| ----- | ------ | ---------------------------- |
| asc   | string | Ordena de forma crescente.   |
| desc  | string | Ordena de forma decrescente. |

#### Lista de status

```
210 - "invited" (posição criada e convite enviado para o candidato)
220 - "pending" (candidato iniciou o processo de admissão, mas ainda não finalizou a entrega dos documentos)
230 - "review" (posição já analisada pela mesa, mas pendente de correção pelo candidato)
240 - "completed" (todos os documentos entregues, aguardando análise da mesa)
400 - "active" (documentos entregues e validados ou posição completada manualmente pelo RH)
500 - "dismissal/archived" (posição arquivada pelo RH)
501 - "declined" (posições declinadas pelo RH)
```

{% file src="/files/-MB5VqmzhR1pBJ\_P\_l9W" %}
Descritivo dos campos
{% endfile %}

## Change status

<mark style="color:orange;">`PUT`</mark> `https://api.acessorh.com.br/v1/positions/status/:position`

Altera o status de uma posição.

#### Path Parameters

| Name                                       | Type   | Description                             |
| ------------------------------------------ | ------ | --------------------------------------- |
| position<mark style="color:red;">\*</mark> | string | UID ou código da posição a ser alterada |

#### Headers

| Name                                            | Type   | Description                                                    |
| ----------------------------------------------- | ------ | -------------------------------------------------------------- |
| Authorization<mark style="color:red;">\*</mark> | string | Token de acesso adquirido  pela plataforma Identity *(bearer)* |

{% tabs %}
{% tab title="200 " %}

```javascript
"ok"
```

{% endtab %}
{% endtabs %}

* [Descrição do body JSON da request](/project/api/posicoes.md#descricao-do-body-json-da-request-1)
* [Exemplo de requisição](/project/api/posicoes.md#exemplo-de-requisicao-1)

### Descrição do body JSON da request

| Chave                                                     | Tipo                                                         | Descrição                                                                                                                                                                                                                      |
| --------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <p><strong>unit</strong></p><p><em>required</em></p>      | string                                                       | UID da filial do qual a posição pertence                                                                                                                                                                                       |
| <p><strong>status</strong></p><p><em>required</em></p>    | string([options](/project/api/posicoes.md#opcoes-de-status)) | Status no qual a posição será alterada                                                                                                                                                                                         |
| <p><strong>decline</strong></p><p><em>optional</em>\*</p> | [object](#campo-decline)                                     | <p>Decline é a estrutura com as informações dos motivos de declínio da posição.<br><br>\*Esse campo é <em><strong>required</strong></em> apenas quando o campo de <strong>status</strong> for igual a "<em>declined</em>".</p> |

#### Opções de status

```
"completed", "archived", "declined"
```

{% hint style="warning" %}

* A posição só poderá ser arquivada, se ela já estiver completa ou declinada.
* Não é possível declinar posições que estão arquivadas.
  {% endhint %}

### Campo decline

<table><thead><tr><th>Chave</th><th width="148.33333333333331">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>type</strong><br><em>required</em></td><td>string</td><td>Indica qual foi o lado responsável por decidir declinar do processo de admissão:<br><br>Candidato (<em>DECLINED_BY_USER</em>) Empresa (<em>DECLINED_BY_HR</em>)</td></tr><tr><td><strong>reason</strong><br><em>required</em></td><td>string(<a href="#tipos-de-declinio-com-seus-respectivos-motivos">options</a>)</td><td>Motivo que levou essa posição a ser declinada.<br><br>Os motivos devem está de acordo com o <strong>type</strong> indicado. </td></tr><tr><td><strong>description</strong><br><em>optio</em>nal</td><td>string</td><td>Detalhes do motivo que levou essa posiçao ser declinada.</td></tr><tr><td><strong>message</strong><br><em>optional</em></td><td>string</td><td>Mensagem customizada que fará parte do e-mail que será enviada para o candidato que teve sua posição declinada.</td></tr></tbody></table>

#### Tipos de declínio com seus respectivos motivos

{% tabs %}
{% tab title="DECLINED\_BY\_HR" %}

| REASONS \| DECLINED\_BY\_HR |
| --------------------------- |
| sem-retorno-candidato       |
| falta-documento             |
| escolaridade-inferior       |
| sem-vacina-covid            |
| outro                       |
| {% endtab %}                |

{% tab title="DECLINED\_BY\_USER" %}

| REASONS \| DECLINED\_BY\_USER |
| ----------------------------- |
| motivos-pessoais              |
| proposta-melhor               |
| nao-tem-interesse             |
| sem-retorno                   |
| outro                         |
| {% endtab %}                  |
| {% endtabs %}                 |

### Exemplo de requisição

```javascript
{
	"unit": "84ef8cd7-76ee-4b10-a77b-e0201cdcd117",
	"status": "declined",
        "decline":{
            "type": "DECLINED_BY_HR",
            "reason": "falta-documento",
            "description": "descrição",
            "message":"messagem de declino para o candidato",
        }
}
```

## Delete position

<mark style="color:red;">`DELETE`</mark> `https://api.acessorh.com.br/v1/positions`

Deleta uma posição.

#### Query Parameters

| Name | Type   | Description                                    |
| ---- | ------ | ---------------------------------------------- |
| uid  | string | UID da posição a ser deletada.                 |
| unit | string | UID da filial de onde a posição será deletada. |

#### Headers

| Name          | Type   | Description                                                    |
| ------------- | ------ | -------------------------------------------------------------- |
| Authorization | string | Token de acesso adquirido pela plataforma Identity *(bearer)*. |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Set benefits in a position

<mark style="color:purple;">`PATCH`</mark> `https://api.acessorh.com.br/v1/positions/:position/benefits`

Adiciona e/ou remove benefícios de uma posição

#### Path Parameters

| Name     | Type   | Description                             |
| -------- | ------ | --------------------------------------- |
| position | string | UID ou número da posição a ser alterada |

#### Headers

| Name          | Type   | Description                                                   |
| ------------- | ------ | ------------------------------------------------------------- |
| Authorization | string | Token de acesso adquirido pela plataforma Identity *(bearer)* |

{% tabs %}
{% tab title="200 " %}

```
"ok"
```

{% endtab %}
{% endtabs %}

* [Descrição do body JSON da request](/project/api/posicoes.md#descricao-do-body-json-da-request-2)
* [Exemplo de requisição](/project/api/posicoes.md#exemplo-de-requisicao-2)

### Descrição do body JSON da request

| Chave                                                  | Tipo           | Descrição                                                                |
| ------------------------------------------------------ | -------------- | ------------------------------------------------------------------------ |
| <p><strong>unit</strong></p><p><em>required</em></p>   | string         | UID da filial onde a posição se encontra                                 |
| <p><strong>add</strong></p><p><em>optional</em></p>    | array\[string] | <p>UIDs dos grupos de benefícios a serem <br>adicionadas na posição</p>  |
| <p><strong>remove</strong></p><p><em>optional</em></p> | array\[string] | <p>UIDs dos grupos de benefícios a serem </p><p>removidos da posição</p> |

{% hint style="warning" %}

* Um dos campos `add` ou `remove` deverão ser preenchidos.
* Não é possível adicionar ou remover benefícios para  posições *declinadas*
  {% endhint %}

### Exemplo de requisição

```javascript
{
    "unit": "4bdaa0d3-f3e4-4520-b64e-6a22508bebc9",
    "add": ["c4c17fd1-9c93-4dbf-bca8-bded7fd97287"],
    "remove": ["87a6e88f-c318-416b-830e-8cf446f535fe"]
}
```

## Creates document to send the admission kit

<mark style="color:green;">`POST`</mark> `https://api.acessorh.com.br/v1/positions/:position_id/signature-envelopes`

Realiza o envio do kit admissional para candidatos concluídos.

#### Path Parameters

| Name         | Type   | Description                                                                     |
| ------------ | ------ | ------------------------------------------------------------------------------- |
| position\_id | string | <p>UID da posição que deve <br>receber o kit de documentos para assinatura.</p> |

{% tabs %}
{% tab title="200 " %}

```
{
    "code": 200,
    "messages": null,
    "result": {
        "uid": "6416fc22-4953-43d0-8db6-c96a908cf574"
    },
    "status": "ok"
}
```

{% endtab %}
{% endtabs %}

### Descrição do body JSON da request

| Chave                                                   | Tipo           | Descrição                                                                                                   |
| ------------------------------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------- |
| <p><strong>account</strong></p><p><em>required</em></p> | string         | UID da empresa.                                                                                             |
| <p><strong>unit</strong></p><p><em>required</em></p>    | string         | <p>UID da filial onde a <br>posição se encontra.</p>                                                        |
| <p><strong>models</strong></p><p><em>required</em></p>  | array\[string] | <p>Lista com os UID dos</p><p>modelos de documentos</p><p>que devem ser enviados</p><p>para assinatura.</p> |

{% hint style="warning" %}
Não é possível enviar o kit admissional para posições:

* Em andamento
* Arquivadas
* Declinadas
  {% endhint %}

### Exemplo de requisição

```javascript
{
    "account": "4aca3203-e791-41e1-b5d7-6ef02d152787",
    "unit": "8eff6480-1e71-468b-ae4d-eefe3cd3e03d",
    "models": [
       "8946efe8-e100-4497-907e-3803bb048b47",
       "62766bb0-b5ac-4462-8478-062950577067"
    ]
}
```

## Get Position Invite

<mark style="color:blue;">`GET`</mark> `https://api.acessorh.com.br/v1/admissions/invite/:pos`

Exibe os link's do convite enviado para a posição iniciar o processo de cadastro dos documentos.

#### Path Parameters

| Name                                  | Type   | Description              |
| ------------------------------------- | ------ | ------------------------ |
| pos<mark style="color:red;">\*</mark> | string | UID  da posição desejada |

#### Headers

| Name          | Type   | Description                                                   |
| ------------- | ------ | ------------------------------------------------------------- |
| Authorization | string | Token de acesso adquirido pela plataforma Identity *(bearer)* |

{% tabs %}
{% tab title="200 Exemplo " %}

```
{
    "data": {
        "expiresAt": "2022-02-06 17:17:55",
        "longURL": "hhttps://form.rh.qa2.acesso.dev/profile/intro/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraW5kIjoiYWRtaXNzaW9uIiwib3JnIjoiN2MxNTAxN2ItM2M5Zi00NWU5LTk4MzMtNTNmY2M4MjI0N2E4IiwicG9zIjoiMGJhMDJkMjItMzZiNy00YmQ0LWJkZjctZTVmMGUxZTk1ZDJmIn0.Hm9VSbWQjWRGER_jE2UWAhtpk5_-XpniEnPRJzdxNbO",
        "shortURL": "https://aces.so/U3u6Jve"
    },
    "error": null,
    "status": 200
}
```

{% endtab %}
{% endtabs %}