TRIBUNAIS - AJUIZAMENTO

1:1 - eproc-ajuizamento

Formato da Requisição do robô (via HTTP)

{
    "dry":false,
    "bot":"eproc-ajuizamento",
    "version":"v3.0.0-dev",
    "cid":"",
    "timeout":"",
    "deadline":"",
    "data": {
        "integracao":"",
        "tribunal":"",
        "numProcesso":"",
        "grau":"",
        "perfil":"",
        "localidadeJudicial":"",
        "rito":"",
        "area":"",
        "classeJudicial":"",
        "nivelSigilo":"",
        "tipoJustica":"",
        "processoOriginario":"",
        "valorCausa":"",
        "tipoCitacao":"",
        "assuntoPrincipal":"",
        "entidade":"",
        "semCpfCnpj":"",
        "doencaGrave":"",
        "ministPublico":"",
        "deficiente":"",
        "pessoaLei14289":"",
        "antecTutela":"",
        "idoso":"",
        "crianca":"",
        "juizDigital":"",
        "outrosAssuntos": [
            "",
            "",
            ""
        ],
        "tiposGuia": [
            "oficial-justica",
        ]
        "partes": [{
            "tipoParte":"",
            "tipoPessoa":"",
            "documento":"",
            "outroDocumento":"",
            "numDocumento":"",
            "nomeParte":"",
            "nomeFantasia":"",
            "cnae":"",
            "cnaeDescricao":"",
            "sexo":"",
            "estadoCivil":"",
            "nascimento":"",
            "profissao":"",
            "nacionalidade":"",
            "naturalidadeUF":"",
            "naturalidade":"",
            "mae":"",
            "pai":"",
            "escolaridade":"",
            "escolaridadeCompl":"",
            "partePrincipal":"",
            "justicaGratuita":"",
            "gerarGuia":"",
            "enderecos": [{
                "tipoEndereco":"",
                "cep":"",
                "logradouro":"",
                "numero":"",
                "complemento":"",
                "bairro":"",
                "pais":"",
                "uf":"",
                "cidade":"",
                "gerarGuia":""
            }],
            "contatos": [{
                "tipoContato":"",
                "contato":""
            }]
        }],
        "arquivos": [{
            "tipoArquivo":"",
            "arquivo":"",
            "descricaoArquivo":"",
            "sigilo":"",
            "peticao":""
        }]
    },
    "files": [{
        "name":"arquivo.pdf",
        "data":"",
        "property":"arquivo",
        "bound":true
    }],
    "credentials": {
        "username":"user",
        "password":"",
        "pin":"senha",
        "base64Cert":"[base64]",
        "credentialsOption":"SC"
    }
}

Descrição campos 'DATA'

CAMPO OBRIGÁTORIO FORMATO DEFAULT DESCRIÇÃO
integracao não String
tribunal sim String Região estadual do tribunal
numProcesso não String Número gerado do processo
grau sim String Em qual instacia será protocolado
perfil sim String Perfil em que o robô deverá protocolar. ex SP328945/ADVOGADO
localidadeJudicial sim String Comarca do protocolo
rito sim String É o caminho que será tramitado o processo
area sim String Qual arae de compentencia
classeJudicial sim String A classe processual se refere ao procedimento adotado na esfera judicial ou administrativa para atender ao pedido
nivelSigilo sim String O nível de sigilo aplicado ao processo sempre se estende aos seus documentos
tipoJustica sim String O tipo de jusitaça o qual será protocolado o pedido
processoOriginari nao String Ação que tem origem no próprio órgão, ou seja, não chega a ele como recurso contra decisão proferida em grau inferior de jurisdição.
valorCausa sim String Valor da causa do processo que server como base para calculos de taxas.
tipoCitacao não String Oficial de Justiça Campo destinado para geração da guia. Identifica o modelo que a parte deverá ser citada. Se será em mãos ou por oficial de justiça.
assuntoPrincipal sim String É o direito material descrito nos fatos, fundamentos e pedido.
antecTutela não Boolean Requer Liminar/Antecipação de Tutela
outrosAssuntos não String[] Outros assuntos do processo. Enviar somente número ou somente o texto.
tiposGuia não String[] Usado para informar ao robô quais guias ele deverá gerar.
Essa função está em fase BETA.
partes sim Parte[] Lista dos objetos da partes
arquivos sim Arquivo[] Lista dos objetos de arquivos

Descrição campos 'PARTE'

CAMPO OBRIGÁTORIO FORMATO DEFAULT DESCRIÇÃO
tipoParte sim String Dever informar se o parte é [autor ou reu]
tipoPessoa não String Definido pelo documento. Se não passar documento precisa dessa informação. Tipo de pessoa [fisica, juridica ou entidade]
documento sim String Informar o número do cpf ou cnpj
outroDocumento não String Se a pessoa possuir outro tipo de documento tipo cnh, rg etc...
nomeParte sim String Infomar o nome ou razão social
nomeFantasia não String Nome fantasia da empresa
cnae não String A sigla CNAE significa Classificação Nacional das Atividades Econômicas
cnaeDescricao não String Descrição da atividade econômica da empresa
sexo sim String Genero da pessao [Masculino ou Feminino]
estadoCivil não String Se a pessoa é [Solteira, Casada, Divorciado...]
nascimento não
Para partes do polo ativo e que não se encontram previamente cadastradas é obrigatório.
String Data de nacimento [dd/MM/yyyy ]
profissao não String Profissão da pessoa
nacionalidade não String Brasileira Pais de nascimento
naturalidadeUF não String Estado de nascimento
naturalidade não String Cidade de nascimento
mae não String Nome da mão
pai não String Nome do pai
escolaridade não String Grau de escolaridade
escolaridadeCompl não String Informação complementar da escolaridade
partePrincipal sim String Se é a parte principal do processo
justicaGratuita sim String Qual é o tipo de jusiça
gerarGuia sim String Definir para qual parte será gerado a guia
enderecos sim String Endereço da parte
contatos não String Contato da parte

Descrição campos ENDEREÇO PARTE'

CAMPO OBRIGÁTORIO FORMATO DEFAULT DESCRIÇÃO
tipoEndereco sim String Se é Residencia,Comercial...
cep sim String Cep do endereço
logradouro sim String Rua do endereço
numero sim String O número do endereço só aceitar valor númerico
complemento não String Complemento endereço
bairro sim String Bairro do endereço tem que ser o barrio valído
pais não String Pais do endereço
uf sim String Estado do endereço apenas sigla [SP,RJ, BA....]
cidade sim String Cidade do endereço
gerarGuia sim String Endereço para geração da guia [sim/não]

Descrição campos CONTATO PARTE'

CAMPO OBRIGÁTORIO FORMATO DEFAULT DESCRIÇÃO
tipoContato sim String Se é e-email, telefone....
contato sim String Número do telefone, email etc...

1:1 - esaj-ajuizamento

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

Parâmetro Tipo Descrição
X-Oystr-Auth String (obrigatório) 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.

Parâmetros do body (objeto json)

Parâmetro Tipo Descrição
bot String (obrigatório) Nome/Identificador do robô.
version String (obrigatório) Versão do robô.
credentials Objeto (obrigatório) 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.
data Objeto (obrigatório) 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.
files Array de Objetos(obrigatório) Array contendo o conteúdo dos arquivos que serão consumidos pelo robô.

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)

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

Parâmetro Tipo Descrição
integracao String Identificação do processo no sistema do cliente
tribunal String (obrigatório) Sigla do estado que o robo devera fazer o ajuizamento (SP, AM, SC, etc.)
foro String (obrigatório) Foro onde o processo será protocolo
competencia String (obrigatório) Competência do processo (civil, etc.)
classe String (obrigatório) Classificação do processo
assuntoPrincipal String (obrigatório) Assunto princiapl do processo
outrosAssuntos List<String> Outros assuntos
pedidoLiminar String Se o processo é um pedido liminar (sim, não, true, false
segredoJustica String Se o processo será segredo de justica(sim, não, true, false
valorAcao String (obrigatório) Valor da ação
sorteio String (obrigatório) Se o processo será distribuido por sorteio (caso sim, preencher com "DEPENDENCIA")
processoRef String (obrigatório) Referencia do processo
fundamento String (obrigatório) Fundamento do processo
pedidoDispensa String (obrigatório) Se será solicitado pedido de dispensa (sim, não, true, false
justicaGratuita String (obrigatório) Se solicitará justiça gratuita (sim, não, true, false
numeroDocumentoDare String (obrigatório) Numero dare
grau String
(obrigatório)
Grau que o robô deverá fazer o ajuizamento
partes List<Parte>
(obrigatório)
Partes do processo (ver definição abaixo)
arquivos List<Arquivo> (obrigatório) Arquivos

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

Parâmetro Tipo Descrição
participacao String Tipo de participação da parte (REQUERIDO, REQUERENTE, ADVOGADO)
tipoParte String (obrigatório se não informado o documento) Tipo da parte (F, J, FÍSICA, JURÍDICA)
documentoParte String Documento da parte
nomeParte String (obrigatório) Nome da parte
nomeSocialParte String Nome social da parte
generoParte String (obrigatório) Gênero da parte
idoso String Se a parte é idosa (sim, não, true, false)
rg List RG da parte
emissorRG String Emissor do RG da parte
estadoCivil String Estado civil da parte
nacionalidade String Nacionalidade da parte
profissao String Profissão da parte
email String Email da parte
enderecoParte Objeto<Endereco> Endereco da parte (ver definicao abaixo)

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

Parâmetro Tipo Descrição
cep String CEP
logradouro String Nome da Rua
numero String Número do endereço
complemento String Complemento
bairro String Bairro
estado String Estado (somente sigla)
cidade String Cidade

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

Parâmetro Tipo Descrição
tipoArquivo String
(obrigatório)
Tipo do documento lá no portal
arquivo

String

obrigatório)

Nome da arquivo
peticao Boolean Indica se o arquivo é a ppeticaoo

Retorno (objeto json)

Parâmetro Tipo Descrição
id String O identificador único para consultar a resposta da chamada assíncrona.

Exemplo 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": ""
    }
}

1:1 - pje-tj-ajuizamento

Formato da Requisição do robô (via HTTP)

Formato da Requisição do robô (via HTTP)
JSON
{
    "dry": false,
    "bot": "pje-tj-ajuizamento",
    "version": "v3.0.0-dev",
    "cid": "",
    "timeout": "",
    "deadline": "",
    "data": {
        "grau": "",
        "textoPeca": "",
        "dividirArquivo": "",
        "idTramitacao": "",
        "integracao": "",
        "tribunal": "",
        "materia": "",
        "jurisdicao": "",
        "classeJudicial": "",
        "assunto": "",
        "outrosAssuntos": [
            "",
            "",
            ""
        ],
        "justicaGratuita": "",
        "pedidoLiminar": "",
        "valorCausa": "",
        "sigilo": "",
        "motivo": "",
        "prioridades": [
            "",
            "",
            ""
        ],
        "tipoProtocolo": "Contestação",
        "competencia": "[CÍVEL] Cível",
        "partes": [
            {
                "poloParte": "",
                "tipoParte": "",
                "tipoPessoa": "",
                "ehBrasileiro": "",
                "ehOrgaoPublico": "",
                "nacionalidade": "",
                "documento": "",
                "nome": "",
                "nomeSocial": "",
                "parteSigilosa": "",
                "procuradoriaDefensoria": "",
                "informacaoParte": {
                    "nomeMae": "",
                    "nomePai": "",
                    "genero": "",
                    "dataNascimento": "",
                    "dataObito": "",
                    "etnia": "",
                    "estadoCivil": "",
                    "escolaridade": "",
                    "paisNascimento": "",
                    "profissao": ""
                },
                "identificacaoParte": {
                    "nomeRegistradoDocumento": "",
                    "tipoDocumentoIdentificacao": "",
                    "numeroDocumentoIdentificacao": "",
                    "estadoDocumentoIdentificacao": "",
                    "ehDocumentoFalso": "",
                    "ehDocumentoPrincipal": "",
                    "situacaoDocumento": ""
                },
                "enderecoParte": [
                    {
                        "cep": "",
                        "logradouro": "",
                        "numero": "",
                        "complemento": "",
                        "bairro": "",
                        "estado": "",
                        "cidade": ""
                    }
                ],
                "meiosContatoParte": [
                    {
                        "tipoContato": "",
                        "contato": ""
                    }
                ],
                "outrosNomesParte": [
                    {
                        "outroNomeParte": "",
                        "tipoOutroNomeParte": ""
                    }
                ],
                "outrasFiliacoesParte": [
                    {
                        "outraFiliacaoNome": "",
                        "tipoOutraFiliacao": ""
                    }
                ]
            }
        ],
        "arquivos": [
            "tipoArquivo": "",
            "arquivo": "",
            "descricaoArquivo": "",
            "sigilo": "",
            "peticao": ""
        ]
    },
    "files": [
        {
            "name": "arquivo.pdf",
            "data": "",
            "property": "arquivo",
            "bound": true
        }
    ],
    "credentials": {
        "username": "user",
        "pin": "senha",
        "base64Cert": "[base64]",
        "credentialsOption": "RJ"
    }
}

Descrição campos 'DATA'

CAMPO Obrigatório Formato Default Descrição
grau Sim String Em qual grau o peticionamento deverá ser realizado.
Ex: "primeiro-grau", "segundo-grau" ou "recursal"
textoPeca Não String "Segue documentos em anexo" Campo de texto inicial do protocolo
dividirArquivo Não String false Se marcado como sim o robô irá dividir os arquivos
tribunal Sim String Sigla do tribunal onde o robô deverá realizar o protocolo.

Ex: MG, PB, MT, etc.
materia Sim String Corresponde ao campo Matéria no tribunal.

Ex: "DIREITO CIVIL > OBRIGAÇÕES"
jurisdicao Sim String Corresponde ao campo Jurisdição no tribunal.

Ex: "Vazante"
classeJudicial Sim String Corresponde ao campo Classe Judicial no tribunal.

Ex: "[CÍVEL] BUSCA E APREENSÃO EM ALIENAÇÃO FIDUCIÁRIA (81)"
assunto Siim String Assunto principal do processo.

Ex: "9582" ou "DESCRIÇÃO COMPLETA COM CÓDIGO"
outrosAssuntos Não String[] Outros assuntos do processo.

É uma lista então pode colocar 0 ou N itens
justicaGratuita Não String false Informa se o robo marcara sim no campo justica gratuita.

Ex: "Sim", "Não", true ou false
pedidoLiminar Não String false Informa se o robo marcara sim no campo pedido liminar.

Ex: "Sim", "Não", true ou false
valorCausa Não String Informa o campo valor da causa.

Ex: "0,00"
sigilo Não String false Informa se o robo marcara sim no campo sigilo.

Ex: "Sim", "Não", true ou false
motivo Sim se sigilo == Sim String Se marcar "Sim" no campo sigilo, este campo deverá ser preenchido com o numero da ordem do item a ser selecionado.

Ex: "1"
prioridades Não String[] Lista de prioridades a ser informado no robô.
tipoProtocolo Sim String Qual o tipo do protocolo a ser informado na tela de arquivos.
Corresponde ao campo "Tipo documento" no portal.

Ex: "Petição Inicial"
competencia Não String Quando há mais de uma competência possível na jurisdição referente à classe, assuntos ou partes selecionadas, deve-se informar este campo.

Ex: [CÍVEL] Cível
partes Sim Parte[] Lista dos objetos da partes
arquivos Sim Arquivo[] Lista dos objetos de arquivos

Descrição campos 'PARTE'

CAMPO Obrigatório Formato Default Descrição
poloParte Sim String Em qual polo o robô deverá cadastrar a parte.

Ex: "ativo", "passivo" ou "outro"
tipoParte Sim String Qual o tipo da parte.

Ex: "AUTOR", "RÉU/RÉ", etc.
tipoPessoa Não String Qual o tipo da pessoa a ser cadastrada.

Se houver cpf ou cnpj o robô consegue identificar o campo. Se não é preciso apontar.

Ex: "Físico", "Jurídico" ou "Entidade"
ehBrasileiro Não String true Indica se a parte é brasileira.

Ex: "Sim", "Não", true ou false
ehOrgaoPublico Não String false Indica se a parte é um orgão público

Ex: "Sim", "Não", true ou false
nacionalidade Não String Indica a nacilidade da parte
documento Não String Número do documento da parte.

Obrigatório se a parte for fisica ou jurídica com CNPJ.
nome Não String Nome da parte
nomeSocial Não String Nome social da parte
parteSigilosa Não String false Indica se a parte é sigilosa

Ex: "Sim", "Não", true ou false
procuradoriaDefensoria Não String
informacaoParte Não INFORMAÇÃO PARTE Outras informações da parte
identificacaoParte Não IDENTIFICAÇÃO PARTE Outras indentificações da parte
enderecoParte Não ENDEREÇO PARTE[] Endereços da parte
meiosContatoParte Não MEIOS CONTATO[] Meio de contato da parte
outrosNomesParte Não OUTROS NOMES[] Outros nomes da parte
outrasFiliacoesParte Não OUTRAS FILIAÇÕES[] Outras filiações da parte

Descrição campos 'INFORMAÇÃO PARTE'

CAMPO Obrigatório Formato Default Descrição
nomeMae Não String Usado para informar o nome da mãe da parte
nomePai Não String Usado para informar o nome do pai parte
genero Não String Usado para informar o gênero da parte.
dataNascimento Não String Usado para informar a data de nascimento da parte
dataObito Não String Usado para informar a data de obito da parte
etnia Não String Usado para informar a etinia da parte
estadoCivil Não String Usado para informar o estado cívil da parte
escolaridade Não String Usado para informar a escolaridade da parte
paisNascimento Não String Usado para informar o país de nascimento da parte
profissao Não String Usado para informar a profissão da parte

Descrição campos 'IDENTIFICAÇÃO PARTE'

CAMPO Obrigatório Formato Default Descrição
nomeRegistradoDocumento Não String Usado para informar o nome de registro da parte
tipoDocumentoIdentificacao Não String Usado para informar o tipo de identificao da parte
numeroDocumentoIdentificacao Não String Usado para informar o núemero de identificao da parte
estadoDocumentoIdentificacao Não String Usado para informar o estado do documento da parte
ehDocumentoFalso Não String Usado para informar se o documento é falsoe da parte

Ex: "Sim", "Não", true ou false
ehDocumentoPrincipal Não String Usado para informar se o documento será usado como principal.

Usado para informar se o documento é falsoe da parte

Ex: "Sim", "Não", true ou false
situacaoDocumento Não String Usado para informar a situação do documento.

Descrição campos 'ENDEREÇO PARTE'

CAMPO Obrigatório Formato Default Descrição
cep Não String Usado para informar o cep do endereço
logradouro Não String Usado para informar o logradouro do endereço
numero Não String Usado para informar o número do endereço
complemento Não String Usado para informar o complemento do endereço
bairro Não String Usado para informar o bairro do endereço
estado Não String Usado para informar o estado do endereço
cidade Não String Usado para informar a cidade do endereço

Descrição campos 'MEIOS CONTATO'

CAMPO Obrigatório Formato Default Descrição
tipoContato Não String Informa o tipo do contato
contato Não String Informa o valor do contato

Descrição campos 'OUTROS NOMES'

CAMPO Obrigatório Formato Default Descrição
outroNomeParte Não String Informa o valor do outro nome
tipoOutroNomeParte Não String Informa o tipo do valor do outro nome

Descrição campos 'OUTRAS FILIAÇÕES'

CAMPO Obrigatório Formato Default Descrição
outraFiliacaoNome Não String Informa o nome da outra filiação
tipoOutraFiliacao Não String Informa o tipo do valor da outra filização

Descrição campos 'ARQUIVO'

CAMPO Obrigatório Formato Default Descrição
tipoArquivo Sim String Categorização do arquivo dentro do tribunal. Ex: Petição
descricaoArquivo Não String vazio Descrição extra do arquivo
sigilo Não Boolean false Marcar se o arquivo deverá ser marcado como sigiloso.
arquivo Sim String Nome do arquivo. Deverá ser informado o mesmo nome do atributo 'files.name'
peticao Não String false Usado para identificar o arquivo principal da petição..


Obs: Nas próximas atualizações do robô esse campo será usado para identificar se o robô não deverá utilizar o campo de edição para descrever a petição inicial.

1:1 - projudi-go-ajuizamento

Formato da Requisição do robô (via HTTP)

{
    "dry": false,
    "bot": "projudi-go-ajuizamento",
    "version": "v3.0.0-dev",
    "cid": "",
    "timeout": "",
    "deadline": "",
    "data": {
        "numeroProcesso": "",
        "tipo": "",
        "grau": "",
        "dependencia": "",
        "gratuidade": "",
        "comarca": "",
        "valor": "",
        "areaDistribuicao": "",
        "classe": "",
        "prioridade": "",
        "assunto": "",
        "numeroGuiaInicial": "",
        "assinarDocumento": "",
        "segredoJustica": "",
        "naoMarcarAudiencia": "",
        "cemPorcentoDigital": "",
        "pessoa": [
            {
                "nome": "",
                "telefone": "",
                "email": "",
                "tipoParte": "",
                "nomeSocial": "",
                "sexo": "",
                "naturalidade": "",
                "estadoCivil": "",
                "profissao": "",
                "etnia": "",
                "escolaridade": "",
                "nomePai": "",
                "nomeMae": "",
                "celular": "",
                "dataDaSentenca": "",
                "dataDaPronuncia": "",
                "dataDeNascimento": "",
                "tipoDeGoverno": "",
                "tipoDeEmpresa": "",
                "gerarIntimacaoLocomocao": "",
                "endereco": {
                    "tipoEndereco": "",
                    "logradouro": "",
                    "numero": "",
                    "bairro": "",
                    "cidade": "",
                    "UF": "",
                    "cep": "",
                    "complemento": ""
                },
                "documentos": {
                    "documentoParte": "",
                    "rg": "",
                    "tituloEleitor": "",
                    "tituloEleitorZona": "",
                    "tituloEleitorSecao": "",
                    "orgaoExpeditorRG": "",
                    "orgaoExpeditorRGSigla": "",
                    "ctps": "",
                    "serie": "",
                    "pis": ""
                }
            }
        ]
    },
    "arquivos": [
        {
            "tipoArquivo": "Petição",
            "descricaoArquivo": "",
            "sigilo": "não",
            "peticao": "",
            "arquivo": "arquivo.pdf"
        }
    ],
    "files": [
        {
            "name": "arquivo.pdf",
            "data": "",
            "property": "arquivo",
            "bound": "true"
        }
    ],
    "credentials": {
        "username": "user",
        "pin": "senha",
        "base64Cert": "[base64]"
    }
}

Descrição campos 'DATA'

CAMPO Obrigatório Formato Default Descrição
grau Sim String vazio Grau em que o robô deverá fazer o protocolo. Ex: primeiro-grau ou segundo-grau
numeroProcesso Sim String vazio Número do processo no formato CNJ
tipo Sim String vazio Tipo do ajuizamento no portal. Ex: Cívil
dependencia Sim String vazio Quantos dependentes existem. Ex.: 0, 1, 2.
gratuidade Sim String vazio Campo utilizado para determinar se o ajuizamento será ‘com custas’, ‘com gratuidade de justiça’ ou ‘isento’.
comarca Sim String vazio Nome da comarca
valor Sim String vazio Valor do processo.
areaDistribuicao Sim String vazio Área da distribuição da comarca
classe Sim String vazio Classe do ajuizamento.
prioridade Sim String vazio Nível de prioridade do processo.
assunto Sim String vazio Assunto (CNJ ou o nome do assunto).
numeroGuiaInicial Sim String vazio Número da guia inicial
assinarDocumento Sim Boolean false Assinar ou não o documento
segredoJustica Sim Boolean false Manter ou não em segredo de Justiça
naoMarcarAudiencia Sim Boolean false Marcar ou não a audiência
cemPorcentoDigital Sim Boolean false Informar se o caso é digital ou não
partes sim Parte[] Lista dos objetos da partes
arquivos sim Arquivo[] Lista dos objetos de arquivos

Descrição campos 'ARQUIVOS'

CAMPO Obrigatório Formato Default Descrição
tipoArquivo Sim String Categorização do arquivo dentro do tribunal. Ex: Petição
descricaoArquivo Não String vazio Descrição extra do arquivo
sigilo Não Boolean false Marcar se o arquivo deverá ser marcado como sigiloso.
arquivo Sim String Nome do arquivo. Deverá ser informado o mesmo nome do atributo 'files.name'
peticao Sim String vazio Tipo de petição do arquivo.

Descrição campos 'PARTE'

CAMPO Obrigatório Formato Default Descrição
nome Sim String vazio Nome da parte
telefone Não String vazio Telefone da parte
email Sim String vazio Email da parte
tipoParte Sim String vazio Tipo da parte
nomeSocial Não String vazio Nome Social da parte
sexo Sim String vazio Sexo da parte (Feminino ou Masculino)
naturalidade Não String vazio Naturalidade da parte
estadoCivil Não String vazio Estado Civil da parte
profissao Não String vazio Profissão da parte
etnia Não String vazio Etnia da parte
escolaridade Não String vazio Escolaridade da parte
nomePai Não String vazio Nome do Pai
nomeMae Sim String vazio Nome da Mãe
celular Sim String vazio Celular
dataDaSentenca Sim String vazio
dataDaPronuncia Sim String vazio
dataDeNascimento Sim String vazio
endereco sim Endereco[] Endereço da parte Lista
documentacao sim Documentacao[] Documentação da Parte Lista

Descrição campos 'ENDEREÇO'

CAMPO Obrigatório Formato Default Descrição
tipoEndereco sim String Se é residencia, comercial…
logradouro Sim String vazio Rua do endereço
numero Sim String vazio
bairro Sim String vazio
cidade Sim String vazio
UF Sim String vazio
cep Sim String vazio
complemento Sim String vazio

Descrição campos 'DOCUMENTOS'

CAMPO Obrigatório Formato Default Descrição
documentacaoParte Sim String vazio CPF ou CNPJ
rg Sim String vazio
tituloEleitor Não String vazio
tituloEleitorZona Não String vazio
tituloEleitorSecao Não String vazio
orgaoExpeditorRG Não String vazio
orgaoExpeditorRGSigla Não String vazio
ctps Não String vazio
serie Não String vazio
pis Sim String vazio

Descrição campos 'credentials'

CAMPO Obrigatório Formato Default Descrição
username Sim String CPF do certificado
pin Sim String Senha do certificado
base64Cert Sim String Base64 do certificado
hash Sim (se a credencial estiver salva no nosso cofre) String hash gerado pelo nosso cofre

1:1 - projudi-pr-ajuizamento

Formato da Requisição do robô (via HTTP)

{
    "dry": false,
    "bot": "projudi-pr-ajuizamento",
    "version": "v3.0.0-dev",
    "cid": "",
    "timeout": "",
    "deadline": "",
    "data": {
        "tribunal": "",
        "grau": "",
        "perfis": "",
        "assinarDocumento": "",
        "dividirArquivo": "",
        "processoDependete": "",
        "numeroProcessoPrincipal": "",
        "enviarParaPlantao": "",
        "localidade": "",
        "competencia": "",
        "justificativaPlantao": "",
        "nucleoJustica4": "",
        "motivoNaoNucleo": "",
        "cemPorCentoDigital": "",
        "motivoNaoDigital": "",
        "processoExecucao": "",
        "classeProcessual": "",
        "valorCausa": "",
        "pedidoUrgencia": "",
        "segradoJustica": "",
        "marcarConciliacao": "",
        "assunto": "",
        "outrosAssuntos": [
            "",
            "",
            ""
        ],
        "partes": [{
            "tipoParte": "",
            "subTipoParte": "",
            "atuacaoParte": "",
            "prioridade": "",
            "tipoPessoa": "",
            "documentoParte": "",
            "nome": "",
            "email": "",
            "policial": "",
            "batalhao": "",
            "matriculapolicial": "",
            "justicaGratuita": "",
            "custasPostergadas": "",
            "reuPreso": "",
            "dadosBasicos": {
                "tipoDocumentacao": "",
                "rg": "",
                "orgaoRg": "",
                "estadoRg": "",
                "passaporte": "",
                "dataNascimento": "",
                "dataFalecimento": "",
                "estadoCivil": "",
                "nomeFantasia": "",
                "numeracaoEstrangeira": ""
            },
            "filiacao": {
                "nomeMae": "",
                "nomePai": "",
                "filiacaoSecundaria": ""
            },
            "generoRaca": {
                "raca": "",
                "sexoBiologico": "",
                "autoDeclaracaoLGBT": "",
                "identidadeGenero": "",
                "orientacaoSexual": "",
                "nomeSocial": ""
            },
            "condicoesAcompanhamento": {
                "precisaAcompanhamentoMedico": "",
                "precisaTradutorInterprete": "",
                "motivoTradutorInterprete": "",
                "medicacaoUsoContinuo": "",
                "doencaCronica": "",
                "tipoDoencaCronica": "",
                "comDefiencia": "",
                "tipoDefiencia": "",
                "doencaGrave": "",
                "tipoDoencaGrave": ""
            },
            "naturalidade": {
                "nacionalidade": "",
                "municipio": "",
                "uf": "",
                "outrasNaturalidades": []
            },
            "informacoesAdicionais": {
                "escolaridade": "",
                "situacaoEconomica": "",
                "profissao": ""
            },
            "documentos": {
                "cnh": "",
                "estadoCnh": "",
                "tituloEleitor": "",
                "zonaTituloEleitor": "",
                "secaoTituloEleitor": "",
                "pis": "",
                "ctps": "",
                "serie": "",
                "ufCtps": "",
                "certidaoCasamento": "",
                "cartorioCertidaoCasamento": "",
                "certidaoNascimento": "",
                "cartorioCertidaoNascimento": "",
                "certidaoObito": "",
                "cartorioCertidaoObito": ""
            },
            "dependentes": [{
                "tipoDependente": "",
                "nome": "",
                "dataNascimento": "",
                "comDefiencia": "",
                "cpf": ""
            }],
            "enderecoParte": {
                "tipoEndereco": "",
                "cep": "",
                "logradouro": "",
                "numero": "",
                "complemento": "",
                "bairro": "",
                "pais": "",
                "uf": "",
                "cidade": "",
                "observacao": ""
            },
            "telefones": [{
                "tipo": "",
                "nacional": "",
                "numero": "",
                "ramal": "",
                "observacao": ""
            }]
        }],
        "representantes": [{
            "tipoParte": "",
            "subTipoParte": "",
            "nome": "",
            "documentoParte": "",
            "tipoPessoa": "",
            "rg": "",
            "enderecoParte": {
                "tipoEndereco": "",
                "cep": "",
                "logradouro": "",
                "numero": "",
                "complemento": "",
                "bairro": "",
                "pais": "",
                "uf": "",
                "cidade": "",
                "observacao": ""
            },
            "telefones": [{
                "tipo": "",
                "nacional": "",
                "numero": "",
                "ramal": "",
                "observacao": ""
            }],
            "partesRepresentante": [
                "",
                "",
                ""
            ]
        }],
        "arquivos": [{
            "tipoArquivo": "",
            "arquivo": "",
            "descricaoArquivo": "",
            "sigilo": ""
        }]
    },
    "files": [{
        "name": "arquivo.pdf",
        "data": "",
        "property": "arquivo",
        "bound": true
    }],
    "credentials": {
        "username": "user",
        "password": "",
        "pin": "senha",
        "base64Cert": "[base64]",
        "credentialsOption": "PR"
    }
}

Descrição campos 'DATA'

CAMPO Obrigatório Formato Default Descrição
perfis Sim String Perfil em que o robô deverá protocolar.
Ex: PR123456/Advogado
assinarDocumento Não Boolean false Marcado para informar se o robô deverá assinar os arquivos
dividirArquivo Não Boolean false Marcado para avisar ao robô que deseja que ele divida os arquivos
processoDependete Não Boolean false Marcado para protocolar em casos incidentais
numeroProcessoPrincipal Não String Número do processo dependente
enviarParaPlantao Não Boolean Enviar processo em modo de plantão
localidade Sim String Comarca do protocolo
competencia Sim String Competência do processo
justificativaPlantao Não String Justificativa de enviar para o plantão
nucleoJustica4 não Boolean false Processo é do Nucleo 4.0
motivoNaoNucleo não String Motivo de não enviar para o nucleo 4.0
cemPorCentoDigital não Boolean false Processo 100% digital?
motivoNaoDigital não String Motivo de não enviar como 100% digital
processoExecucao não Boolean false Processo está em execuçao
classeProcessual Sim String Classe procussual do processo
valorCausa Sim String Valor da causa,
deverá ser informado exatamente como o exemplo.
Ex: 2.000,00
pedidoUrgencia Não Boolean false Enviar processo com pedido de urgência
segredoJustica Não Boolean false Marcar processo como segredo de justica
marcarConciliacao Não Boolean false Marcar conciliação processo
assunto Sim String Assunto do processo. Enviar somente número ou somente o texto.
outrosAssuntos Não String[] Outros assuntos do processo. Enviar somente número ou somente o texto.
partes Sim Parte[] Lista dos objetos da partes
representantes Sim Representantes[] Lista dos objetos da representantes
arquivos Sim Arquivo[] Lista dos objetos de arquivos

Descrição campos 'PARTE'

CAMPO Obrigatório Formato Default Descrição
tipoParte Sim String Se a parte é réu autor, enviar igual ao portal
subTipoParte Sim String ?
nome Sim String Nome da parte
documentoParte Sim String Documento da parte
tipoPessoa Sim String Tipo da pessoa:
juridica ou fisica etc.
rg Não String rg da parte
enderecoParte Sim ENDEREÇO PARTE Endereços da parte
telefones Não TELEFONES[] Meio de contato da parte

Descrição campos 'REPRESENTANTES'

CAMPO Obrigatório Formato Default Descrição
nome Sim String Nome da parte
documentoParte Sim String Documento d
tipoPessoa Sim String Tipo da pessoa:
Jurídica, Física etc
rg Não String Rg da parte
enderecoParte Não ENDEREÇO PARTE Endereços da parte
telefones Não TELEFONES[] Telefones da parte
partesRepresentantes Não String[] Partes que o representante irá representar

Descrição campos 'ENDEREÇO PARTE'

CAMPO Obrigatório Formato Default Descrição
cep Sim String Cep do endereco
logradouro Sim String Rua do endereco
numero Sim String Número do endereço
complemento Sim String Complemento do endereço
bairro Sim String Bairro do endereço
pais não String País do endereço
uf Sim String Estado do endereço
cidade Sim String Cidade do endereço
observacao Não String Observação

Descrição campos 'TELEFONES'

CAMPO Obrigatório Formato Default Descrição
tipo Sim String Tipo do telefone
nacional Não Boolean false Telefone é nacional
numero Sim String Número do telefone
ramal Não String Ramal
observacao Não String Observação

Descrição campos 'DADOS BÁSICOS PARTE'

CAMPO Obrigatório Formato Default Descrição
tipoDocumentacao Não String Nacional Indica se a documentação é Nacional ou estrangeira
rg Não String Número do RG
orgaoRg Não String SSP Orgão do RG
estadoRg Não String PR Estado do RG
passaporte Não String Número do passaporte
dataNascimento Não String Data de nascimento
dataFalecimento Não String Data de falecimento
estadoCivil Não String Estado civil
nomeFantasia Não String Nome fantasia
numeracaoEstrangeira Não String Numeração documento estrangeiro

Descrição campos 'FILIAÇÃO'

CAMPO Obrigatório Formato Default Descrição
nomeMae Não String Nome da mãe
nomePai Não String Nome do pai
filiacaoSecundaria Não String Nome da filiação secundária

Descrição campos 'GÊNERO E RAÇA'

CAMPO Obrigatório Formato Default Descrição
raca Não String Raça
sexoBiologico Não String Qual o sexo biológico
Masculino (m), Feminino (f),
Interssexo (i)
autoDeclaracaoLGBT Não Boolean false Auto declaração LGBT
identidadeGenero Não String Identidade de gênero
orientacaoSexual Não String Orientação Sexual
nomeSocial Não String Nome social

Descrição campos 'CONDIÇÃO E ACOMPANHAMENTO'

CAMPO Obrigatório Formato Default Descrição
precisaAcompanhamentoMedico Não Boolean false Precisa de acmpanhamento médico
precisaTradutorInterprete Não Boolean false Precisa de tradutor
motivoTradutorInterprete Não String[] Caso precise de tradutor, quais os motivos
medicacaoUsoContinuo Não Boolean false Precisa de medicação de uso contínuo
doencaCronica Não Boolean false Tem alguma doença crônica
tipoDoencaCronica Não String[] Caso tenha alguma doência crônica, quais são
comDefiencia Não Boolean false É uma pessoa com deficiência
tipoDefiencia Não String[] Caso tenha alguma deficiência, quais são
doencaGrave Não Boolean false Tem alguma doença grave
tipoDoencaGrave Não String[] Caso tenha alguma doência grave, quais são

Descrição campos 'NATURALIDADE'

CAMPO Obrigatório Formato Default Descrição
nacionalidade Não String Brasil Nacionalidade
municipio Não String Munícipio
uf Não String Uf do municipio
outrasNaturalidades Não String[] Outras nacionalidades

Descrição campos 'INFORMAÇÕES ADICIONAIS'

CAMPO Obrigatório Formato Default Descrição
escolaridade Não String Escolaridade
situacaoEconomica Não String Situação ecônomica
profissao Não String Profissão

Descrição campos 'DOCUMENTOS'

CAMPO Obrigatório Formato Default Descrição
cnh Não String Número CNH
estadoCnh Não String Estado CNH
tituloEleitor Não String Número titulo eleitor
zonaTituloEleitor Não String Número Zona Eleitoral
secaoTituloEleitor Não String Número Seção Eleitoral
pis Não String Número pis
ctps Não String Número ctps
serie Não String Série ctps
ufCtps Não String UF ctps
certidaoCasamento Não String Número Certidão Casamento
cartorioCertidaoCasamento Não String Cartorio Certidão casamento
certidaoNascimento Não String Número Certidão Nascimento
cartorioCertidaoNascimento Não String Cartório Certidão nascimento
certidaoObito Não String Número Certidão óbito
cartorioCertidaoObito Não String Cartório Certidão óbito

Descrição campos 'DEPENDENTES'

CAMPO Obrigatório Formato Default Descrição
tipoDependente Não String Tipo de dependente
nome Não String Nome dependente
dataNascimento Não String Data nascimento dependente
comDefiencia Não Boolean false Dependente é pessoa com deficiência
cpf Não String CPF dependente

Descrição campos 'ARQUIVO'

CAMPO Obrigatório Formato Default Descrição
tipoArquivo Sim String Categorização do arquivo dentro do tribunal. Ex: Petição
descricaoArquivo Não String vazio Descrição extra do arquivo
sigilo Não Boolean false Marcar se o arquivo deverá ser marcado como sigiloso.
arquivo Sim String Nome do arquivo. Deverá ser informado o mesmo nome do atributo 'files.name'

1:1 - tj-se-ajuizamento

Formato da Requisição do robô (via HTTP)

{
    "dry": false,
    "bot": "tj-se-ajuizamento",
    "version": "v3.0.0-dev",
    "cid": "",
    "timeout": "",
    "deadline": "",
    "data": {
        "comarca": "",
        "materia": "",
        "atuacao": "",
        "forum": "",
        "destino": "",
        "classe": "",
        "assunto": "",
        "outrosAssuntos": [
            ""
        ],
        "cemPorCentoDigital": "",
        "segredoJustica": "",
        "penhoraOnline": "",
        "tutelaAntecipada": "",
        "pedidoGratuidade": "",
        "pessoaComDeficienca": "",
        "doencaGrave": "",
        "pessoaEmSituacaoDeRua": "",
        "liminarTutela": "",
        "valorCausa": "",
        "guia": "",
        "partes": [
            {
                "tipoParte": "",
                "criancaAdolescente": "",
                "estrangeiro": "",
                "documento": "",
                "nomeParte": "",
                "nomeSocial": "",
                "email": "",
                "telefone": "",
                "dataNascimento": "",
                "enderecoParte": {
                    "tipoEndereco": "",
                    "cep": "",
                    "logradouro": "",
                    "cidade": "",
                    "bairro": "",
                    "estado": "",
                    "numero": ""
                }
            }
        ],
        "arquivos": [
            {
                "tipoArquivo": "Petição",
                "descricaoArquivo": "",
                "sigilo": "não",
                "peticao": "",
                "arquivo": "arquivo.pdf"
            }
        ]
    },
    "arquivos": [
        {
            "tipoArquivo": "Petição",
            "descricaoArquivo": "",
            "peticao": "",
            "arquivo": "arquivo.pdf"
        }
    ],
    "files": [
        {
            "name": "arquivo.pdf",
            "data": "",
            "property": "arquivo",
            "bound": "true"
        }
    ],
    "credentials": {
        "username": "user",
        "password": "senha"
    }
}

Descrição campos 'DATA'

CAMPO Obrigatório Formato Default Descrição
comarca Sim String vazio Comarca do processo
materia Sim String vazio Matéria do processo
atuacao Não String Primeiro item se houver só um Comarca do processo
forum Não String Primeiro item se houver só um Fórum do processo
destino Não String Primeiro item se houver só um Destino do processo
classe Sim String vazio Classe do processo
assunto Sim String vazio Assunto do processo
outrosAssuntos String vazio Outros Assuntos do processo
cemPorCentoDigital não Boolean false Processo 100% juizo digital

SIM ou TRUE
segredoJustica não Boolean false Processo em segredo de justça

SIM ou TRUE
penhoraOnline não Boolean false Processo com penhora online

SIM ou TRUE
tutelaAntecipada não Boolean vaziofalse Processo com tutela antecipada

SIM ou TRUE
pedidoGratuidade não Boolean false Processo com pedido de gratuidade

SIM ou TRUE
pessoaComDeficienca não Boolean false Processo com pessoa com deficiência

SIM ou TRUE
doencaGrave não Boolean false Processo com pessoa com doença grave

SIM ou TRUE
pessoaEmSituacaoDeRua não Boolean false Processo com pessoa em situação de rua

SIM ou TRUE
valorCausa Sim String Valor da causa
guia Sim String Número da guia
partes sim Parte[] Lista dos objetos da partes
arquivos sim Arquivo[] Lista dos objetos de arquivos

Descrição campos 'ARQUIVOS'

CAMPO Obrigatório Formato Default Descrição
tipoArquivo Sim String Categorização do arquivo dentro do tribunal. Ex: Petição
descricaoArquivo Não String vazio Descrição extra do arquivo
arquivo Sim String Nome do arquivo. Deverá ser informado o mesmo nome do atributo 'files.name'

Descrição campos 'PARTE'

CAMPO Obrigatório Formato Default Descrição
tipoParte Sim String Tipo da parte
criancaAdolescente Não Boolean false criancaAdolescente
estrangeiro Sim Boolean false Estrangeiro
documento Sim String Documento da parte
nomeParte Sim String Nome da parte
nomeSocial Não String vazio Nome Social da parte
email Se for Requerente é obrigatório String vazio Email da parte
telefone Se for Requerente é obrigatório String vazio Telefone da parte
dataNascimento Se for Requerente e pessoa física String vazio Data de nascimento da parte
enderecoParte sim Endereco Endereço da parte

Descrição campos 'ENDEREÇO'

CAMPO Obrigatório Formato Default Descrição
tipoEndereco sim String Se é residencia, profissional
cep Sim String Rua do endereço
logradouro Sim String Rua do endereço
cidade Sim String Cidade do endereço
bairro Sim String Bairro do endereço
estado Sim String Sigla do estado do endereço
numero Sim String Número do endereço

Descrição campos 'credentials'

CAMPO Obrigatório Formato Default Descrição
username Sim String Usuário do sistema
ESTADO-OAB[-LETRA]
password Sim String Senha do sistema
hash Sim (se a credencial estiver salva no nosso cofre) String hash gerado pelo nosso cofre