# 1:1 - esaj-ajuizamento

- **Tipo requisição**: POST;
- **Tipo resposta**: ASSÍNCRONA;

Uma execução 1:1 executa apenas um item e entrega **assíncronamente** uma resposta (ou seja, resposta assíncrona).

Antes de mais nada, é importante entender o conceito de que muitas das chamadas na API da Oystr retornam respostas de maneira **assíncrona**. Isso quer dizer que a **resposta da chamada não estará pronta de imediato e você receberá um id para consultar posteriormente**. O design da API leva em consideração o tempo que os robôs demoram para executar uma determinada tarefa. O retorno de um método assíncrono é um json com um único campo: **id**.

Abaixo, seguem os parâmetros do **header** e do **body** (JSON que precisa ser enviado no body) da requisição necessários enviar, assim como o retorno obtido em caso de sucesso.

## **Parâmetros do header**

<table id="bkmrk-par%C3%A2metro-tipo-descr"><thead><tr><th>Parâmetro</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>**X-Oystr-Auth**</td><td>*String (obrigatório)*</td><td>Todas as requisições para nossa API demandam o uso do **header** ***X-Oystr-Auth***. Ele é obrigatório. Caso o header com o token não seja usado, a retorno do servidor será **HTTP/1.1 403 Forbidden**, indicando a ausência de permissões para efetuar a requisição.</td></tr></tbody></table>

## **Parâmetros do body (objeto json)**

<table id="bkmrk-par%C3%A2metro-tipo-descr-1" style="width: 100%; height: 380.344px;"><thead><tr style="height: 63.3906px;"><th style="width: 6.30408%; height: 63.3906px;">Parâmetro</th><th style="width: 10.6304%; height: 63.3906px;">Tipo</th><th style="width: 83.1891%; height: 63.3906px;">Descrição</th></tr></thead><tbody><tr style="height: 63.3906px;"><td style="width: 6.30408%; height: 63.3906px;">**bot**</td><td style="width: 10.6304%; height: 63.3906px;">*String (obrigatório)*</td><td style="width: 83.1891%; height: 63.3906px;">Nome/Identificador do robô.</td></tr><tr style="height: 63.3906px;"><td style="width: 6.30408%; height: 63.3906px;">**version**</td><td style="width: 10.6304%; height: 63.3906px;">*String (obrigatório)*</td><td style="width: 83.1891%; height: 63.3906px;">Versão do robô.</td></tr><tr style="height: 63.3906px;"><td style="width: 6.30408%; height: 63.3906px;">**credentials**</td><td style="width: 10.6304%; height: 63.3906px;">*Objeto (obrigatório)*</td><td style="width: 83.1891%; height: 63.3906px;">Objeto contendo as credenciais de acesso, seja usuário/senha, certificado ou identificador de cofre. Alguns robôs não exigem credenciais, pois são para consulta de dados públicos (não logado). **Cada robô pode exigir um tipo de credencial diferente. Veja na seção do robô qual é o modelo exigido.**</td></tr><tr style="height: 63.3906px;"><td style="width: 6.30408%; height: 63.3906px;">**data**</td><td style="width: 10.6304%; height: 63.3906px;">*Objeto (obrigatório)*</td><td style="width: 83.1891%; height: 63.3906px;">Objeto contendo os dados para consumo do robô. **Cada robô irá pedir dados específicos para sua tarefa. Veja na seção sobre os robôs quais os dados que você irá precisar.**</td></tr><tr style="height: 63.3906px;"><td style="width: 6.30408%; height: 63.3906px;">**files**</td><td style="width: 10.6304%; height: 63.3906px;">*Array de Objetos(obrigatório)*</td><td style="width: 83.1891%; height: 63.3906px;">Array contendo o conteúdo dos arquivos que serão consumidos pelo robô.</td></tr></tbody></table>

<p class="callout warning">Os campos mencionados não abrangem todas as funcionalidades disponíveis em nossa integração. Para explorar outras possibilidades, consulte a documentação geral da API 1:1. ([Documentação Geral API 1:1](https://wiki.oystr.com.br/attachments/30))</p>

## **Parâmetros do objeto 'data' (objeto json)**

<table id="bkmrk-par%C3%A2metro-tipo-descr-2" style="width: 100%; height: 801.298px;"><thead><tr style="height: 29.7969px;"><th style="width: 20.4958%; height: 29.7969px;">Parâmetro</th><th style="width: 15.6443%; height: 29.7969px;">Tipo</th><th style="width: 63.7365%; height: 29.7969px;">Descrição</th></tr></thead><tbody><tr style="height: 29.7969px;"><td style="width: 20.4958%; height: 29.7969px;">**integracao**</td><td style="width: 15.6443%; height: 29.7969px;">*String*</td><td style="width: 63.7365%; height: 29.7969px;">Identificação do processo no sistema do cliente</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**tribunal**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Sigla do estado que o robo devera fazer o ajuizamento (SP, AM, SC, etc.)</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**foro**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Foro onde o processo será protocolo</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**competencia**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Competência do processo (civil, etc.)</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**classe**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Classificação do processo</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**assuntoPrincipal**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Assunto princiapl do processo</td></tr><tr style="height: 29.7969px;"><td style="width: 20.4958%; height: 29.7969px;">**outrosAssuntos**</td><td style="width: 15.6443%; height: 29.7969px;">*List&lt;String&gt;*</td><td style="width: 63.7365%; height: 29.7969px;">Outros assuntos</td></tr><tr style="height: 29.7969px;"><td style="width: 20.4958%; height: 29.7969px;">**pedidoLiminar**</td><td style="width: 15.6443%; height: 29.7969px;">*String*</td><td style="width: 63.7365%; height: 29.7969px;">Se o processo é um pedido liminar (sim, não, true, false</td></tr><tr style="height: 29.7969px;"><td style="width: 20.4958%; height: 29.7969px;">**segredoJustica**</td><td style="width: 15.6443%; height: 29.7969px;">*String*</td><td style="width: 63.7365%; height: 29.7969px;">Se o processo será segredo de justica(sim, não, true, false</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**valorAcao**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Valor da ação</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**sorteio**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Se o processo será distribuido por sorteio (caso sim, preencher com "DEPENDENCIA")</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**processoRef**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Referencia do processo</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**fundamento**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Fundamento do processo</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**pedidoDispensa**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Se será solicitado pedido de dispensa (sim, não, true, false</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**justicaGratuita**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Se solicitará justiça gratuita (sim, não, true, false</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**numeroDocumentoDare**</td><td style="width: 15.6443%; height: 46.5938px;">*String (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Numero dare</td></tr><tr><td style="width: 20.4958%;">**grau**</td><td style="width: 15.6443%;">*String  
(obrigatório)*</td><td style="width: 63.7365%;">Grau que o robô deverá fazer o ajuizamento</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**partes**</td><td style="width: 15.6443%; height: 46.5938px;">*List&lt;Parte&gt;  
(obrigatório)* </td><td style="width: 63.7365%; height: 46.5938px;">Partes do processo (ver definição abaixo)</td></tr><tr style="height: 46.5938px;"><td style="width: 20.4958%; height: 46.5938px;">**arquivos**</td><td style="width: 15.6443%; height: 46.5938px;">*List&lt;Arquivo&gt; (obrigatório)*</td><td style="width: 63.7365%; height: 46.5938px;">Arquivos</td></tr></tbody></table>

## **Parâmetros do objeto 'parte' (objeto json)**

<table id="bkmrk-par%C3%A2metro-tipo-descr-3" style="width: 100%;"><thead><tr><th style="width: 16.3158%;">Parâmetro</th><th style="width: 33.2515%;">Tipo</th><th style="width: 50.5562%;">Descrição</th></tr></thead><tbody><tr><td style="width: 16.3158%;">**participacao**</td><td style="width: 33.2515%;">*String*</td><td style="width: 50.5562%;">Tipo de participação da parte (REQUERIDO, REQUERENTE, ADVOGADO)</td></tr><tr><td style="width: 16.3158%;">**tipoParte**</td><td style="width: 33.2515%;">*String (obrigatório se não informado o documento)*</td><td style="width: 50.5562%;">Tipo da parte (F, J, FÍSICA, JURÍDICA)</td></tr><tr><td style="width: 16.3158%;">**documentoParte**</td><td style="width: 33.2515%;">*String*</td><td style="width: 50.5562%;">Documento da parte</td></tr><tr><td style="width: 16.3158%;">**nomeParte**</td><td style="width: 33.2515%;">*String (obrigatório)*</td><td style="width: 50.5562%;">Nome da parte</td></tr><tr><td style="width: 16.3158%;">**nomeSocialParte**</td><td style="width: 33.2515%;">*String*</td><td style="width: 50.5562%;">Nome social da parte</td></tr><tr><td style="width: 16.3158%;">**generoParte**</td><td style="width: 33.2515%;">*String (obrigatório)*</td><td style="width: 50.5562%;">Gênero da parte</td></tr><tr><td style="width: 16.3158%;">**idoso**</td><td style="width: 33.2515%;">*String*</td><td style="width: 50.5562%;">Se a parte é idosa (sim, não, true, false)</td></tr><tr><td style="width: 16.3158%;">**rg**</td><td style="width: 33.2515%;">*List*</td><td style="width: 50.5562%;">RG da parte</td></tr><tr><td style="width: 16.3158%;">**emissorRG**</td><td style="width: 33.2515%;">*String*</td><td style="width: 50.5562%;">Emissor do RG da parte</td></tr><tr><td style="width: 16.3158%;">**estadoCivil**</td><td style="width: 33.2515%;">*String*</td><td style="width: 50.5562%;">Estado civil da parte</td></tr><tr><td style="width: 16.3158%;">**nacionalidade**</td><td style="width: 33.2515%;">*String*</td><td style="width: 50.5562%;">Nacionalidade da parte</td></tr><tr><td style="width: 16.3158%;">**profissao**</td><td style="width: 33.2515%;">*String*</td><td style="width: 50.5562%;">Profissão da parte</td></tr><tr><td style="width: 16.3158%;">**email**</td><td style="width: 33.2515%;">*String*</td><td style="width: 50.5562%;">Email da parte</td></tr><tr><td style="width: 16.3158%;">**enderecoParte**</td><td style="width: 33.2515%;">*Objeto&lt;Endereco&gt;*</td><td style="width: 50.5562%;">Endereco da parte (ver definicao abaixo)</td></tr></tbody></table>

## **Parâmetros do objeto 'endereco' (objeto json)**

<table id="bkmrk-par%C3%A2metro-tipo-descr-4"><thead><tr><th>Parâmetro</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>**cep**</td><td>*String*</td><td>CEP</td></tr><tr><td>**logradouro**</td><td>*String*</td><td>Nome da Rua</td></tr><tr><td>**numero**</td><td>*String*</td><td>Número do endereço</td></tr><tr><td>**complemento**</td><td>*String*</td><td>Complemento</td></tr><tr><td>**bairro**</td><td>*String*</td><td>Bairro</td></tr><tr><td>**estado**</td><td>*String*</td><td>Estado (somente sigla)</td></tr><tr><td>**cidade**</td><td>*String*</td><td>Cidade</td></tr></tbody></table>

## **Parâmetros do objeto 'arquivos' (objeto json)**

<table id="bkmrk-par%C3%A2metro-tipo-descr-5" style="width: 46.6667%; height: 255.172px;"><thead><tr style="height: 29.7969px;"><th style="width: 38.992%; height: 29.7969px;">Parâmetro</th><th style="width: 27.0459%; height: 29.7969px;">Tipo</th><th style="width: 34.2273%; height: 29.7969px;">Descrição</th></tr></thead><tbody><tr style="height: 29.7969px;"><td style="width: 38.992%; height: 29.7969px;">**tipoArquivo**</td><td style="width: 27.0459%; height: 29.7969px;">*String  
(obrigatório)*</td><td style="width: 34.2273%; height: 29.7969px;">Tipo do documento lá no portal</td></tr><tr style="height: 29.7969px;"><td style="width: 38.992%; height: 29.7969px;">**arquivo**</td><td style="width: 27.0459%; height: 29.7969px;">*String*

*obrigatório)*

</td><td style="width: 34.2273%; height: 29.7969px;">Nome da arquivo</td></tr><tr style="height: 29.7969px;"><td style="width: 38.992%; height: 29.7969px;">**peticao**</td><td style="width: 27.0459%; height: 29.7969px;">*Boolean*</td><td style="width: 34.2273%; height: 29.7969px;">Indica se o arquivo é a ppeticaoo</td></tr></tbody></table>

## **Retorno (objeto json)**

<table id="bkmrk-par%C3%A2metro-tipo-descr-6"><thead><tr><th>Parâmetro</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>**id**</td><td>*String*</td><td>O identificador único para consultar a resposta da chamada assíncrona.</td></tr></tbody></table>

## **Exemplo Json**

```json
{
    "dry": false,
    "cid": "",
    "bot": "esaj-ajuizamento"
    "version": "v3.0.0-dev",
    "force": false,
    "timeout": "1500000ms",
    "data": {
        "foro": "Foro de Franca",
        "numeroDocumentoDare": "",
        "justicaGratuita": "false",
        "partes": [
            {
                "generoParte": "False",
                "nomeSocialParte": "Empresa do Marquinhos",
                "emissorRG": "",
                "nacionalidade": "",
                "profissao": "",
                "estadoCivil": "",
                "enderecoParte": {
                    "semEndereco": "",
                    "complemento": false,
                    "estado": "SP",
                    "cep": "12345-123",
                    "bairro": false,
                    "cidade": "São Paulo",
                    "logradouro": "Rua do joãozinho",
                    "numero": "1000"
                },
                "idoso": "",
                "tipoParte": "",
                "participacao": "REQUERENTE",
                "rg": "",
                "documentoParte": "12.123.123/0001-12",
                "nomeParte": "Empresa do Marquinhos",
                "email": ""
            },
            {
                "generoParte": "Masculino",
                "nomeSocialParte": "João da Silva Sauro",
                "emissorRG": "",
                "nacionalidade": "",
                "profissao": "",
                "estadoCivil": "",
                "enderecoParte": {
                    "semEndereco": "",
                    "complemento": false,
                    "estado": "SP",
                    "cep": "12345-123",
                    "bairro": false,
                    "cidade": "São Paulo",
                    "logradouro": "Rua do joãozinho",
                    "numero": "1000"
                },
                "idoso": "",
                "tipoParte": "",
                "participacao": "REQUERIDO",
                "rg": "",
                "documentoParte": " 123.456.789-00",
                "nomeParte": "Rodrigo Trindade dos Santos",
                "email": ""
            }
        ],
        "pedidoDispensa": "false",
        "competencia": "Cível",
        "segredoJustica": "true",
        "assuntoPrincipal": "9582 - Alienação Fiduciária",
        "sorteio": "SORTEIO",
        "fundamento": "false",
        "tribunal": "SP",
        "integracao": "",
        "processoRef": "false",
        "classe": "BUSCA E APREENSÃO EM ALIENAÇÃO FIDUCIÁRIA",
        "arquivos": [
            {
                "peticao": true,
                "descricaoArquivo": "Petição",
                "arquivo": "100348000009224_7_FRANCA_SP_14082024.pdf",
                "tipoArquivo": "Petição",
                "sigilo": true
            },
            {
                "peticao": false,
                "descricaoArquivo": "Documento para juntada ",
                "arquivo": "Procuracao_2023.pdf",
                "tipoArquivo": "Procuração",
                "sigilo": true
            },
            {
                "peticao": false,
                "descricaoArquivo": "Documento para juntada ",
                "arquivo": "Estatuto Social 2024.01.10. CFI.pdf",
                "tipoArquivo": "Documento 1",
                "sigilo": true
            }
        ],
        "grau": "primeiro-grau",
        "pedidoLiminar": "true",
        "valorAcao": "7.624,83"
    },
    "files": [
        {
            "property": "arquivo",
            "data": "",
            "name": "100348000009224_7_FRANCA_SP_14082024.pdf",
            "bound": true
        },
        {
            "property": "arquivo",
            "data": "",
            "name": "Procuracao_2023.pdf",
            "bound": true
        },
        {
            "property": "arquivo",
            "data": "",
            "name": "Estatuto Social 2024.01.10. CFI.pdf",
            "bound": true
        }
    ],
    "credentials": {
        "hash": ""
    }
}
```