Listar parceiros financeiros

curl --request GET \
  --url https://api.juridiq.com.br/financial/partners \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

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

{
  "data": [
    {
      "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>"
    }
  ],
  "totalResults": 123,
  "totalPages": 123
}

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

GET

financial

partners

Listar parceiros financeiros

curl --request GET \
  --url https://api.juridiq.com.br/financial/partners \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

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

{
  "data": [
    {
      "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>"
    }
  ],
  "totalResults": 123,
  "totalPages": 123
}

{
  "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).

Query Parameters

page

string

Página

limit

string

Itens por página

name

string

Filtra por nome de exibição

lawsuitSearch

string

Parceiros com processo (número ou código) contendo o termo

transactionDescription

string

Parceiros com lançamento cuja descrição contém o termo

oabStatus

enum<string>

Situação da OAB

Available options:

active,

inactive,

suspended

practiceType

enum<string>

Tipo de atuação

Available options:

correspondent,

partner,

associated,

expert,

dispatcher,

translator,

other

commissionType

enum<string>

Tipo de comissão

Available options:

FIXED,

PERCENTAGE,

FIXED_AND_PERCENTAGE

excludeInactive

enum<string>

true = omite parceiros com status inactive (select de processo)

Available options:

true,

false

orderByField

enum<string>

Campo de ordenação (default updatedAt)

Available options:

name,

updatedAt

orderBy

enum<string>

Direção (default desc)

Available options:

asc,

desc

Response

Default Response

data

object[]

required

Parceiros

Show child attributes

totalResults

number

required

Total de registros

totalPages

number

required

Total de páginas

Primeiros Passos

API Reference

Listar parceiros financeiros

Authorizations

Query Parameters

Response