Criar usuário

curl --request POST \
  --url https://api.juridiq.com.br/user/ \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "jsmith@example.com",
  "password": "<string>",
  "document": "<string>",
  "contact": "<string>",
  "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "<string>",
  "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "admissionDate": "<string>",
  "resignationDate": "<string>",
  "dateOfBirth": "<string>",
  "ctpsNumber": "<string>",
  "imageUrl": "<string>",
  "oabNumber": "<string>",
  "personType": "<string>",
  "salary": "<string>",
  "description": "<string>",
  "postalCode": "<string>",
  "addressNumber": "<string>",
  "kanbanBoardsIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://api.juridiq.com.br/user/"

payload = {
    "name": "<string>",
    "email": "jsmith@example.com",
    "password": "<string>",
    "document": "<string>",
    "contact": "<string>",
    "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "role": "<string>",
    "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "admissionDate": "<string>",
    "resignationDate": "<string>",
    "dateOfBirth": "<string>",
    "ctpsNumber": "<string>",
    "imageUrl": "<string>",
    "oabNumber": "<string>",
    "personType": "<string>",
    "salary": "<string>",
    "description": "<string>",
    "postalCode": "<string>",
    "addressNumber": "<string>",
    "kanbanBoardsIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "x-juridiq-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    email: 'jsmith@example.com',
    password: '<string>',
    document: '<string>',
    contact: '<string>',
    profileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    role: '<string>',
    officeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    admissionDate: '<string>',
    resignationDate: '<string>',
    dateOfBirth: '<string>',
    ctpsNumber: '<string>',
    imageUrl: '<string>',
    oabNumber: '<string>',
    personType: '<string>',
    salary: '<string>',
    description: '<string>',
    postalCode: '<string>',
    addressNumber: '<string>',
    kanbanBoardsIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.juridiq.com.br/user/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/user/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'email' => 'jsmith@example.com',
    'password' => '<string>',
    'document' => '<string>',
    'contact' => '<string>',
    'profileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'role' => '<string>',
    'officeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'admissionDate' => '<string>',
    'resignationDate' => '<string>',
    'dateOfBirth' => '<string>',
    'ctpsNumber' => '<string>',
    'imageUrl' => '<string>',
    'oabNumber' => '<string>',
    'personType' => '<string>',
    'salary' => '<string>',
    'description' => '<string>',
    'postalCode' => '<string>',
    'addressNumber' => '<string>',
    'kanbanBoardsIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/user/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"document\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"<string>\",\n  \"officeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"admissionDate\": \"<string>\",\n  \"resignationDate\": \"<string>\",\n  \"dateOfBirth\": \"<string>\",\n  \"ctpsNumber\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"oabNumber\": \"<string>\",\n  \"personType\": \"<string>\",\n  \"salary\": \"<string>\",\n  \"description\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"addressNumber\": \"<string>\",\n  \"kanbanBoardsIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-juridiq-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.juridiq.com.br/user/")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"document\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"<string>\",\n  \"officeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"admissionDate\": \"<string>\",\n  \"resignationDate\": \"<string>\",\n  \"dateOfBirth\": \"<string>\",\n  \"ctpsNumber\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"oabNumber\": \"<string>\",\n  \"personType\": \"<string>\",\n  \"salary\": \"<string>\",\n  \"description\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"addressNumber\": \"<string>\",\n  \"kanbanBoardsIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/user/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"document\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"<string>\",\n  \"officeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"admissionDate\": \"<string>\",\n  \"resignationDate\": \"<string>\",\n  \"dateOfBirth\": \"<string>\",\n  \"ctpsNumber\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"oabNumber\": \"<string>\",\n  \"personType\": \"<string>\",\n  \"salary\": \"<string>\",\n  \"description\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"addressNumber\": \"<string>\",\n  \"kanbanBoardsIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "role": "<string>",
  "officeId": "<string>",
  "profile": {
    "id": "<string>",
    "name": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "hasGoogleLinked": true,
  "hasPassword": true,
  "document": "<string>",
  "contact": "<string>",
  "admissionDate": "<string>",
  "resignationDate": "<string>",
  "dateOfBirth": "<string>",
  "ctpsNumber": "<string>",
  "imageUrl": "<string>",
  "oabNumber": "<string>",
  "personType": "<string>",
  "salary": "<string>",
  "description": "<string>",
  "postalCode": "<string>",
  "addressNumber": "<string>",
  "firstLogin": true,
  "showBannerAsaas": true,
  "referralToken": "<string>",
  "googleIntegrationType": "full-sync",
  "googleEmail": "<string>",
  "calendarColor": "<string>",
  "calendarSharing": "NONE"
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Users

Criar usuário

Cria um usuário no escritório da chave. O e-mail é único entre todos os escritórios (um usuário excluído que ainda pode ser restaurado também ocupa o e-mail). O profileId precisa ser um perfil deste escritório; officeId é opcional e, se enviado, precisa ser o do escritório da chave. document vazio é aceito; preenchido, segue personType: PF ou Pessoa Física exige CPF de 11 dígitos, PJ ou Pessoa Jurídica exige CNPJ de 14 caracteres e, sem personType, vale um dos dois. A descrição do colaborador orienta a IA na escolha do responsável.

POST

user

Criar usuário

curl --request POST \
  --url https://api.juridiq.com.br/user/ \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "jsmith@example.com",
  "password": "<string>",
  "document": "<string>",
  "contact": "<string>",
  "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "<string>",
  "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "admissionDate": "<string>",
  "resignationDate": "<string>",
  "dateOfBirth": "<string>",
  "ctpsNumber": "<string>",
  "imageUrl": "<string>",
  "oabNumber": "<string>",
  "personType": "<string>",
  "salary": "<string>",
  "description": "<string>",
  "postalCode": "<string>",
  "addressNumber": "<string>",
  "kanbanBoardsIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://api.juridiq.com.br/user/"

payload = {
    "name": "<string>",
    "email": "jsmith@example.com",
    "password": "<string>",
    "document": "<string>",
    "contact": "<string>",
    "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "role": "<string>",
    "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "admissionDate": "<string>",
    "resignationDate": "<string>",
    "dateOfBirth": "<string>",
    "ctpsNumber": "<string>",
    "imageUrl": "<string>",
    "oabNumber": "<string>",
    "personType": "<string>",
    "salary": "<string>",
    "description": "<string>",
    "postalCode": "<string>",
    "addressNumber": "<string>",
    "kanbanBoardsIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "x-juridiq-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    email: 'jsmith@example.com',
    password: '<string>',
    document: '<string>',
    contact: '<string>',
    profileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    role: '<string>',
    officeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    admissionDate: '<string>',
    resignationDate: '<string>',
    dateOfBirth: '<string>',
    ctpsNumber: '<string>',
    imageUrl: '<string>',
    oabNumber: '<string>',
    personType: '<string>',
    salary: '<string>',
    description: '<string>',
    postalCode: '<string>',
    addressNumber: '<string>',
    kanbanBoardsIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.juridiq.com.br/user/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/user/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'email' => 'jsmith@example.com',
    'password' => '<string>',
    'document' => '<string>',
    'contact' => '<string>',
    'profileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'role' => '<string>',
    'officeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'admissionDate' => '<string>',
    'resignationDate' => '<string>',
    'dateOfBirth' => '<string>',
    'ctpsNumber' => '<string>',
    'imageUrl' => '<string>',
    'oabNumber' => '<string>',
    'personType' => '<string>',
    'salary' => '<string>',
    'description' => '<string>',
    'postalCode' => '<string>',
    'addressNumber' => '<string>',
    'kanbanBoardsIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/user/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"document\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"<string>\",\n  \"officeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"admissionDate\": \"<string>\",\n  \"resignationDate\": \"<string>\",\n  \"dateOfBirth\": \"<string>\",\n  \"ctpsNumber\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"oabNumber\": \"<string>\",\n  \"personType\": \"<string>\",\n  \"salary\": \"<string>\",\n  \"description\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"addressNumber\": \"<string>\",\n  \"kanbanBoardsIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-juridiq-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.juridiq.com.br/user/")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"document\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"<string>\",\n  \"officeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"admissionDate\": \"<string>\",\n  \"resignationDate\": \"<string>\",\n  \"dateOfBirth\": \"<string>\",\n  \"ctpsNumber\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"oabNumber\": \"<string>\",\n  \"personType\": \"<string>\",\n  \"salary\": \"<string>\",\n  \"description\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"addressNumber\": \"<string>\",\n  \"kanbanBoardsIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/user/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"document\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"role\": \"<string>\",\n  \"officeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"admissionDate\": \"<string>\",\n  \"resignationDate\": \"<string>\",\n  \"dateOfBirth\": \"<string>\",\n  \"ctpsNumber\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"oabNumber\": \"<string>\",\n  \"personType\": \"<string>\",\n  \"salary\": \"<string>\",\n  \"description\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"addressNumber\": \"<string>\",\n  \"kanbanBoardsIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "role": "<string>",
  "officeId": "<string>",
  "profile": {
    "id": "<string>",
    "name": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "hasGoogleLinked": true,
  "hasPassword": true,
  "document": "<string>",
  "contact": "<string>",
  "admissionDate": "<string>",
  "resignationDate": "<string>",
  "dateOfBirth": "<string>",
  "ctpsNumber": "<string>",
  "imageUrl": "<string>",
  "oabNumber": "<string>",
  "personType": "<string>",
  "salary": "<string>",
  "description": "<string>",
  "postalCode": "<string>",
  "addressNumber": "<string>",
  "firstLogin": true,
  "showBannerAsaas": true,
  "referralToken": "<string>",
  "googleIntegrationType": "full-sync",
  "googleEmail": "<string>",
  "calendarColor": "<string>",
  "calendarSharing": "NONE"
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Authorizations

x-juridiq-api-key

string

header

required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a documentação de integradores).

Body

application/json

name

string

required

Nome completo

Minimum string length: 1

string<email>

required

E-mail de login

password

string

required

Senha de acesso

Minimum string length: 1

document

string

required

CPF ou CNPJ

contact

string

required

Telefone ou contato

profileId

string<uuid>

required

ID do perfil de permissões

role

string

Cargo no escritório

officeId

string<uuid>

ID do escritório

admissionDate

string

Data de admissão

resignationDate

string

Data de demissão

dateOfBirth

string

Data de nascimento

ctpsNumber

string

Número da CTPS

imageUrl

string

URL da foto

oabNumber

string

Número da OAB

personType

string

Tipo de pessoa: PF ou PJ

salary

string

Salário

description

string | null

Descrição do colaborador: funções, áreas de atuação e tipos de caso que assume. Até 1000 caracteres; espaços nas pontas são removidos e texto em branco grava nulo

Maximum string length: 1000

postalCode

string

CEP

addressNumber

string

Número do endereço

kanbanBoardsIds

string<uuid>[]

IDs dos quadros Kanban

Response

Default Response

string

required

ID do usuário

name

string

required

Nome completo

string

required

E-mail de login

role

string

required

Cargo no escritório

officeId

string

required

ID do escritório

profile

object

required

Show child attributes

createdAt

string

required

Data de criação (ISO 8601)

updatedAt

string

required

Data da última alteração (ISO 8601)

hasGoogleLinked

boolean

required

Possui conta Google vinculada

hasPassword

boolean

required

Possui senha cadastrada

document

string | null

CPF ou CNPJ

contact

string | null

Telefone ou contato

admissionDate

string | null

Data de admissão

resignationDate

string | null

Data de demissão

dateOfBirth

string | null

Data de nascimento

ctpsNumber

string | null

Número da CTPS

imageUrl

string | null

URL da foto

oabNumber

string | null

Número da OAB

personType

string | null

Tipo de pessoa: PF ou PJ

salary

string | null

Salário

description

string | null

Descrição do colaborador: funções, áreas de atuação e tipos de caso que assume. Use para sugerir o responsável de tarefas e processos

postalCode

string | null

CEP

addressNumber

string | null

Número do endereço

Primeiro acesso pendente

showBannerAsaas

boolean | null

Exibir banner Asaas

referralToken

string | null

Token de indicação

googleIntegrationType

enum<string> | null

Tipo de integração Google

Available options:

full-sync

googleEmail

string | null

E-mail da conta Google vinculada

calendarColor

string | null

Cor da agenda do usuário (hex); null = sem cor

O que os colegas veem da agenda: NONE, FREE_BUSY ("Ocupado"), READ ou WRITE (com edição); ausente = WRITE

Available options:

NONE,

FREE_BUSY,

READ,

WRITE

Primeiros Passos

API Reference

Criar usuário

Authorizations

Body

Response