Pessoas

Criar pessoa (cliente/parte/advogado)

POST · API de Integração v2

POST/v2/pessoas

Criar pessoa

Cria uma pessoa (cliente, parte contrária, advogado, colaborador etc.) vinculada ao seu escritório.

Identidade: o escritório e o usuário criador são resolvidos automaticamente a partir da sua chave de API — não vão no corpo.

Obrigatório: apenas nome. Todo o resto é opcional.

Escopo atual: dados próprios da pessoa, representante legal, controle de acesso (responsáveis/equipes) e campos personalizados.

CAMPOS DO CORPO — CriarPessoaRequest
Campo	Validação	Descrição	Exemplo	Regras
nome	@NotBlank	Nome da pessoa.	João da Silva	Obrigatório; máx. 255 caracteres.
apelido	-	Apelido / nome curto.	João	Opcional.
classificacao	enum	Papel da pessoa.	CLIENTE	Opcional (default CLIENTE). Um de: CLIENTE, PARTE_CONTRARIA, ADVOGADO, COLABORADOR, OUTRO, CORRESPONDENTE, ADVOGADO_CONTRARIO, TESTEMUNHA.
naturezaPessoa	enum	Física ou jurídica.	FISICA	Opcional. Um de: FISICA, JURIDICA. Sem regra condicional no v1.
cpfCnpj	CPF/CNPJ válido	Documento (com ou sem máscara).	000.000.000-00	Opcional. Se informado, precisa ser válido e não duplicado para o cliente.
oab	-	Número da OAB.	123456/SP	Opcional.
avatarUrl	http(s)	URL da foto — link, sem upload.	https://exemplo.com/foto.jpg	Opcional.
contatos	@Valid	Telefones, e-mail, redes sociais.	{ objeto }	Opcional.
documentos	@Valid	Dados pessoais/documentais (RG, nascimento, estado civil etc.).	{ objeto }	Opcional.
endereco	@Valid	Endereço.	{ objeto }	Opcional.
complementos	@Valid	Valor/hora, indicação, grupo de empresas, observações.	{ objeto }	Opcional.
representante	@Valid	Representante legal (nome, documento, RG, nascimento, endereço).	{ objeto }	Opcional. Se informado, `representante.nome` é obrigatório (máx. 100 caracteres).
controleAcesso	@Valid	Responsáveis e equipes que podem acessar/gerenciar o cadastro.	{ objeto }	Opcional. `responsaveisIds` precisam ser usuários ativos do cliente; `equipesIds` precisam existir no cliente — inválidos → 400.
camposPersonalizados	@Valid	Valores dos campos personalizados do escritório (definições com `type=pessoa`).	[ { "campoId": 12, "valores": ["João"] } ]	Opcional. Referência por `campoId`; campo inexistente/de outro escritório/de tipo `processo` → 400.

Como enviar campos personalizados: cada item referencia a definição por campoId (liste os campos do escritório em GET /v2/campos-personalizados/opcoes?type=PESSOA) e traz valores sempre como lista, mesmo quando é um valor só.

Valor único (texto, número, data, seleção, escolha única, texto longo) → lista de 1 item: { "campoId": 12, "valores": ["João da Silva"] }.

Múltipla escolha (checkbox) → vários itens: { "campoId": 21, "valores": ["Opção A", "Opção C"] }.

Exemplo do bloco: "camposPersonalizados": [ { "campoId": 12, "valores": ["João da Silva"] }, { "campoId": 21, "valores": ["Opção A", "Opção C"] } ].

O campoId precisa existir, ser do seu escritório e do tipo pessoa — senão a criação inteira é rejeitada com 400.

Autenticação

X-API-Key no cabeçalho. Como autenticar

Corpo da requisiçãoobrigatório

Dados da pessoa a criar (ver tabela de campos na descrição).

application/json

apelidostring

Apelido / nome curto

exemplo: João

avatarUrlstring

URL pública HTTP(S) da foto — link, sem upload

até 2048 caracteresregex: ^[hH][tT][tT][pP][sS]?://[^\s]+$exemplo: https://exemplo.com/foto.jpg

camposPersonalizadosCampoPersonalizadoRequest[]

Campos personalizados (definições com type=pessoa). Cada item referencia o campoId da definição e traz seus valores.

Ver propriedades

campoIdintegerobrigatório

ID da definição do campo (de GET /v2/campos-personalizados/opcoes?type=PESSOA)

formato: int64exemplo: 12

valoresstring[]

Valores do campo, SEMPRE como lista: 1 item para valor único (texto/número/data/seleção/escolha única/texto longo) ou vários para múltipla escolha (checkbox).

exemplo: ["Opção A","Opção C"]

classificacaostring

Deprecated — use tipoId. Só alcança os 8 tipos globais; ignorado quando tipoId vem junto.

valores: ADVOGADO · ADVOGADO_CONTRARIO · CLIENTE · COLABORADOR · CORRESPONDENTE · OUTRO · PARTE_CONTRARIA · TESTEMUNHAexemplo: CLIENTE

complementosComplementosRequest

Ver propriedades

grupoEmpresasIdinteger

ID do grupo de empresas

formato: int64

indicacaoIdinteger

ID da indicação. Legado — prefira indicacoes. Continua aceito para quem já o envia; vindo junto de indicacoes, só é aceito se apontar para a mais antiga do conjunto.

formato: int64

indicacoesIndicacaoRequest[]

Indicações da pessoa, cada uma com observação própria. Sem ordem e sem principal — a lista é exibida inteira.

Ver propriedades

indicacaoIdintegerobrigatório

ID da indicação. Ids de GET /v2/indicacoes.

formato: int64exemplo: 42

obsstring

Observação sobre esta indicação

até 255 caracteresexemplo: Indicou na audiência de conciliação

observacoesstring

Observações

valorHoranumber

Valor da hora

exemplo: 250

contatosContatosRequest

Ver propriedades

emailstring

E-mail

exemplo: joao@exemplo.com

facebookstring

Perfil do Facebook

instagramstring

Perfil do Instagram

linkedinstring

Perfil do LinkedIn

sitestring

Site

telefone03string

Terceiro telefone

telefonePrincipalstring

Telefone principal

exemplo: (81) 99999-9999

telefoneSecundariostring

Telefone secundário

controleAcessoControleAcessoRequest

Ver propriedades

equipesIdsinteger[]

IDs das equipes. Ids de /v2/equipes/opcoes.

exemplo: [406]

responsaveisIdsinteger[]

IDs dos responsáveis. Ids de /v2/usuarios/opcoes.

exemplo: [1649]

cpfCnpjstring

CPF ou CNPJ (com ou sem máscara)

exemplo: 000.000.000-00

documentosDocumentosRequest

Ver propriedades

cidstring

CID

ctpsstring

CTPS

dataEmissaoRgstring

Data de emissão do RG

dataNascimentostring

Data de nascimento

exemplo: 1990-01-31

estadoCivilstring

Estado civil

nacionalidadestring

Nacionalidade

naturalidadestring

Naturalidade

nomeMaestring

Nome da mãe

nomePaistring

Nome do pai

orgaoEmissorRgstring

Órgão emissor do RG

pisstring

PIS

profissaostring

Profissão

rgstring

sexostring

Sexo

enderecoEnderecoRequest

Ver propriedades

bairrostring

Bairro

cepstring

CEP

exemplo: 50000-000

cidadestring

Cidade

complementostring

Complemento

estadostring

UF (duas letras)

até 2 caracteresregex: ^[a-zA-Z]{2}$exemplo: PE

logradourostring

Logradouro

numerostring

Número

naturezaPessoastring

Natureza da pessoa (opcional, sem regra condicional no v1)

valores: FISICA · JURIDICAexemplo: FISICA

nomestringobrigatório

Nome da pessoa

exemplo: João da Silva

oabstring

Número da OAB

representanteRepresentanteRequest

Ver propriedades

bairrostring

Bairro do representante

cepstring

CEP do representante

cidadestring

Cidade do representante

documentostring

Documento do representante (livre, sem validação de formato no v1)

enderecostring

Endereço do representante (string única, sem separar número/complemento)

estadostring

Estado (UF) do representante, duas letras

até 2 caracteresregex: ^[a-zA-Z]{2}$exemplo: PE

nascimentostring

Data de nascimento do representante

nomestringobrigatório

Nome do representante

rgstring

RG do representante

tipoIdinteger

ID do tipo de pessoa. Use os ids de GET /v2/pessoas/tipos. Default: 1 (Cliente).

formato: int64exemplo: 12

Respostas3

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo declarado no OpenAPI · application/json

Exemplo · HTTP 200

{
  "id": 863210,
  "nome": "João da Silva",
  "classificacao": "CLIENTE",
  "naturezaPessoa": null,
  "cpfCnpj": "00000000000",
  "contatos": {},
  "documentos": {},
  "endereco": {},
  "complementos": {},
  "camposPersonalizados": [
    {
      "campoId": 12,
      "valores": [
        "João da Silva"
      ]
    },
    {
      "campoId": 21,
      "valores": [
        "Opção A",
        "Opção C"
      ]
    }
  ]
}

Contrato de respostas

200Pessoa criada.

Pessoa criada.

application/json

apelidostring

Apelido ou nome curto

exemplo: João

avatarUrlstring

URL do avatar

camposPersonalizadosCampoPersonalizadoResponse[]

Campos personalizados gravados

Ver propriedades

campoIdinteger

ID da definição do campo personalizado

formato: int64exemplo: 12

valoresstring[]

Valores gravados para o campo

exemplo: ["Opção A"]

classificacaostring

Deprecated — use tipoNome para exibir e tipoId para identificar. Só é preenchido nos 8 tipos globais; tipo do escritório vem null.

exemplo: CLIENTE

complementosComplementosResponse

Ver propriedades

grupoEmpresasIdinteger

ID do grupo de empresas

formato: int64

indicacaoIdinteger

ID da indicação. Legado — use indicacoes. É a projeção da mais antiga do conjunto: quem tem três indicações aparece aqui com uma só.

formato: int64

indicacoesIndicacaoResponse[]

Indicações da pessoa, da mais antiga para a mais recente.

Ver propriedades

indicacaoIdinteger

ID da indicação

formato: int64exemplo: 42

obsstring

Observação sobre esta indicação

observacoesstring

Observações

valorHoranumber

Valor da hora

exemplo: 250

contatosContatosResponse

Ver propriedades

emailstring

E-mail

exemplo: joao@exemplo.com

facebookstring

Perfil do Facebook

instagramstring

Perfil do Instagram

linkedinstring

Perfil do LinkedIn

sitestring

Site

telefone03string

Terceiro telefone

telefonePrincipalstring

Telefone principal

exemplo: (81) 99999-9999

telefoneSecundariostring

Telefone secundário

controleAcessoControleAcessoResponse

Ver propriedades

equipesIdsinteger[]

IDs das equipes vinculadas

exemplo: [406]

responsaveisIdsinteger[]

IDs dos responsáveis vinculados

exemplo: [1649]

cpfCnpjstring

CPF ou CNPJ informado

exemplo: 000.000.000-00

documentosDocumentosResponse

Ver propriedades

cidstring

CID

ctpsstring

CTPS

dataEmissaoRgstring

Data de emissão do RG

dataNascimentostring

Data de nascimento

exemplo: 1990-01-31

estadoCivilstring

Estado civil

nacionalidadestring

Nacionalidade

naturalidadestring

Naturalidade

nomeMaestring

Nome da mãe

nomePaistring

Nome do pai

orgaoEmissorRgstring

Órgão emissor do RG

pisstring

PIS

profissaostring

Profissão

rgstring

sexostring

Sexo

enderecoEnderecoResponse

Ver propriedades

bairrostring

Bairro

cepstring

CEP

exemplo: 50000-000

cidadestring

Cidade

complementostring

Complemento

estadostring

exemplo: PE

logradourostring

Logradouro

numerostring

Número

idinteger

Identificador da pessoa criada

formato: int64exemplo: 123

naturezaPessoastring

Natureza da pessoa

exemplo: FISICA

nomestring

Nome da pessoa

exemplo: João da Silva

oabstring

Número da OAB

representanteRepresentanteResponse

Ver propriedades

bairrostring

Bairro do representante

cepstring

CEP do representante

cidadestring

Cidade do representante

documentostring

Documento do representante

enderecostring

Endereço do representante

estadostring

UF do representante

exemplo: PE

nascimentostring

Data de nascimento do representante

exemplo: 1990-01-31

nomestring

Nome do representante

rgstring

RG do representante

tipoIdinteger

ID do tipo no catálogo (GET /v2/pessoas/tipos)

formato: int64exemplo: 12

tipoNomestring

Nome do tipo, para exibir

exemplo: Curador

400Payload inválido (erro de validação).

Payload inválido (erro de validação).

O contrato não declara um corpo para esta resposta.

401Não autenticado (token ausente/inválido).

Não autenticado (token ausente/inválido).

O contrato não declara um corpo para esta resposta.

curl --request POST \
  --url 'https://api.expedit.com.br/v2/pessoas' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

Requisição e resposta

As chamadas são enviadas diretamente à API. O domínio deste portal precisa estar autorizado no CORS.

Ver JSON gerado

Corpo gerado dos campos

{}

A resposta aparecerá aquiPreencha os campos e envie a requisição para consultar o retorno da API.

Explorar exemplos de resposta

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo declarado no OpenAPI · application/json

Exemplo · HTTP 200

{
  "id": 863210,
  "nome": "João da Silva",
  "classificacao": "CLIENTE",
  "naturezaPessoa": null,
  "cpfCnpj": "00000000000",
  "contatos": {},
  "documentos": {},
  "endereco": {},
  "complementos": {},
  "camposPersonalizados": [
    {
      "campoId": 12,
      "valores": [
        "João da Silva"
      ]
    },
    {
      "campoId": 21,
      "valores": [
        "Opção A",
        "Opção C"
      ]
    }
  ]
}

Exemplos e campos gerados do contrato OpenAPI. Revise os valores antes de integrar.