Criar parceiro financeiro

curl --request POST \
  --url https://api.juridiq.com.br/financial/partners \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "photoUrl": "<string>",
  "document": "<string>",
  "phone": "<string>",
  "email": "jsmith@example.com",
  "oabNumber": "<string>",
  "oabState": "<string>",
  "pixKey": "<string>",
  "city": "<string>",
  "state": "<string>",
  "observation": "<string>",
  "percentage": 123,
  "fixedValue": 123
}
'

import requests

url = "https://api.juridiq.com.br/financial/partners"

payload = {
    "name": "<string>",
    "photoUrl": "<string>",
    "document": "<string>",
    "phone": "<string>",
    "email": "jsmith@example.com",
    "oabNumber": "<string>",
    "oabState": "<string>",
    "pixKey": "<string>",
    "city": "<string>",
    "state": "<string>",
    "observation": "<string>",
    "percentage": 123,
    "fixedValue": 123
}
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>',
    photoUrl: '<string>',
    document: '<string>',
    phone: '<string>',
    email: 'jsmith@example.com',
    oabNumber: '<string>',
    oabState: '<string>',
    pixKey: '<string>',
    city: '<string>',
    state: '<string>',
    observation: '<string>',
    percentage: 123,
    fixedValue: 123
  })
};

fetch('https://api.juridiq.com.br/financial/partners', 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/financial/partners",
  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>',
    'photoUrl' => '<string>',
    'document' => '<string>',
    'phone' => '<string>',
    'email' => 'jsmith@example.com',
    'oabNumber' => '<string>',
    'oabState' => '<string>',
    'pixKey' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'observation' => '<string>',
    'percentage' => 123,
    'fixedValue' => 123
  ]),
  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/financial/partners"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"photoUrl\": \"<string>\",\n  \"document\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"oabNumber\": \"<string>\",\n  \"oabState\": \"<string>\",\n  \"pixKey\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"observation\": \"<string>\",\n  \"percentage\": 123,\n  \"fixedValue\": 123\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/financial/partners")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"photoUrl\": \"<string>\",\n  \"document\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"oabNumber\": \"<string>\",\n  \"oabState\": \"<string>\",\n  \"pixKey\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"observation\": \"<string>\",\n  \"percentage\": 123,\n  \"fixedValue\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"photoUrl\": \"<string>\",\n  \"document\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"oabNumber\": \"<string>\",\n  \"oabState\": \"<string>\",\n  \"pixKey\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"observation\": \"<string>\",\n  \"percentage\": 123,\n  \"fixedValue\": 123\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "photoUrl": "<string>",
  "personType": "PF",
  "document": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "oabNumber": "<string>",
  "oabState": "<string>",
  "oabStatus": "active",
  "practiceType": "correspondent",
  "pixKeyType": "cpf",
  "pixKey": "<string>",
  "pixHolderName": "<string>",
  "city": "<string>",
  "state": "<string>",
  "status": "active",
  "observation": "<string>",
  "commissionType": "FIXED",
  "percentage": 123,
  "fixedValue": 123,
  "commissionPaid": 123,
  "commissionTotal": 123,
  "lawSuitCount": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

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

POST

financial

partners

Criar parceiro financeiro

curl --request POST \
  --url https://api.juridiq.com.br/financial/partners \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "photoUrl": "<string>",
  "document": "<string>",
  "phone": "<string>",
  "email": "jsmith@example.com",
  "oabNumber": "<string>",
  "oabState": "<string>",
  "pixKey": "<string>",
  "city": "<string>",
  "state": "<string>",
  "observation": "<string>",
  "percentage": 123,
  "fixedValue": 123
}
'

import requests

url = "https://api.juridiq.com.br/financial/partners"

payload = {
    "name": "<string>",
    "photoUrl": "<string>",
    "document": "<string>",
    "phone": "<string>",
    "email": "jsmith@example.com",
    "oabNumber": "<string>",
    "oabState": "<string>",
    "pixKey": "<string>",
    "city": "<string>",
    "state": "<string>",
    "observation": "<string>",
    "percentage": 123,
    "fixedValue": 123
}
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>',
    photoUrl: '<string>',
    document: '<string>',
    phone: '<string>',
    email: 'jsmith@example.com',
    oabNumber: '<string>',
    oabState: '<string>',
    pixKey: '<string>',
    city: '<string>',
    state: '<string>',
    observation: '<string>',
    percentage: 123,
    fixedValue: 123
  })
};

fetch('https://api.juridiq.com.br/financial/partners', 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/financial/partners",
  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>',
    'photoUrl' => '<string>',
    'document' => '<string>',
    'phone' => '<string>',
    'email' => 'jsmith@example.com',
    'oabNumber' => '<string>',
    'oabState' => '<string>',
    'pixKey' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'observation' => '<string>',
    'percentage' => 123,
    'fixedValue' => 123
  ]),
  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/financial/partners"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"photoUrl\": \"<string>\",\n  \"document\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"oabNumber\": \"<string>\",\n  \"oabState\": \"<string>\",\n  \"pixKey\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"observation\": \"<string>\",\n  \"percentage\": 123,\n  \"fixedValue\": 123\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/financial/partners")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"photoUrl\": \"<string>\",\n  \"document\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"oabNumber\": \"<string>\",\n  \"oabState\": \"<string>\",\n  \"pixKey\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"observation\": \"<string>\",\n  \"percentage\": 123,\n  \"fixedValue\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"photoUrl\": \"<string>\",\n  \"document\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"oabNumber\": \"<string>\",\n  \"oabState\": \"<string>\",\n  \"pixKey\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"observation\": \"<string>\",\n  \"percentage\": 123,\n  \"fixedValue\": 123\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "photoUrl": "<string>",
  "personType": "PF",
  "document": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "oabNumber": "<string>",
  "oabState": "<string>",
  "oabStatus": "active",
  "practiceType": "correspondent",
  "pixKeyType": "cpf",
  "pixKey": "<string>",
  "pixHolderName": "<string>",
  "city": "<string>",
  "state": "<string>",
  "status": "active",
  "observation": "<string>",
  "commissionType": "FIXED",
  "percentage": 123,
  "fixedValue": 123,
  "commissionPaid": 123,
  "commissionTotal": 123,
  "lawSuitCount": 123,
  "createdAt": "<string>",
  "updatedAt": "<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 de exibição

Required string length: 1 - 255

commissionType

enum<string>

required

Tipo de comissão

Available options:

FIXED,

PERCENTAGE,

FIXED_AND_PERCENTAGE

photoUrl

URL da foto

Maximum string length: 2048

personType

PF ou PJ

Available options:

PF,

PJ

document

CPF ou CNPJ

Maximum string length: 32

phone

Telefone

Maximum string length: 32

E-mail

Maximum string length: 255

oabNumber

Número da OAB

Maximum string length: 32

oabState

UF da OAB

Required string length: 2

oabStatus

Situação da OAB

Available options:

active,

inactive,

suspended

practiceType

Tipo de atuação

Available options:

correspondent,

partner,

associated,

expert,

dispatcher,

translator,

other

pixKeyType

Tipo da chave PIX

Available options:

cpf,

cnpj,

email,

phone,

random

pixKey

Chave PIX

Maximum string length: 255

city

Cidade da comarca

Maximum string length: 255

state

UF da comarca

Required string length: 2

observation

Observação interna do escritório

Maximum string length: 5000

percentage

number | null

Percentual

fixedValue

number | null

Valor fixo

Response

Default Response

string<uuid>

required

ID do parceiro

name

string

required

Nome de exibição

photoUrl

string | null

required

URL da foto

personType

enum<string> | null

required

PF ou PJ

Available options:

PF,

PJ

document

string | null

required

CPF ou CNPJ

phone

string | null

required

Telefone

string | null

required

E-mail

oabNumber

string | null

required

Número da OAB

oabState

string | null

required

UF da OAB

oabStatus

enum<string> | null

required

Situação da OAB

Available options:

active,

inactive,

suspended

practiceType

enum<string> | null

required

Tipo de atuação

Available options:

correspondent,

partner,

associated,

expert,

dispatcher,

translator,

other

pixKeyType

enum<string> | null

required

Tipo da chave PIX

Available options:

cpf,

cnpj,

email,

phone,

random

pixKey

string | null

required

Chave PIX

pixHolderName

string | null

required

Titular da chave PIX

city

string | null

required

Cidade da comarca

state

string | null

required

UF da comarca

status

enum<string>

required

Status de gestão

Available options:

active,

under_review,

blocked,

inactive

observation

string | null

required

Observação interna do escritório

commissionType

enum<string>

required

Tipo de comissão

Available options:

FIXED,

PERCENTAGE,

FIXED_AND_PERCENTAGE

percentage

number | null

required

Percentual

fixedValue

number | null

required

Valor fixo

commissionPaid

number

required

Comissão paga

commissionTotal

number

required

Comissão total

lawSuitCount

number

required

Quantidade de processos vinculados

createdAt

required

Criado em

updatedAt

required

Atualizado em

Primeiros Passos

API Reference

Criar parceiro financeiro

Authorizations

Body

Response