MENU navbar-image

Introdução

Essa documentação prove as informações necessárias para trabalhar com a nossa API.

Autenticação

Para autenticar as requisições, inclua no header Authorization o "Bearer {SEU TOKEN}".

Todos os endpoints que requerem autenticação estão marcados com requer autenticação na documentação.

Para obter um token use o endpoint /login e utilize o atributo access_token.

Login

POST login

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": null,
    "password": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/login',
    [
        'headers' => [
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'email' => null,
            'password' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/login'
payload = {
    "email": null,
    "password": null
}
headers = {
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST login

Headers

Content-Type      

Ex: application/json

Parâmetros do body

email   string   

Deve ser um endereço de e-mail válido.

password   string   

POST login/sso/{provider}

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/login/sso/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "access_token": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/login/sso/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'access_token' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/login/sso/10'
payload = {
    "access_token": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST login/sso/{provider}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

provider   integer   

Ex: 10

Parâmetros do body

access_token   string   

POST login/validate-captcha

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/login/validate-captcha"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/login/validate-captcha',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'token' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/login/validate-captcha'
payload = {
    "token": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST login/validate-captcha

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

token   string   

Carteira (Pré pago)

Deposita créditos na carteira de um cliente pré pago

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/wallets/deposits"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "amount": null,
    "payment_method": null,
    "send_email_after_approved": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/wallets/deposits',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'amount' => null,
            'payment_method' => null,
            'send_email_after_approved' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/wallets/deposits'
payload = {
    "amount": null,
    "payment_method": null,
    "send_email_after_approved": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST wallets/deposits

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

amount   decimal   

De 0 até 2 decimais.

payment_method   string   
Deve ser um destes:
  • credit-card
  • bank-slip
  • pix
credit_card_document_number   string  opcional  

Obrigatório quando payment_method é igual a credit-card. CPF/CNPJ, apenas números.

.
credit_card_holder_name   string  opcional  

Obrigatório quando payment_method é igual a credit-card.

.
credit_card_number   string  opcional  

Obrigatório quando payment_method é igual a credit-card. Número do cartão de crédito, apenas números.

.
credit_card_cvv   string  opcional  

Obrigatório quando payment_method é igual a credit-card. Não pode ser superior a 4 caracteres.

.
credit_card_due_date   string  opcional  

Obrigatório quando payment_method é igual a credit-card. Deve ser uma data válida. Deve estar no formato Y-m. Deve ser uma data posterior ou igual a 2025-08.

.
send_email_after_approved   boolean   

Enviar email após a aprovação dos créditos? Default: true

Calcula o valor do bônus para um determinado valor de compra de créditos

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/wallets/deposits/bonus-for-value/100.59"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/wallets/deposits/bonus-for-value/100.59',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/wallets/deposits/bonus-for-value/100.59'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET wallets/deposits/bonus-for-value/{deposit_value}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

deposit_value   decimal   

Valor do depósito desejado. De 0 a 2 decimais. Ex: 100.59

Categorias de serviços

Listar as categorias de serviços

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/service-categories"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/service-categories',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/service-categories'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET service-categories

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: services

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: services.is_favorite, services.can_be_monitored

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: name, menu_order

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: services_type

Cliente

Visualizar o cliente logado

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/customers"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/customers',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/customers'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET customers

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: orders_count, automatic_ai_analysis, automatic_ai_analysis_count, automatic_ai_analysisExists, services_automatic_purchase_enabled_by_default, services_automatic_purchase_enabled_by_default_count, services_automatic_purchase_enabled_by_defaultExists, services_automatic_ai_analysis, services_automatic_ai_analysis_count, services_automatic_ai_analysisExists, services_automatic_orders_summary, services_automatic_orders_summary_count, services_automatic_orders_summaryExists, services_automatic_purchase_enabled_from_ai_analysis, services_automatic_purchase_enabled_from_ai_analysis_count, services_automatic_purchase_enabled_from_ai_analysisExists, users, users_count, usersExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: account_balance, used_storage, prepaid, total_ai_tokens_used_current_month, ai_tokens_above_limit_this_month

Atualiza os dados do cadastro do cliente

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/customers"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/customers',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/customers'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PATCH', url, headers=headers)
response.json()

Request   

PATCH customers

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros do body

phone   string  opcional  

Não pode ser superior a 20 caracteres.

address_zip_code   string  opcional  

Não pode ser superior a 8 caracteres.

address_public_place   string  opcional  

Não pode ser superior a 120 caracteres.

address_number   string  opcional  

Não pode ser superior a 8 caracteres.

address_complement   string  opcional  

Não pode ser superior a 60 caracteres.

address_neighborhood   string  opcional  

Não pode ser superior a 80 caracteres.

address_city   string  opcional  

Não pode ser superior a 120 caracteres.

address_uf   string  opcional  

Não pode ser superior a 2 caracteres.

group_mandatory_on_purchase   boolean  opcional  

Indica se deve é obgrigatório relacionar ao menos 1 grupo durante a criação da compra

Compras

Cria uma compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/purchases"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null,
    "post_payment": null,
    "groups_ids": null,
    "orders": [
        {
            "name": null,
            "service_id": null,
            "service_category_id": null,
            "detailed_service_data": null
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/purchases',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => null,
            'post_payment' => null,
            'groups_ids' => null,
            'orders' => [
                [
                    'name' => null,
                    'service_id' => null,
                    'service_category_id' => null,
                    'detailed_service_data' => null,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases'
payload = {
    "name": null,
    "post_payment": null,
    "groups_ids": null,
    "orders": [
        {
            "name": null,
            "service_id": null,
            "service_category_id": null,
            "detailed_service_data": null
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST purchases

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

name   string   

Não pode ser superior a 120 caracteres.

shipping_address_zip_code   string  opcional  

Deve ser 8 caracteres. Obrigatório quando algumas das orders tiver o formato papel ou combo

shipping_address_number   string  opcional  

Não pode ser superior a 8 caracteres. Obrigatório quando algumas das orders tiver o formato papel ou combo

shipping_address_neighborhood   string  opcional  

Não pode ser superior a 80 caracteres. Obrigatório quando algumas das orders tiver o formato papel ou combo

shipping_address_public_place   string  opcional  

Não pode ser superior a 120 caracteres. Obrigatório quando algumas das orders tiver o formato papel ou combo

shipping_address_city   string  opcional  

Não pode ser superior a 120 caracteres. Obrigatório quando algumas das orders tiver o formato papel ou combo

shipping_address_uf   string  opcional  

Não pode ser superior a 2 caracteres. Obrigatório quando algumas das orders tiver o formato papel ou combo

shipping_address_complement   string  opcional  

Não pode ser superior a 60 caracteres. Obrigatório quando algumas das orders tiver o formato papel ou combo

post_payment   boolean   

Indica se o pagamento será realizado depois (Boleto/Pix/Cartão de crédito). O pedido entra no status aguardando pagamento caso esse campo seja true. Se o pagamento for através de créditos ou por contrato, enviar false.

post_payment_method   string  opcional  

Obrigatório quando post_payment é igual a true.

. Deve ser um destes:
  • credit-card
  • bank-slip
  • pix
groups_ids   integer[]   

Os ids dos grupos que serão relacionados aos itens da compra. Consulte em link

orders   object[]   

Deve ter pelo menos 1 item.
name   string   

Não pode ser superior a 120 caracteres.

service_id   integer   

O ID do serviço. Consulte em link

service_category_id   integer   

A categoria do serviço. Está disponível nos campos do serviço.

auto_purchase_certificate_from_result_negative   boolean  opcional  
auto_purchase_certificate_from_result_positive   boolean  opcional  
detailed_service_data   object[]   

Os dados específicos do serviço vão dentro deste objeto. Consulte em link

shopping_cart_id   string  opcional  

Cada compra processada gerada um hash a partir dos dados da requisição. É feita uma validação para que não existam duas compras iguais, para evitar duplicação. Caso você deseje criar duas compras com os mesmos dados, é possível enviando valores diferentes nesse campo para cada chamada.

Cria um novo item dentro de uma compra existente

requer autenticação

Disponível apenas para clientes pós pagos

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/purchases/10/orders"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "groups_ids": null,
    "orders": [
        {
            "name": null,
            "service_id": null,
            "service_category_id": null,
            "detailed_service_data": null
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/purchases/10/orders',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'groups_ids' => null,
            'orders' => [
                [
                    'name' => null,
                    'service_id' => null,
                    'service_category_id' => null,
                    'detailed_service_data' => null,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases/10/orders'
payload = {
    "groups_ids": null,
    "orders": [
        {
            "name": null,
            "service_id": null,
            "service_category_id": null,
            "detailed_service_data": null
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST purchases/{purchase_id}/orders

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

purchase_id   integer   

O ID da compra. Ex: 10

Parâmetros do body

groups_ids   integer[]   

Os ids dos grupos que serão relacionados aos itens da compra. Consulte em link

orders   object[]   

Deve ter pelo menos 1 item.
name   string   

Não pode ser superior a 120 caracteres.

service_id   integer   

O ID do serviço. Consulte em link

service_category_id   integer   

A categoria do serviço. Está disponível nos campos do serviço.

auto_purchase_certificate_from_result_negative   boolean  opcional  
auto_purchase_certificate_from_result_positive   boolean  opcional  
detailed_service_data   object[]   

Os dados específicos do serviço vão dentro deste objeto. Consulte em link

shopping_cart_id   string  opcional  

Cada compra processada gerada um hash a partir dos dados da requisição. É feita uma validação para que não existam duas compras iguais, para evitar duplicação. Caso você deseje criar duas compras com os mesmos dados, é possível enviando valores diferentes nesse campo para cada chamada.

Visualizar uma compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/purchases/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/purchases/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET purchases/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID da compra. Ex: 10

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: orders, orders_count, ordersExists, orders.ocr, orders.groups, orders.service, first_order, first_order_count, first_orderExists, first_order.service, waiting_invoice_payment, waiting_invoice_payment_count, waiting_invoice_paymentExists, user, user_count, userExists, customer, customer_count, customerExists, quote_appraiser, quote_appraiser_count, quote_appraiserExists, recurrence, recurrence_count, recurrenceExists, orders.service_category

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: orders.ai_service_name, orders_status_count, downloadable_orders_ids, orders_count, orders_expired_count, orders_status_count, last_status_change_at, has_ai_extracted_data, has_ai_analysis_pending, orders.has_ai_extracted_data, orders.has_ai_analysis_pending, originated_from_orders, first_order.ai_service_name, orders.has_ai_extracted_data, orders.has_ai_analysis_pending, downloaded_orders_ids, downloadable_orders_ids_not_downloaded

Renomear uma compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/purchases/10/name"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/purchases/10/name',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases/10/name'
payload = {
    "name": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Request   

PATCH purchases/{purchase_id}/name

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

purchase_id   integer   

O ID da compra. Ex: 10

Parâmetros do body

name   string   

Não pode ser superior a 120 caracteres.

Listar as compras

requer autenticação

O retorno é paginado

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/purchases"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/purchases',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET purchases

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: orders, orders_count, ordersExists, orders.ocr, orders.groups, orders.service, first_order, first_order_count, first_orderExists, first_order.service, waiting_invoice_payment, waiting_invoice_payment_count, waiting_invoice_paymentExists, user, user_count, userExists, customer, customer_count, customerExists, quote_appraiser, quote_appraiser_count, quote_appraiserExists, recurrence, recurrence_count, recurrenceExists, orders.service_category

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: orders.ai_service_name, orders_status_count, downloadable_orders_ids, orders_count, orders_expired_count, orders_status_count, last_status_change_at, has_ai_extracted_data, has_ai_analysis_pending, orders.has_ai_extracted_data, orders.has_ai_analysis_pending, originated_from_orders, first_order.ai_service_name, orders.has_ai_extracted_data, orders.has_ai_analysis_pending, downloaded_orders_ids, downloadable_orders_ids_not_downloaded

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: id, name, placed_at, type

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: name_or_id_or_register, placed_between, status, orders.service_id, orders.group_id, user_id, recurrence_id, ai, automatic_generated, recurrence_generated

Aprova/rejeita um orçamento de compra

requer autenticação

Disponível apenas para clientes pós pagos

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/purchases/10/quote/"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/purchases/10/quote/',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases/10/quote/'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT purchases/{purchase_id}/quote/{quoteStatus}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

purchase_id   integer   

O ID da compra. Ex: 10

quoteStatus   string   

Deve ser um destes:

  • approve
  • reject

Parâmetros do body

quoted_rejected_reason   string  opcional  

Obrigatório quando quote_status é igual a reject. Não pode ser superior a 120 caracteres.

.

Faz download (.zip) dos arquivos de uma ou múltiplas compras.

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/purchases/123,456,789/download"
);

const params = {
    "groupBy": "register",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/purchases/123,456,789/download',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'groupBy' => 'register',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases/123,456,789/download'
params = {
  'groupBy': 'register',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET purchases/{purchases}/download

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

purchases   string   

Ids das compras desejadas. Ex: 123,456,789

Parâmetros da query

groupBy   string  opcional  

Indica se arquivos .zip devem criar a estrutura baseada na compra ou no registro do item da compra. Ex: register

Faz download do relatório de uma ou múltiplas compras.

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/purchases/123,456,789/report/"
);

const params = {
    "oneResultPerRow": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/purchases/123,456,789/report/',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'oneResultPerRow' => '0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases/123,456,789/report/'
params = {
  'oneResultPerRow': '0',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET purchases/{ids}/report/{format?}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

ids   string   

Ids das compras desejadas. Ex: 123,456,789

format   string  opcional  

Deve ser um destes:

  • xlsx
  • csv
  • json

Parâmetros da query

oneResultPerRow   boolean  opcional  

Indica se cada resultado encontrado para uma pesquisa deve ser mostrado em uma linha diferente. Ex: false

Configurações de documentos

Definir compra automática de certidões a partir de resultado de pesquisa

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/automations/automatic-purchases"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/automations/automatic-purchases',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/automations/automatic-purchases'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT automations/automatic-purchases

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros do body

services   object  opcional  

Deve ter pelo menos 0 itens.

Definir compra automática de certidões a partir de resultado de pesquisa

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/automations/automatic-ai-analysis"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "automatic_analysis_enabled": [
        {
            "service_id": null,
            "ai_model_id": null
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/automations/automatic-ai-analysis',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'automatic_analysis_enabled' => [
                [
                    'service_id' => null,
                    'ai_model_id' => null,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/automations/automatic-ai-analysis'
payload = {
    "automatic_analysis_enabled": [
        {
            "service_id": null,
            "ai_model_id": null
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT automations/automatic-ai-analysis

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

automatic_analysis_enabled   object[]  opcional  
service_id   integer   

ai_model_id   integer   

Definir geração automática da ficha do pedido

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/automations/automatic-orders-summary"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "services_ids_automatic_order_summary": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/automations/automatic-orders-summary',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'services_ids_automatic_order_summary' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/automations/automatic-orders-summary'
payload = {
    "services_ids_automatic_order_summary": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT automations/automatic-orders-summary

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

services_ids_automatic_order_summary   integer[]   

Definir compra automática de certidões a partir de resultado de pesquisa

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/automations/automatic-purchases-from-ai-analysis"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "automatic_purchase_from_ai_analysis_enabled": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/automations/automatic-purchases-from-ai-analysis',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'automatic_purchase_from_ai_analysis_enabled' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/automations/automatic-purchases-from-ai-analysis'
payload = {
    "automatic_purchase_from_ai_analysis_enabled": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT automations/automatic-purchases-from-ai-analysis

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

automatic_purchase_from_ai_analysis_enabled   integer[]   

Listar os Prazos de vencimento de documento

requer autenticação

O retorno é paginado

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/customer-service-expirations"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/customer-service-expirations',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/customer-service-expirations'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET customer-service-expirations

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: customer, customer_count, customerExists, service, service_count, serviceExists

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: service_id

Criar um modelo de prazo de vencimento de documento

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/customer-service-expirations"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "service_id": null,
    "expiration_days": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/customer-service-expirations',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'service_id' => null,
            'expiration_days' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/customer-service-expirations'
payload = {
    "service_id": null,
    "expiration_days": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST customer-service-expirations

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

service_id   integer   

expiration_days   integer   

Deve ser pelo menos 1.

Alterar um modelo de prazo de vencimento de documento

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/customer-service-expirations/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "service_id": null,
    "expiration_days": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/customer-service-expirations/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'service_id' => null,
            'expiration_days' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/customer-service-expirations/10'
payload = {
    "service_id": null,
    "expiration_days": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT customer-service-expirations/{customerServiceExpiration_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

customerServiceExpiration_id   integer   

O ID do modelo de prazo de vencimento de documento. Ex: 10

Parâmetros do body

service_id   integer   

expiration_days   integer   

Deve ser pelo menos 1.

Excluir um modelo de prazo de vencimento de documento

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/customer-service-expirations/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api2.cbrdoc.com.br/customer-service-expirations/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/customer-service-expirations/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE customer-service-expirations/{customerServiceExpiration_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

customerServiceExpiration_id   integer   

O ID do modelo de prazo de vencimento de documento. Ex: 10

Contato

Envia um email, para o suporte, com solicitação de ajuda

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/contacts/help"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "subject": null,
    "body": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/contacts/help',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'subject' => null,
            'body' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/contacts/help'
payload = {
    "subject": null,
    "body": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST contacts/help

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

subject   string   

Não pode ser superior a 900 caracteres.

body   string   

Não pode ser superior a 10000 caracteres.

Faturas (Pré pago)

Listar as faturas da conta

requer autenticação

O retorno é paginado por padrão

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/invoices/2023/1"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/invoices/2023/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/invoices/2023/1'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET invoices/{year}/{month}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

year   integer   

Ex: 2023

month   integer   

Ex: 1

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: purchase, purchase_count, purchaseExists, purchase.orders, user, user_count, userExists

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: purchase.name, operation, amount, purchase.backoffice_code, user.name

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: operation, purchase_name_or_id, ids

Listar estatísticas das faturas

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/invoices/2023/1/stats"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/invoices/2023/1/stats',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/invoices/2023/1/stats'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET invoices/{year}/{month}/stats

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

year   integer   

Ex: 2023

month   integer   

Ex: 1

Parâmetros da query

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: approved_only

Faturas (Pós pago)

Listar as faturas da conta

requer autenticação

O retorno é paginado

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/invoice-postpaids/2023/1"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/invoice-postpaids/2023/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/invoice-postpaids/2023/1'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET invoice-postpaids/{year}/{month}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

year   integer   

Ex: 2023

month   integer   

Ex: 1

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: order, order_count, orderExists, order.user, customer, customer_count, customerExists

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: order.name, order.backoffice_code, fiscal_amount, debit_amount

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: order_name_or_id, ids

Listar estatísticas das faturas

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/invoice-postpaids/2023/1/stats"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/invoice-postpaids/2023/1/stats',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/invoice-postpaids/2023/1/stats'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET invoice-postpaids/{year}/{month}/stats

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

year   integer   

Ex: 2023

month   integer   

Ex: 1

Grupos

Listar os grupos

requer autenticação

O retorno é paginado

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/groups"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/groups'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET groups

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

Criar um ou múltiplos grupos

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/groups"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "groups": [
        {
            "name": null
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'groups' => [
                [
                    'name' => null,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/groups'
payload = {
    "groups": [
        {
            "name": null
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST groups

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

groups   object[]   

Deve ter pelo menos 1 item.
name   string   

Deve ser único. Não pode ser superior a 60 caracteres.

Alterar um grupo

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/groups/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/groups/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/groups/10'
payload = {
    "name": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT groups/{group_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

group_id   integer   

O ID do grupo. Ex: 10

Parâmetros do body

name   string   

Deve ser único. Não pode ser superior a 60 caracteres.

Excluir um grupo

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/groups/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api2.cbrdoc.com.br/groups/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/groups/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE groups/{group_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

group_id   integer   

O ID do grupo. Ex: 10

Grupos de permissões

Listar os grupos de permissões

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/permission-groups"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/permission-groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/permission-groups'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET permission-groups

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: permissions

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: name, order

IA

Listar os modelos de IA disponíveis para o cliente

requer autenticação

O retorno é paginado

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/models"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/ai/models',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/models'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET ai/models

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: service, service_count, serviceExists, service.category1, service.category2, customer, customer_count, customerExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: questions, extracted_fields

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: id, name

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: name_or_id, visibility, service_id

Visualizar um modelo de IA

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/models/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/ai/models/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/models/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET ai/models/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID do model. Ex: 10

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: service, service_count, serviceExists, customer, customer_count, customerExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: questions

Criar um modelo personalizado de IA

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/models"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null,
    "questions": [
        {
            "question_to_send_to_ai": null,
            "label_show_user": null
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/ai/models',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => null,
            'questions' => [
                [
                    'question_to_send_to_ai' => null,
                    'label_show_user' => null,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/models'
payload = {
    "name": null,
    "questions": [
        {
            "question_to_send_to_ai": null,
            "label_show_user": null
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST ai/models

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

name   string   

Não pode ser superior a 120 caracteres.

document_name   string  opcional  

Obrigatório quando service_id é igual a null. Não pode ser superior a 120 caracteres.

.
service_id   integer  opcional  

questions   object[]   

Deve ter pelo menos 1 item.
question_to_send_to_ai   string   

A soma dos caracteres de todos os questions.question_to_send_to_ai não pode ser superior a50000 caracteres.

label_show_user   string   

Não pode ser superior a 60 caracteres. Não pode ser superior a 60 caracteres.

Altera um modelo personalizado de IA

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/models/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null,
    "questions": [
        {
            "question_to_send_to_ai": null,
            "label_show_user": null
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/ai/models/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => null,
            'questions' => [
                [
                    'question_to_send_to_ai' => null,
                    'label_show_user' => null,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/models/10'
payload = {
    "name": null,
    "questions": [
        {
            "question_to_send_to_ai": null,
            "label_show_user": null
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT ai/models/{aiModel_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

aiModel_id   integer   

O ID do modelo de IA. Ex: 10

Parâmetros do body

name   string   

Não pode ser superior a 120 caracteres.

document_name   string  opcional  

Obrigatório quando service_id é igual a null. Não pode ser superior a 120 caracteres.

.
service_id   integer  opcional  

questions   object[]   

Deve ter pelo menos 1 item.
question_to_send_to_ai   string   

A soma dos caracteres de todos os questions.question_to_send_to_ai não pode ser superior a50000 caracteres.

label_show_user   string   

Não pode ser superior a 60 caracteres. Não pode ser superior a 60 caracteres.

Excluir um modelo de IA

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/models/ducimus"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api2.cbrdoc.com.br/ai/models/ducimus',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/models/ducimus'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE ai/models/{aiModels}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

aiModels   string   

Ex: ducimus

Retorna os dados de uma thread

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/threads/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/ai/threads/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/threads/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET ai/threads/{aiThread_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

aiThread_id   integer   

O ID do aiThread. Ex: 10

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: first_message, first_message_count, first_messageExists, messages_count

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: files_count

Listar as threads de IA iniciadas pelo usuário

requer autenticação

O retorno é paginado

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/threads"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/ai/threads',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/threads'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET ai/threads

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: first_message, first_message_count, first_messageExists, messages_count

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: files_count

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: id, name, created_at

Inicia uma nova conversa com a IA

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/threads"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/ai/threads',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/threads'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request   

POST ai/threads

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Adiciona uma mensagem em uma conversa existente com a IA

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/threads/10/messages"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "message": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/ai/threads/10/messages',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'message' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/threads/10/messages'
payload = {
    "message": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST ai/threads/{aiThread_id}/messages

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

aiThread_id   integer   

O ID do aiThread. Ex: 10

Parâmetros do body

message   string   
files_ids   string[]  opcional  

Não pode ter mais do que 50 itens.

Adiciona uma mensagem em uma conversa existente com a IA

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/threads/10/messages"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/ai/threads/10/messages',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/threads/10/messages'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET ai/threads/{aiThread_id}/messages

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

aiThread_id   integer   

O ID do aiThread. Ex: 10

Faz upload de um arquivo para ser usado em uma mensagem da thread

requer autenticação

Os ID's dos arquivos são retornados na mesma ordem de envio

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/threads/files"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('files', '');

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/ai/threads/files',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'multipart/form-data',
        ],
        'multipart' => [
            [
                'name' => 'files',
                'contents' => ''
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/threads/files'
files = {
  'files': (None, '')}
payload = {
    "files": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'multipart/form-data'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request   

POST ai/threads/files

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: multipart/form-data

Parâmetros do body

files   string[]   

Um ou múltiplos arquivos com menos de 70MB cada (pdf,doc,docx,pptx,txt). Máximo 20 arquivos. Máximo de 500MB no total.

Itens de compra

Listar os itens de compras

requer autenticação

O retorno é paginado

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/orders',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET orders

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: groups, groups_count, groupsExists, purchase, purchase_count, purchaseExists, service, service_count, serviceExists, user, user_count, userExists, customer, customer_count, customerExists, service_category, service_category_count, service_categoryExists, explorer_item, explorer_item_count, explorer_itemExists, explorer_item.groups, explorer_item.ai_question_history, purchase.waiting_invoice_payment, purchase.recurrence, ocr, ocr_count, ocrExists, ocr.pages, active_challenge, active_challenge_count, active_challengeExists, originated_from, originated_from_count, originated_fromExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: ai_service_name, refundable, explorer_item.file, has_ai_extracted_data, has_ai_analysis_pending, explorer_item_id, ai_service_name, refundable, refundable_value, purchase.downloadable_orders_ids, place_order_default_values, is_expired, can_be_downloaded, explorer_item.ai_enrich_data_available, explorer_item.depends_on_ocr_to_request_ai, previous_order_id_same_purchase, next_order_id_same_purchase, purchase.orders_count, index_in_purchase, can_accept_additional_information, times_downloaded, explorer_item.ai_data, is_summary_extraction_queued, is_get_ai_answers_queued, originated_from_backoffice_code, explorer_item.ai_model_name

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: id, name, placed_at, type

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: id, register, result, name_or_id_or_register, placed_between, status, service_id, group_id, user_id, purchase.recurrence_id, ai, purchase_id, ocr_content, expired, has_active_challenge, has_extracted_summary, originated_from_id

Visualizar um item de compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/orders/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET orders/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID do item de compra. Ex: 10

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: groups, groups_count, groupsExists, purchase, purchase_count, purchaseExists, service, service_count, serviceExists, user, user_count, userExists, customer, customer_count, customerExists, service_category, service_category_count, service_categoryExists, explorer_item, explorer_item_count, explorer_itemExists, explorer_item.groups, explorer_item.ai_question_history, purchase.waiting_invoice_payment, purchase.recurrence, ocr, ocr_count, ocrExists, ocr.pages, active_challenge, active_challenge_count, active_challengeExists, originated_from, originated_from_count, originated_fromExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: ai_service_name, refundable, explorer_item.file, has_ai_extracted_data, has_ai_analysis_pending, explorer_item_id, ai_service_name, refundable, refundable_value, purchase.downloadable_orders_ids, place_order_default_values, is_expired, can_be_downloaded, explorer_item.ai_enrich_data_available, explorer_item.depends_on_ocr_to_request_ai, previous_order_id_same_purchase, next_order_id_same_purchase, purchase.orders_count, index_in_purchase, can_accept_additional_information, times_downloaded, explorer_item.ai_data, is_summary_extraction_queued, is_get_ai_answers_queued, originated_from_backoffice_code, explorer_item.ai_model_name

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: id, register, result, name_or_id_or_register, placed_between, status, service_id, group_id, user_id, purchase.recurrence_id, ai, purchase_id, ocr_content, expired, has_active_challenge, has_extracted_summary, originated_from_id

Renomear um item de compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/name"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/orders/10/name',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/name'
payload = {
    "name": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Request   

PATCH orders/{order_id}/name

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Parâmetros do body

name   string   

Não pode ser superior a 120 caracteres.

Cancelar um item de compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/cancel"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/orders/10/cancel',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/cancel'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request   

POST orders/{order_id}/cancel

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Associa grupos a um item de compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/groups"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/orders/10/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/groups'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT orders/{order_id}/groups

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Parâmetros do body

groups_ids   integer[]  opcional  

Os ids dos grupos para associar ou um array vazio para remover todos os grupos associados.

Altera as anotações de um item de compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/annotation"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "annotations": null
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/orders/10/annotation',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'annotations' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/annotation'
payload = {
    "annotations": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Request   

PATCH orders/{order_id}/annotation

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Parâmetros do body

annotations   string   

Não pode ser superior a 60000 caracteres.

Cancelar um item de uma compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/refund"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/orders/10/refund',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/refund'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request   

POST orders/{order_id}/refund

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Compartilha um item de compra para ser acessado por uma pessoa que não possui um usuário na plataforma

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/share"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "via": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/orders/10/share',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'via' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/share'
payload = {
    "via": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST orders/{order_id}/share

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Parâmetros do body

via   string   
Deve ser um destes:
  • link
  • whatsapp
  • email
destination_email   string  opcional  

Obrigatório quando via é igual a email. Deve ser um endereço de e-mail válido.

.

Visualiza um item de compra compartilhado

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/shared/00xGuH88g182Q3efZdBrblBzdF2xNeBmAV"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/orders/shared/00xGuH88g182Q3efZdBrblBzdF2xNeBmAV',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/shared/00xGuH88g182Q3efZdBrblBzdF2xNeBmAV'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET orders/shared/{token}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

token   string   

O token de compartilhamento Ex: 00xGuH88g182Q3efZdBrblBzdF2xNeBmAV

Faz download dos arquivos de um (.pdf) ou múltiplos itens de compra (.zip).

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/123,456,789/download"
);

const params = {
    "groupBy": "purchase",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/orders/123,456,789/download',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'groupBy' => 'purchase',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/123,456,789/download'
params = {
  'groupBy': 'purchase',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET orders/{ids}/download

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

ids   string   

Ex: 123,456,789

Parâmetros da query

groupBy   string  opcional  

Indica se arquivos .zip devem criar a estrutura baseada na compra ou no registro do item da compra. Ex: purchase

Reporta um problema, relacionado a este item de compra, por email para nossa equipe

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/problem"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/orders/10/problem',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/problem'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request   

POST orders/{order_id}/problem

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Parâmetros do body

subject   string  opcional  

Não pode ser superior a 75 caracteres.

description   string  opcional  

Não pode ser superior a 32000 caracteres.

Adicionar informações adicionais a um item de compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/additional-information"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "files": null,
    "description": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/orders/10/additional-information',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'files' => null,
            'description' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/additional-information'
payload = {
    "files": null,
    "description": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST orders/{order_id}/additional-information

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Parâmetros do body

files   string[]   

Até 50 arquivos de no máximo 10Mb cada. Formatos aceitos:pdf,jpg,png

description   string   

Não pode ser superior a 2000 caracteres.

Faz upload de um arquivo temporário para ser usado posteriormente em um item de compra

requer autenticação

Os caminhos dos arquivos são retornados na mesma ordem de envio

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/temp-file"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('files', '');

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/orders/temp-file',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'multipart/form-data',
        ],
        'multipart' => [
            [
                'name' => 'files',
                'contents' => ''
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/temp-file'
files = {
  'files': (None, '')}
payload = {
    "files": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'multipart/form-data'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request   

POST orders/temp-file

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: multipart/form-data

Parâmetros do body

files   string[]   

Um ou múltiplos arquivos com menos de 70MB cada (pdf, jpg, jpeg, png). Máximo 50 arquivos. Máximo de 500MB no total.

Alterar a data de validade de um item de compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/valid-until"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/orders/10/valid-until',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/valid-until'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PATCH', url, headers=headers)
response.json()

Request   

PATCH orders/{order_id}/valid-until

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Parâmetros do body

valid_until   string  opcional  

Deve ser uma data válida. Deve estar no formato Y-m-d.

Visualizar os detalhes do progresso de um item de compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/detailed-progress"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/orders/10/detailed-progress',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/detailed-progress'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET orders/{order_id}/detailed-progress

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Listar os links dos arquivos anexados ao pedido

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/attached-files"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/orders/10/attached-files',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/attached-files'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET orders/{order_id}/attached-files

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Extrai a ficha do item de compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/10/summary"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/orders/10/summary',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/summary'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET orders/{order_id}/summary

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

Retorna o item de compra mais recente com os mesmos dados enviados para verificar se já existe um item similar

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/similar"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "service_id": null,
    "service_category_id": null,
    "detailed_service_data": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/orders/similar',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'service_id' => null,
            'service_category_id' => null,
            'detailed_service_data' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/similar'
payload = {
    "service_id": null,
    "service_category_id": null,
    "detailed_service_data": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT orders/similar

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

service_id   integer   

O ID do serviço. Consulte em link

service_category_id   integer   

A categoria do serviço. Está disponível nos campos do serviço.

detailed_service_data   object[]   

Os dados específicos do serviço vão dentro deste objeto. Consulte em link

Retorna os pedidos similares

requer autenticação

Retorna um array de objetos, na mesma ordem, com o campo most_recent_similar_order, dos itens enviados no payload, indicando se existem pedidos similares

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/orders/similars"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "detailed_services_data": [
        {
            "detailed_service_data": null,
            "service_id": null,
            "service_category_id": null
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/orders/similars',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'detailed_services_data' => [
                [
                    'detailed_service_data' => null,
                    'service_id' => null,
                    'service_category_id' => null,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/similars'
payload = {
    "detailed_services_data": [
        {
            "detailed_service_data": null,
            "service_id": null,
            "service_category_id": null
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT orders/similars

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

detailed_services_data   object[]   

Deve ter pelo menos 1 item.
detailed_service_data   object   

Os dados específicos do serviço vão dentro deste objeto. Consulte em link

service_id   integer   

service_category_id   integer   

Associa grupos a todos os itens de uma compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/purchases/10/groups"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/purchases/10/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases/10/groups'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT purchases/{purchase_id}/groups

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

purchase_id   integer   

O ID da compra. Ex: 10

Parâmetros do body

groups_ids   integer[]  opcional  

Os ids dos grupos para associar ou um array vazio para remover todos os grupos associados.

Meus arquivos

Lista os itens de meus arquivos

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/explorer',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET explorer

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: order, order_count, orderExists, owner, owner_count, ownerExists, customer, customer_count, customerExists, order.service, service, service_count, serviceExists, groups, groups_count, groupsExists, children, children_count, childrenExists, parent, parent_count, parentExists, ocr, ocr_count, ocrExists, ocr.pages

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: file, breadcrumb, ai_data, ai_model_name, ai_enrich_data_available, depends_on_ocr_to_request_ai

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: id, created_at, last_operation_at, name, type

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: type, owner_id, name, exact_name, created_between, group_id, ai, service_id, parent_id

Visualizar um item dos meus arquivos

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/explorer/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET explorer/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID do explorer. Ex: 10

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: order, order_count, orderExists, owner, owner_count, ownerExists, customer, customer_count, customerExists, order.service, service, service_count, serviceExists, groups, groups_count, groupsExists, children, children_count, childrenExists, parent, parent_count, parentExists, ocr, ocr_count, ocrExists, ocr.pages

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: file, breadcrumb, ai_data, ai_model_name, ai_enrich_data_available, depends_on_ocr_to_request_ai

Associa grupos a um item de meus arquivos

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer/10/groups"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/explorer/10/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/10/groups'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT explorer/{explorerItem_id}/groups

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

explorerItem_id   integer   

O ID do explorerItem. Ex: 10

Parâmetros do body

groups_ids   integer[]  opcional  

Os ids dos grupos para associar ou um array vazio para remover todos os grupos associados.

Altera o serviço de um item de meus arquivos. Somente para itens do tipo upload

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer/10/service"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/explorer/10/service',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/10/service'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PATCH', url, headers=headers)
response.json()

Request   

PATCH explorer/{explorerItem_id}/service

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

explorerItem_id   integer   

O ID do explorerItem. Ex: 10

Parâmetros do body

service_id   integer  opcional  

Renomear um item dos meus arquivos

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer/10/name"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/explorer/10/name',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/10/name'
payload = {
    "name": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Request   

PATCH explorer/{explorerItem_id}/name

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

explorerItem_id   integer   

O ID do explorerItem. Ex: 10

Parâmetros do body

name   string   

Não pode ser superior a 120 caracteres.

Excluir um item de meus arquivos

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api2.cbrdoc.com.br/explorer/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE explorer/{explorerItem_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

explorerItem_id   integer   

O ID do explorerItem. Ex: 10

Move um ou múltiplos itens de meus arquivos para dentro de uma pasta ou para a raíz

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer/123,456,789/parent/root"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/explorer/123,456,789/parent/root',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/123,456,789/parent/root'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PATCH', url, headers=headers)
response.json()

Request   

PATCH explorer/{ids}/parent/root

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

ids   string   

Ex: 123,456,789

Move um ou múltiplos itens de meus arquivos para dentro de uma pasta ou para a raíz

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer/123,456,789/parent/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/explorer/123,456,789/parent/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/123,456,789/parent/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PATCH', url, headers=headers)
response.json()

Request   

PATCH explorer/{ids}/parent/{parent_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

ids   string   

Ex: 123,456,789

parent_id   integer   

O ID do parent. Ex: 10

Cria uma pasta

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer/"
);

const params = {
    "type": "folder",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/explorer/',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'type' => 'folder',
        ],
        'json' => [
            'name' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/'
payload = {
    "name": null
}
params = {
  'type': 'folder',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload, params=params)
response.json()

Request   

POST explorer/{type}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

type   string   

Valor fixo: folder

Parâmetros da query

type   string   

Valor fixo: folder Ex: folder

Parâmetros do body

name   string   

Não pode ser superior a 120 caracteres.

Faz download dos arquivos de um ou múltiplos itens de de meus arquivos (.zip).

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer/123,456,789/download"
);

const params = {
    "groupBy": "purchase",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/explorer/123,456,789/download',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'groupBy' => 'purchase',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/123,456,789/download'
params = {
  'groupBy': 'purchase',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET explorer/{ids}/download

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

ids   string   

Ex: 123,456,789

Parâmetros da query

groupBy   string  opcional  

Indica se arquivos .zip devem criar a estrutura baseada nos diretórios, compra ou no registro do item da compra. Ex: purchase

Faz upload de arquivos para "Meus Arquivos"

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer/upload"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('files', '');
body.append('groups_ids', '');

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/explorer/upload',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'multipart/form-data',
        ],
        'multipart' => [
            [
                'name' => 'files',
                'contents' => ''
            ],
            [
                'name' => 'groups_ids',
                'contents' => ''
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/upload'
files = {
  'files': (None, ''),
  'groups_ids': (None, '')}
payload = {
    "files": null,
    "groups_ids": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'multipart/form-data'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request   

POST explorer/upload

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: multipart/form-data

Parâmetros do body

files   string[]   

Um ou múltiplos arquivos com menos de 70MB cada (pdf, jpg, jpeg, png). Máximo 50 arquivos. Máximo de 500MB no total.

parent_id   integer  opcional  

O ID do pai, deve ser uma pasta.

service_id   integer  opcional  

groups_ids   integer[]   

Busca as respostas de IA para um item de meus arquivos usando um modelo específico.

requer autenticação

Assincrono

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/explorer/10/ai/models/explicabo/answers"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/explorer/10/ai/models/explicabo/answers',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/10/ai/models/explicabo/answers'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET explorer/{explorerItem_id}/ai/models/{aiModelFromCustomerOrPublic}/answers

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

explorerItem_id   integer   

O ID do explorerItem. Ex: 10

aiModelFromCustomerOrPublic   string   

Ex: explicabo

Notificações

Listar as notificações do usuário

requer autenticação

O retorno é paginado

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/notifications"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/notifications',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/notifications'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET notifications

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: created_at

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: read, type

Marca todas as notificações do usuário como lidas

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/notifications/all/read"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/notifications/all/read',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/notifications/all/read'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT notifications/all/read

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Marca todas as notificações do usuário como não lidas

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/notifications/all/unread"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/notifications/all/unread',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/notifications/all/unread'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT notifications/all/unread

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Marca notificaçoes do usuário como lidas

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/notifications/000003b9-46fb-471a-9a37-8ce5d3a3a36b/read"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/notifications/000003b9-46fb-471a-9a37-8ce5d3a3a36b/read',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/notifications/000003b9-46fb-471a-9a37-8ce5d3a3a36b/read'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT notifications/{notifications}/read

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

notifications   string   

Ex: 000003b9-46fb-471a-9a37-8ce5d3a3a36b

Marca notificaçoes do usuário como não lidas

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/notifications/000003b9-46fb-471a-9a37-8ce5d3a3a36b/unread"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/notifications/000003b9-46fb-471a-9a37-8ce5d3a3a36b/unread',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/notifications/000003b9-46fb-471a-9a37-8ce5d3a3a36b/unread'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT notifications/{notifications}/unread

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

notifications   string   

Ex: 000003b9-46fb-471a-9a37-8ce5d3a3a36b

Excluir todas as notificações do usuário

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/notifications/all"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api2.cbrdoc.com.br/notifications/all',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/notifications/all'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE notifications/all

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Excluir notificações do usuário

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/notifications/000003b9-46fb-471a-9a37-8ce5d3a3a36b"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api2.cbrdoc.com.br/notifications/000003b9-46fb-471a-9a37-8ce5d3a3a36b',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/notifications/000003b9-46fb-471a-9a37-8ce5d3a3a36b'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE notifications/{notifications}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

notifications   string   

Ex: 000003b9-46fb-471a-9a37-8ce5d3a3a36b

Recorrências

Listar as recorrências do cliente

requer autenticação

O retorno é paginado

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/recurrences"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/recurrences',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/recurrences'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET recurrences

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: items, items_count, itemsExists, owner, owner_count, ownerExists, items.order, groups, groups_count, groupsExists, customer, customer_count, customerExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: purchases_ids, items.service_can_be_monitored

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: id, name, created_at

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: name_or_id, owner_id, created_between

Visualizar uma recorrência

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/recurrences/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/recurrences/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/recurrences/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET recurrences/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID da recorrência. Ex: 10

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: items, items_count, itemsExists, owner, owner_count, ownerExists, items.order, groups, groups_count, groupsExists, customer, customer_count, customerExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: purchases_ids, items.service_can_be_monitored

Criar uma recorrência

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/recurrences"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null,
    "starts_at": null,
    "frequency": null,
    "notify_result_changes_in_items": null,
    "items": [
        {
            "order_id": null
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/recurrences',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => null,
            'starts_at' => null,
            'frequency' => null,
            'notify_result_changes_in_items' => null,
            'items' => [
                [
                    'order_id' => null,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/recurrences'
payload = {
    "name": null,
    "starts_at": null,
    "frequency": null,
    "notify_result_changes_in_items": null,
    "items": [
        {
            "order_id": null
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST recurrences

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

name   string   

Não pode ser superior a 45 caracteres.

starts_at   string   

Deve ser uma data válida. Deve estar no formato Y-m-d. Deve ser uma data posterior a hoje. A data que a recorrência irá rodar a primeira vez. Deve ser uma data válida para a frequência selecionada.

frequency   string   
Deve ser um destes:
  • weekly
  • monthly
  • yearly
  • every_x_days
monthly_day_of_month   integer  opcional  

Obrigatório quando frequency é igual a monthly. Deve ser entre 1 e 31.

.
yearly_day   integer  opcional  

Obrigatório quando frequency é igual a yearly. Deve ser entre 1 e 31.

.
yearly_month   integer  opcional  

Obrigatório quando frequency é igual a yearly. Deve ser entre 1 e 12.

.
weekly_happens_on   object  opcional  

Obrigatório quando frequency é igual a weekly. Não pode ter mais do que 7 itens.

.
every_x_days_number_of_days   integer  opcional  

Obrigatório quando frequency é igual a every_x_days. Deve ser pelo menos 1.

.
specific_time   string  opcional  

Deve estar no formato H:i.

groups_ids   integer[]  opcional  

Deve ter pelo menos 0 itens.

notify_result_changes_in_items   boolean   
items   object[]   
order_id   integer   

Criar uma recorrência a partir de uma compra

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/recurrences/by-purchase"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null,
    "starts_at": null,
    "frequency": null,
    "notify_result_changes_in_items": null,
    "purchase_id": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/recurrences/by-purchase',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => null,
            'starts_at' => null,
            'frequency' => null,
            'notify_result_changes_in_items' => null,
            'purchase_id' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/recurrences/by-purchase'
payload = {
    "name": null,
    "starts_at": null,
    "frequency": null,
    "notify_result_changes_in_items": null,
    "purchase_id": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST recurrences/by-purchase

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

name   string   

Não pode ser superior a 45 caracteres.

starts_at   string   

Deve ser uma data válida. Deve estar no formato Y-m-d. Deve ser uma data posterior a hoje. A data que a recorrência irá rodar a primeira vez. Deve ser uma data válida para a frequência selecionada.

frequency   string   
Deve ser um destes:
  • weekly
  • monthly
  • yearly
  • every_x_days
monthly_day_of_month   integer  opcional  

Obrigatório quando frequency é igual a monthly. Deve ser entre 1 e 31.

.
yearly_day   integer  opcional  

Obrigatório quando frequency é igual a yearly. Deve ser entre 1 e 31.

.
yearly_month   integer  opcional  

Obrigatório quando frequency é igual a yearly. Deve ser entre 1 e 12.

.
weekly_happens_on   object  opcional  

Obrigatório quando frequency é igual a weekly. Não pode ter mais do que 7 itens.

.
every_x_days_number_of_days   integer  opcional  

Obrigatório quando frequency é igual a every_x_days. Deve ser pelo menos 1.

.
specific_time   string  opcional  

Deve estar no formato H:i.

groups_ids   integer[]  opcional  

Deve ter pelo menos 0 itens.

notify_result_changes_in_items   boolean   
purchase_id   integer   

Alterar uma recorrência

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/recurrences/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null,
    "starts_at": null,
    "frequency": null,
    "notify_result_changes_in_items": null,
    "items": [
        {
            "order_id": null
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/recurrences/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => null,
            'starts_at' => null,
            'frequency' => null,
            'notify_result_changes_in_items' => null,
            'items' => [
                [
                    'order_id' => null,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/recurrences/10'
payload = {
    "name": null,
    "starts_at": null,
    "frequency": null,
    "notify_result_changes_in_items": null,
    "items": [
        {
            "order_id": null
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT recurrences/{recurrence_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

recurrence_id   integer   

O ID da recorrência. Ex: 10

Parâmetros do body

name   string   

Não pode ser superior a 45 caracteres.

starts_at   string   

Deve ser uma data válida. Deve estar no formato Y-m-d. Deve ser uma data posterior a hoje. A data que a recorrência irá rodar a primeira vez. Deve ser uma data válida para a frequência selecionada.

frequency   string   
Deve ser um destes:
  • weekly
  • monthly
  • yearly
  • every_x_days
monthly_day_of_month   integer  opcional  

Obrigatório quando frequency é igual a monthly. Deve ser entre 1 e 31.

.
yearly_day   integer  opcional  

Obrigatório quando frequency é igual a yearly. Deve ser entre 1 e 31.

.
yearly_month   integer  opcional  

Obrigatório quando frequency é igual a yearly. Deve ser entre 1 e 12.

.
weekly_happens_on   object  opcional  

Obrigatório quando frequency é igual a weekly. Não pode ter mais do que 7 itens.

.
every_x_days_number_of_days   integer  opcional  

Obrigatório quando frequency é igual a every_x_days. Deve ser pelo menos 1.

.
specific_time   string  opcional  

Deve estar no formato H:i.

groups_ids   integer[]  opcional  

Deve ter pelo menos 0 itens.

notify_result_changes_in_items   boolean   
items   object[]   
id   number  opcional  

O ID de um item existente nessa recorrência. Se informado, o ID será mantido e o item atualizado. Se não informado, um novo item será criado.

order_id   integer   

Ativar/desativar uma recorrência

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/recurrences/10/active|inactive"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/recurrences/10/active|inactive',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/recurrences/10/active|inactive'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PATCH', url, headers=headers)
response.json()

Request   

PATCH recurrences/{recurrence_id}/{newSituation}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

recurrence_id   integer   

O ID da recorrência. Ex: 10

newSituation   string   

Ex: active|inactive

Excluir um ou múltiplos itens de uma recorrência

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/recurrences/10/items/123,456,789"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api2.cbrdoc.com.br/recurrences/10/items/123,456,789',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/recurrences/10/items/123,456,789'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE recurrences/{recurrence_id}/items/{recurrenceItems}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

recurrence_id   integer   

O ID da recorrência. Ex: 10

recurrenceItems   string   

Ids dos items que serão excluídos. Ex: 123,456,789

Relatórios

Gera um relatório com as respostas dos pedidos de inteligência artificial

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/reports/ai-answers/csv|xlsx"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/reports/ai-answers/csv|xlsx',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/ai-answers/csv|xlsx'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET reports/ai-answers/{format?}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

format   string  opcional  

Ex: csv|xlsx

Parâmetros do body

begin_date   string  opcional  

Deve ser uma data válida. Deve estar no formato Y-m-d.

end_date   string  opcional  

Deve ser uma data válida. Deve estar no formato Y-m-d.

explorer_item_id   integer[]  opcional  
purchase_id   integer[]  opcional  
ai_model_id   integer[]  opcional  

Gera um relatório com os itens de compras de acordo com os filtros utilizados

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/reports/orders/{format?}"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/reports/orders/{format?}',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/orders/{format?}'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET reports/orders/{format?}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

format   string  opcional  

Deve ser um destes:

  • xlsx
  • csv
  • json

Parâmetros do body

one_result_per_row   boolean  opcional  

Indica se cada resultado encontrado para uma pesquisa deve ser mostrado em uma linha diferente.

Retorna a quantidade de itens de compra mês a mês em um período de tempo

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/reports/number-orders-per-month"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "begin_date": null,
    "end_date": null
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/reports/number-orders-per-month',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'begin_date' => null,
            'end_date' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/number-orders-per-month'
payload = {
    "begin_date": null,
    "end_date": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Request   

GET reports/number-orders-per-month

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

begin_date   string   

Deve ser uma data válida. Deve estar no formato Y-m.

end_date   string   

Deve ser uma data válida. Deve estar no formato Y-m.

Retorna a quantidade de itens de compra por status

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/reports/number-orders-per-status"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/reports/number-orders-per-status',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/number-orders-per-status'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET reports/number-orders-per-status

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Retorna a quantidade de itens de compra, valor gastos e preço médio durante o período desejado

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/reports/order-stats"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "begin_date": null,
    "end_date": null
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/reports/order-stats',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'begin_date' => null,
            'end_date' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/order-stats'
payload = {
    "begin_date": null,
    "end_date": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Request   

GET reports/order-stats

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

begin_date   string   

Deve ser uma data válida. Deve estar no formato Y-m-d.

end_date   string   

Deve ser uma data válida. Deve estar no formato Y-m-d.

Retorna a quantidade de análises de IA, valor gastos e preço médio durante o período desejado

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/reports/ai-stats"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "begin_date": null,
    "end_date": null
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/reports/ai-stats',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'begin_date' => null,
            'end_date' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/ai-stats'
payload = {
    "begin_date": null,
    "end_date": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Request   

GET reports/ai-stats

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

begin_date   string   

Deve ser uma data válida. Deve estar no formato Y-m-d.

end_date   string   

Deve ser uma data válida. Deve estar no formato Y-m-d.

Retorna a quantidade de análises de IA mês a mês em um período de tempo

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/reports/number-ai-analysis-per-month"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "begin_date": null,
    "end_date": null
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/reports/number-ai-analysis-per-month',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'begin_date' => null,
            'end_date' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/number-ai-analysis-per-month'
payload = {
    "begin_date": null,
    "end_date": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Request   

GET reports/number-ai-analysis-per-month

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

begin_date   string   

Deve ser uma data válida. Deve estar no formato Y-m.

end_date   string   

Deve ser uma data válida. Deve estar no formato Y-m.

Retorna as faturas de um cliente, pré pago, durante um mês do ano

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/reports/invoices/2023/1"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/reports/invoices/2023/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/invoices/2023/1'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET reports/invoices/{year}/{month}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

year   integer   

Ex: 2023

month   integer   

Ex: 1

Retorna as faturas de um cliente, pós pago, durante um mês do ano

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/reports/invoice-postpaids/2023/1"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/reports/invoice-postpaids/2023/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/invoice-postpaids/2023/1'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET reports/invoice-postpaids/{year}/{month}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

year   integer   

Ex: 2023

month   integer   

Ex: 1

Serviços

Lista os serviços

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/services',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET services

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: category1, category1_count, category1Exists, category2, category2_count, category2Exists, ai_default_model, ai_default_model_count, ai_default_modelExists, ai_default_model.questions

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: is_favorite, can_be_monitored, automatic_purchase_has_options

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: name

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: ai_enabled, category1_id, category2_id, type, can_trigger_automatic_purchase, order_summary_available

Lista os 5 serviços mais usados

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/most-used"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/services/most-used',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/most-used'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET services/most-used

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Visualizar um serviço

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/services/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET services/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID do serviço. Ex: 10

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: category1, category1_count, category1Exists, category2, category2_count, category2Exists, aiDefaultModel, aiDefaultModel_count, aiDefaultModelExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: is_favorite, aiDefaultModel.questions

Visualizar um serviço pelo código

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/code/certidao-nascimento"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/services/code/certidao-nascimento',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/code/certidao-nascimento'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET services/code/{code}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

code   string   

O código do serviço Ex: certidao-nascimento

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: category1, category1_count, category1Exists, category2, category2_count, category2Exists, aiDefaultModel, aiDefaultModel_count, aiDefaultModelExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: aiDefaultModel.questions, is_favorite

Retorna os estados onde o serviço está disponível

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/10/categories/10/federative-units"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/services/10/categories/10/federative-units',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/10/categories/10/federative-units'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET services/{serviceId}/categories/{serviceCategoryId}/federative-units

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

serviceId   integer   

Ex: 10

serviceCategoryId   integer   

Ex: 10

Retorna as cidades, de um estado, onde o serviço está disponível

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/10/categories/10/federative-units/SP"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/services/10/categories/10/federative-units/SP',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/10/categories/10/federative-units/SP'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET services/{serviceId}/categories/{serviceCategoryId}/federative-units/{federativeUnitAbbr}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

serviceId   integer   

Ex: 10

serviceCategoryId   integer   

Ex: 10

federativeUnitAbbr   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

Retorna os cartórios, de um estado/cidade, onde o serviço está disponível

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/10/categories/10/federative-units/SP/SAO_PAULO"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/services/10/categories/10/federative-units/SP/SAO_PAULO',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/10/categories/10/federative-units/SP/SAO_PAULO'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET services/{serviceId}/categories/{serviceCategoryId}/federative-units/{federativeUnitAbbr}/{cityUrl}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

serviceId   integer   

Ex: 10

serviceCategoryId   integer   

Ex: 10

federativeUnitAbbr   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

cityUrl   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

Define um serviço como favorito

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/10/favorite"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/services/10/favorite',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/10/favorite'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT services/{serviceId}/favorite

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

serviceId   integer   

Ex: 10

Remove um serviço dos favoritos

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/10/favorite"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api2.cbrdoc.com.br/services/10/favorite',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/10/favorite'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE services/{serviceId}/favorite

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

serviceId   integer   

Ex: 10

Retorna o custo extra de não saber o livro e página da certidão

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/dont-know-book-page-price"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/services/dont-know-book-page-price',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/dont-know-book-page-price'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET services/dont-know-book-page-price

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Retorna o valor da taxa de serviço

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/tax-price"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/services/tax-price',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/tax-price'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET services/tax-price

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Verifica os formatos disponíveis de um serviço

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/10/categories/10/available-formats"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "detailed_service_data": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/services/10/categories/10/available-formats',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'detailed_service_data' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/10/categories/10/available-formats'
payload = {
    "detailed_service_data": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT services/{serviceId}/categories/{serviceCategoryId}/available-formats

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

serviceId   integer   

Ex: 10

serviceCategoryId   integer   

Ex: 10

Parâmetros do body

detailed_service_data   object[]   

Os dados específicos do serviço vão dentro deste objeto. Consulte em link

Calcula o preço e prazo de entrega de um serviço

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/10/categories/10/prices-shipping-info"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "detailed_service_data": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/services/10/categories/10/prices-shipping-info',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'detailed_service_data' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/10/categories/10/prices-shipping-info'
payload = {
    "detailed_service_data": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

serviceId   integer   

Ex: 10

serviceCategoryId   integer   

Ex: 10

Parâmetros do body

detailed_service_data   object[]   

Os dados específicos do serviço vão dentro deste objeto. Consulte em link

Calcula o preço e dias adicionados no prazos de entrega para os adicionais do serviço

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/10/categories/10/extras-prices-shipping-info"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "detailed_service_data": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/services/10/categories/10/extras-prices-shipping-info',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'detailed_service_data' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/10/categories/10/extras-prices-shipping-info'
payload = {
    "detailed_service_data": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

serviceId   integer   

Ex: 10

serviceCategoryId   integer   

Ex: 10

Parâmetros do body

detailed_service_data   object[]   

Os dados específicos do serviço vão dentro deste objeto. Consulte em link

Retorna as informações extras necessárias para o serviço.

requer autenticação

Alguns serviços exigem dados que estão restritos a uma lista de valores. Aqui essas informações podem ser consultadas

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/10/categories/10/extra-informations/modelo"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "detailed_service_data": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/services/10/categories/10/extra-informations/modelo',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'detailed_service_data' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/10/categories/10/extra-informations/modelo'
payload = {
    "detailed_service_data": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT services/{serviceId}/categories/{serviceCategoryId}/extra-informations/{info?}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

serviceId   integer   

Ex: 10

serviceCategoryId   integer   

Ex: 10

info   string   

Ex: modelo

Parâmetros do body

detailed_service_data   object[]   

Os dados específicos do serviço vão dentro deste objeto. Consulte em link

Retorna os registros

requer autenticação

Retorna um array de strings, na mesma ordem, o valor do campo de registro, de acordo com o serviço, dos itens enviados no payload

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/registers"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "detailed_services_data": [
        {
            "detailed_service_data": null,
            "service_id": null,
            "service_category_id": null
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/services/registers',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'detailed_services_data' => [
                [
                    'detailed_service_data' => null,
                    'service_id' => null,
                    'service_category_id' => null,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/registers'
payload = {
    "detailed_services_data": [
        {
            "detailed_service_data": null,
            "service_id": null,
            "service_category_id": null
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT services/registers

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

detailed_services_data   object[]   

Deve ter pelo menos 1 item.
detailed_service_data   object   

Os dados específicos do serviço vão dentro deste objeto. Consulte em link

service_id   integer   

service_category_id   integer   

Retorna as automações de compra automática, a partir de extração de dados, disponíveis

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/automatic-purchases-from-ai-analysis-available"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/services/automatic-purchases-from-ai-analysis-available',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/services/automatic-purchases-from-ai-analysis-available'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET services/automatic-purchases-from-ai-analysis-available

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: service, service_count, serviceExists

sort   string  opcional  

Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo Ex: -nome_campo. Múltiplos devem ser separadas com vírgula. Disponíveis: description

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: service_id

Serviços por Categoria

Lista os 5 serviços mais usados de uma categoria específica

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/service-categories/1/services/most-used"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/service-categories/1/services/most-used',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/service-categories/1/services/most-used'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET service-categories/{serviceCategory}/services/most-used

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

serviceCategory   integer   

Ex: 1

Usuários

Busca o registro de redefinição de senha pelo token para verificar se é válido

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/password-reset/0010905473ade9284a1c6404ec3648c56a170cc571ca771822e26cc2d5e602c1"
);

fetch(url, {
    method: "GET",
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get('https://api2.cbrdoc.com.br/password-reset/0010905473ade9284a1c6404ec3648c56a170cc571ca771822e26cc2d5e602c1');
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/password-reset/0010905473ade9284a1c6404ec3648c56a170cc571ca771822e26cc2d5e602c1'
response = requests.request('GET', url, )
response.json()

Request   

GET password-reset/{token}

Parâmetros da URL

token   string   

Ex: 0010905473ade9284a1c6404ec3648c56a170cc571ca771822e26cc2d5e602c1

Redefine a senha de um usuário através de um token de recuperação de senha válido

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/password-reset/0010905473ade9284a1c6404ec3648c56a170cc571ca771822e26cc2d5e602c1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "new_password": null
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/password-reset/0010905473ade9284a1c6404ec3648c56a170cc571ca771822e26cc2d5e602c1',
    [
        'headers' => [
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'new_password' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/password-reset/0010905473ade9284a1c6404ec3648c56a170cc571ca771822e26cc2d5e602c1'
payload = {
    "new_password": null
}
headers = {
  'Content-Type': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Request   

PATCH password-reset/{token}

Headers

Content-Type      

Ex: application/json

Parâmetros da URL

token   string   

Ex: 0010905473ade9284a1c6404ec3648c56a170cc571ca771822e26cc2d5e602c1

Parâmetros do body

new_password   string   

Não pode ser superior a 255 caracteres.

Criar um token de recuperação de senha

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/password-reset"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/password-reset',
    [
        'headers' => [
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'email' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/password-reset'
payload = {
    "email": null
}
headers = {
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST password-reset

Headers

Content-Type      

Ex: application/json

Parâmetros do body

email   string   

O email do usuário

Criar um usuário

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/users"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null,
    "email": null,
    "password": null,
    "permissions": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api2.cbrdoc.com.br/users',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => null,
            'email' => null,
            'password' => null,
            'permissions' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users'
payload = {
    "name": null,
    "email": null,
    "password": null,
    "permissions": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request   

POST users

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

name   string   

Não pode ser superior a 60 caracteres.

email   string   

Deve ser um endereço de e-mail válido. Não pode ser superior a 200 caracteres.

password   string   

Não pode ser superior a 255 caracteres.

phone   string  opcional  

Não pode ser superior a 15 caracteres.

permissions   integer[]   

Listar os usuários da conta

requer autenticação

O retorno é paginado

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/users"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/users',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET users

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: permissions, permissions_count, permissionsExists, notifications_preferences, notifications_preferences_count, notifications_preferencesExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: total_ai_tokens_used_current_month, ai_tokens_above_limit_this_month, customer.total_ai_tokens_used_current_month, customer.ai_tokens_above_limit_this_month

filter   array  opcional  

Campos disponíveis para filtrar. Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2. Disponíveis: name_or_email

Listar os usuários excluídos da conta

requer autenticação

O retorno é paginado

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/users/trashed"
);

const params = {
    "page": "1",
    "per-page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/users/trashed',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
        'query' => [
            'page' => '1',
            'per-page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users/trashed'
params = {
  'page': '1',
  'per-page': '10',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Request   

GET users/trashed

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

page   int  opcional  

a página desejada Ex: 1

per-page   int  opcional  

quantidade de registros por página (padrão é 20, máx 30) Ex: 10

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: permissions, permissions_count, permissionsExists, notifications_preferences, notifications_preferences_count, notifications_preferencesExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: total_ai_tokens_used_current_month, ai_tokens_above_limit_this_month, customer.total_ai_tokens_used_current_month, customer.ai_tokens_above_limit_this_month

Visualizar um usuário

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/users/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/users/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET users/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID do usuário. Ex: 10

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: permissions, permissions_count, permissionsExists, notifications_preferences, notifications_preferences_count, notifications_preferencesExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: total_ai_tokens_used_current_month, ai_tokens_above_limit_this_month, customer.total_ai_tokens_used_current_month, customer.ai_tokens_above_limit_this_month

Listar os usuários da conta que o usuário logado pode ver os pedidos

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/users/with-visible-orders"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api2.cbrdoc.com.br/users/with-visible-orders',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users/with-visible-orders'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Request   

GET users/with-visible-orders

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da query

include   string  opcional  

Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: permissions, permissions_count, permissionsExists, notifications_preferences, notifications_preferences_count, notifications_preferencesExists

append   string  opcional  

Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. Disponíveis: total_ai_tokens_used_current_month, ai_tokens_above_limit_this_month, customer.total_ai_tokens_used_current_month, customer.ai_tokens_above_limit_this_month

Alterar as permissões de um usuário

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/users/10/permissions"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "permissions": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/users/10/permissions',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'permissions' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users/10/permissions'
payload = {
    "permissions": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT users/{user_id}/permissions

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

user_id   integer   

O ID do usuário. Ex: 10

Parâmetros do body

permissions   integer[]   

Alterar as preferências de notificação do usuário

requer autenticação

database - São as notificações que aparecem no sistema. mail - São as notificações enviadas por email.

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/users/10/notifications-preferences"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "bank_slip_notification_via": null,
    "placed_purchase_notification_via": null,
    "pending_action_notification_via": null,
    "finished_order_notification_via": null,
    "finished_purchase_notification_via": null,
    "refunded_order_notification_via": null,
    "certificate_expired_notification_via": null,
    "system_information_notification_via": null,
    "system_unavailable_notification_via": null,
    "summary_extracted_notification_via": null,
    "order_challenge_notification_via": null,
    "spreadsheet_placed_purchase_notification": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/users/10/notifications-preferences',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'bank_slip_notification_via' => null,
            'placed_purchase_notification_via' => null,
            'pending_action_notification_via' => null,
            'finished_order_notification_via' => null,
            'finished_purchase_notification_via' => null,
            'refunded_order_notification_via' => null,
            'certificate_expired_notification_via' => null,
            'system_information_notification_via' => null,
            'system_unavailable_notification_via' => null,
            'summary_extracted_notification_via' => null,
            'order_challenge_notification_via' => null,
            'spreadsheet_placed_purchase_notification' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users/10/notifications-preferences'
payload = {
    "bank_slip_notification_via": null,
    "placed_purchase_notification_via": null,
    "pending_action_notification_via": null,
    "finished_order_notification_via": null,
    "finished_purchase_notification_via": null,
    "refunded_order_notification_via": null,
    "certificate_expired_notification_via": null,
    "system_information_notification_via": null,
    "system_unavailable_notification_via": null,
    "summary_extracted_notification_via": null,
    "order_challenge_notification_via": null,
    "spreadsheet_placed_purchase_notification": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request   

PUT users/{user_id}/notifications-preferences

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

user_id   integer   

O ID do usuário. Ex: 10

Parâmetros do body

bank_slip_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
placed_purchase_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
pending_action_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
finished_order_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
finished_purchase_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
refunded_order_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
spreadsheet_placed_purchase_notification_via   object  opcional  
certificate_expired_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
system_information_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
system_unavailable_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
summary_extracted_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
order_challenge_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
spreadsheet_placed_purchase_notification   string[]   
Deve ser um destes:
  • database
  • mail

Alterar a senha do usuário

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/users/10/password"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "current_password": null,
    "new_password": null
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api2.cbrdoc.com.br/users/10/password',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'current_password' => null,
            'new_password' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users/10/password'
payload = {
    "current_password": null,
    "new_password": null
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Request   

PATCH users/{user_id}/password

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

user_id   integer   

O ID do usuário. Ex: 10

Parâmetros do body

current_password   string   

Não pode ser superior a 255 caracteres.

new_password   string   

Não pode ser superior a 255 caracteres.

Excluir um ou múltiplos usuários

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/users/1"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api2.cbrdoc.com.br/users/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users/1'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request   

DELETE users/{users}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

users   integer   

Ex: 1

Envia email para um administrador solicitando ativação da compra automática a pedido de um usuário

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/users/request-admin-enable-automatic-purchase/service/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/users/request-admin-enable-automatic-purchase/service/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users/request-admin-enable-automatic-purchase/service/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT users/request-admin-enable-automatic-purchase/service/{service_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

service_id   integer   

O ID do serviço. Ex: 10

Envia email para um administrador solicitando ativação da ficha automática a pedido de um usuário

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/users/request-admin-enable-automatic-order-summary/service/10"
);

const headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api2.cbrdoc.com.br/users/request-admin-enable-automatic-order-summary/service/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users/request-admin-enable-automatic-order-summary/service/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request   

PUT users/request-admin-enable-automatic-order-summary/service/{service_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

service_id   integer   

O ID do serviço. Ex: 10

Detalhamento de serviços

Cada serviço (certidão, pesquisa, diligência, IA, etc) tem atributos específicos para alguns endpoints. Estes atributos vão dentro do objeto detailed_service_data. Os atributos de cada serviço estão listados abaixo, por endpoint.

Federais => Antecedentes Criminais - Federal

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cpf   string   

Deve ser 11 caracteres.

nome   string   

Não pode ser superior a 255 caracteres.

nascimento   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

mae   string   

Não pode ser superior a 255 caracteres.

Notas => Ata Notarial

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_servico   string   
Deve ser um destes:
  • diligencia-presencial-do-tabeliao
  • ja-possuo-as-evidencias

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

local_servico   string  opcional  

Obrigatório quando tipo_servico é igual a diligencia-presencial-do-tabeliao. não pode ser superior a 500 caracteres.

.
mensagem   string   

Não pode ser superior a 500 caracteres.

tipo_servico   string   
Deve ser um destes:
  • diligencia-presencial-do-tabeliao
  • ja-possuo-as-evidencias
arquivos   string[]   

Protesto => Baixa de Protesto

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

numero_titulo   string   
observacoes   string  opcional  

Não pode ser superior a 260 caracteres.

arquivos   string[]   

Estaduais => Cadastro de Contribuintes de ICMS - CADESP

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

cnpj   string   

Estaduais => Cadastro Informativo Estadual - CADIN Estadual

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

inscricao_estadual   string   

Não pode ser superior a 255 caracteres.

Federais => CAFIR - Cadastro de Imóveis Rurais

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

nirf   string   

Deve ser 8 caracteres.

Municipais => Capa de IPTU – Prefeitura

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
inscricao_imovel   string   

Não pode ser superior a 255 caracteres.

Municipais => Carnê de IPTU - Prefeitura

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

inscricao_imovel   string   

Não pode ser superior a 255 caracteres.

Municipais => Certidão Ambiental Municipal – Prefeitura

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
endereco   string   

Não pode ser superior a 255 caracteres.

Registro de Imóveis => Certidão de Alienação Fiduciária (RI)

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

safra   string   

Não pode ser superior a 255 caracteres.

commoditie   string   

Não pode ser superior a 255 caracteres.

Federais => Certidão de Alienação Fiduciária (RTD)

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

tipo   string   
Deve ser um destes:
  • safra
  • outro
safra   string  opcional  

Obrigatório quando tipo é igual a safra. não pode ser superior a 255 caracteres.

.
commoditie   string  opcional  

Obrigatório quando tipo é igual a safra. não pode ser superior a 255 caracteres.

.
onus   string  opcional  

Obrigatório quando tipo é igual a outro. não pode ser superior a 255 caracteres.

.
numero_registro   string  opcional  

Não pode ser superior a 75 caracteres.

periodo   string  opcional  

Não pode ser superior a 75 caracteres.

Estaduais => Certidão de Antecedentes Criminais Estadual

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cpf   string   

Deve ser 11 caracteres.

nome   string   

Não pode ser superior a 255 caracteres.

nascimento   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

mae   string   

Não pode ser superior a 255 caracteres.

pai   string  opcional  

Não pode ser superior a 255 caracteres.

rg   string   

Não pode ser superior a 15 caracteres.

Municipais => Certidão de Auto de Multa (UNICAI/UNAI)

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

inscricao_imovel   string   

Não pode ser superior a 255 caracteres.

Registro Civil => Certidão de Casamento

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

livro   string  opcional  

Não pode ser superior a 5 caracteres.

pagina   string  opcional  

Não pode ser superior a 3 caracteres.

termo   string  opcional  

Não pode ser superior a 7 caracteres.

conjuge1   string   

Não pode ser superior a 255 caracteres.

conjuge2   string   

Não pode ser superior a 255 caracteres.

casamento   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

pedido_origem_id   integer  opcional  

Municipais => Certidão de Dados Cadastrais do Imóvel – Prefeitura

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
inscricao_imovel   string   

Não pode ser superior a 255 caracteres.

Estaduais => Certidão de Desapropriação Estadual

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

inscricao_imovel   string   

Não pode ser superior a 255 caracteres.

matricula   string   

Não pode ser superior a 255 caracteres.

arquivo   string  opcional  

Municipais => Certidão de Desapropriação Municipal

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

inscricao_imovel   string   

Não pode ser superior a 255 caracteres.

arquivo   string  opcional  

Federais => Certidão de Empresa em Cartórios de Pessoa Jurídica

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_documento   string   
tipo_certidao   string   

POST /services/{serviceId}/categories/{serviceCategoryId}/extra-informations

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

pedido_origem_id   integer  opcional  

tipo_documento   string   
tipo_certidao   string   
numero_registro   string  opcional  
data_registro   string  opcional  

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

quesito   string  opcional  

Registro Civil => Certidão de Escritura

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

nao_sei_livro_pagina   boolean   

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

pedido_origem_id   integer  opcional  

livro   string  opcional  

Obrigatório quando nao_sei_livro_pagina é igual a false.

.
pagina   string  opcional  

Obrigatório quando nao_sei_livro_pagina é igual a false.

.
nao_sei_livro_pagina   boolean   
data_ato   string  opcional  

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

tipo   string   
arquivos   string[]   

Registro de Imóveis => Certidão de Imóvel

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo   string   
Deve ser um destes:
  • matricula
  • transcricao
  • docarquivado
  • inteiroteor
  • livro3auxiliar
  • livro3garantias
  • onus
  • quesitos
  • vintenaria
  • propriedade
  • condominio
  • pactoantenupcial
  • cadeia_dominial

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo   string   
Deve ser um destes:
  • matricula
  • transcricao
  • docarquivado
  • inteiroteor
  • livro3auxiliar
  • livro3garantias
  • onus
  • quesitos
  • vintenaria
  • propriedade
  • condominio
  • pactoantenupcial
  • cadeia_dominial

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo   string   
Deve ser um destes:
  • matricula
  • transcricao
  • docarquivado
  • inteiroteor
  • livro3auxiliar
  • livro3garantias
  • onus
  • quesitos
  • vintenaria
  • propriedade
  • condominio
  • pactoantenupcial
  • cadeia_dominial

POST /services/{serviceId}/categories/{serviceCategoryId}/extra-informations

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo   string   
Deve ser um destes:
  • matricula
  • transcricao
  • docarquivado
  • inteiroteor
  • livro3auxiliar
  • livro3garantias
  • onus
  • quesitos
  • vintenaria
  • propriedade
  • condominio
  • pactoantenupcial
  • cadeia_dominial

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

pedido_origem_id   integer  opcional  

tipo   string   
Deve ser um destes:
  • matricula
  • transcricao
  • docarquivado
  • inteiroteor
  • livro3auxiliar
  • livro3garantias
  • onus
  • quesitos
  • vintenaria
  • propriedade
  • condominio
  • pactoantenupcial
  • cadeia_dominial
buscar_por   string   
matricula   string  opcional  
transcricao   string  opcional  
endereco   string  opcional  
cep   string  opcional  

Deve ser 8 caracteres.

condominio   string  opcional  
registro_livro3   string  opcional  
ato   string  opcional  
data_emissao   string  opcional  

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

livro   string  opcional  
nome   string  opcional  
documento   string  opcional  
protocolo   string  opcional  
conjuge1_nome   string  opcional  
conjuge2_nome   string  opcional  
conjuge1_cpf   string  opcional  
conjuge2_cpf   string  opcional  
casamento   string  opcional  

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

numero_registro   string  opcional  
observacoes   string  opcional  

Não pode ser superior a 500 caracteres.

dominial_ano_limite   integer  opcional  

Deve ser pelo menos 1800. não pode ser superior a 2099.

Registro Civil => Certidão de Interdição

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

mae   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. não pode ser superior a 255 caracteres.

.
pai   string  opcional  

Não pode ser superior a 255 caracteres.

nascimento   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

.
rg   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica.

.
uf_nascimento   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica.

. Deve ser um destes:
  • AC
  • AL
  • AP
  • AM
  • BA
  • CE
  • DF
  • ES
  • GO
  • MA
  • MT
  • MS
  • MG
  • PA
  • PB
  • PR
  • PE
  • PI
  • RJ
  • RN
  • RS
  • RO
  • RR
  • SC
  • SP
  • SE
  • TO
  • NS
cidade_nascimento   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica.

.
ano_aproximado_ato   integer  opcional  

Deve ser entre 1900 e 2025.

Registro Civil => Certidão de Nascimento

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

livro   string  opcional  

Não pode ser superior a 5 caracteres.

pagina   string  opcional  

Não pode ser superior a 3 caracteres.

termo   string  opcional  

Não pode ser superior a 7 caracteres.

nome   string   

Não pode ser superior a 255 caracteres.

mae   string   

Não pode ser superior a 255 caracteres.

pai   string  opcional  

Não pode ser superior a 255 caracteres.

nascimento   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

pedido_origem_id   integer  opcional  

Registro Civil => Certidão de Óbito

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

livro   string  opcional  

Não pode ser superior a 5 caracteres.

pagina   string  opcional  

Não pode ser superior a 3 caracteres.

termo   string  opcional  

Não pode ser superior a 7 caracteres.

nome   string   

Não pode ser superior a 255 caracteres.

mae   string   

Não pode ser superior a 255 caracteres.

pai   string  opcional  

Não pode ser superior a 255 caracteres.

obito   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

pedido_origem_id   integer  opcional  

Estaduais => Certidão de Objeto e Pé

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

numero_processo   string   

Não pode ser superior a 255 caracteres.

Registro de Imóveis => Certidão de Penhor de Safra

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

tipo_safra   string   

Não pode ser superior a 255 caracteres.

safra   string   

Não pode ser superior a 255 caracteres.

registro   string  opcional  

Não pode ser superior a 255 caracteres.

nome_propriedade   string  opcional  

Não pode ser superior a 255 caracteres.

Registro de Imóveis => Certidão de Prévia de Matrícula – Matrícula Online

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

pedido_origem_id   integer  opcional  

matricula   string   
observacoes   string  opcional  

Não pode ser superior a 500 caracteres.

Notas => Certidão de Procuração

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

nao_sei_livro_pagina   boolean   

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

pedido_origem_id   integer  opcional  

livro   string  opcional  

Obrigatório quando nao_sei_livro_pagina é igual a false.

.
pagina   string  opcional  

Obrigatório quando nao_sei_livro_pagina é igual a false.

.
nao_sei_livro_pagina   boolean   
data_ato   string  opcional  

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

Federais => Certidão de Propriedade de Aeronave

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

matricula   string   

Não pode ser superior a 255 caracteres.

Protesto => Certidão de Protesto

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   array   

As urls dos cartórios. Disponíveis podem ser obtidos em link

tempo_pesquisa   integer   

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   array   

As urls dos cartórios. Disponíveis podem ser obtidos em link

tempo_pesquisa   integer   

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   array   

As urls dos cartórios. Disponíveis podem ser obtidos em link

POST /services/{serviceId}/categories/{serviceCategoryId}/extra-informations

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   array   

As urls dos cartórios. Disponíveis podem ser obtidos em link

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string[]   
tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

pedido_origem_id   integer  opcional  

tempo_pesquisa   integer   
rg   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica.

.
cep   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 8 caracteres.

.

Federais => Certidão de Testamento (Positiva ou Negativa) – CENSEC

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

tipo_livro   string   

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_livro   string   

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

nome   string   

Não pode ser superior a 255 caracteres.

nascimento   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

cpf   string   

Deve ser 11 caracteres.

tipo_documento   string   
cnh_passaporte_rg_rne   string   
orgao_emissor   string   
obito   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

matricula   string  opcional  
url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

tipo_livro   string   
livro   string  opcional  
pagina   string  opcional  
mae   string   

Não pode ser superior a 255 caracteres.

pai   string  opcional  

Não pode ser superior a 255 caracteres.

arquivo_certidao_obito   string   

Federais => Certidão de Tombamento - IPHAN

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

inscricao_imovel   string   

Não pode ser superior a 255 caracteres.

matricula   string   

Não pode ser superior a 255 caracteres.

arquivo   string  opcional  

Municipais => Certidão de Uso e Ocupação do Solo

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

inscricao_imovel   string   

Não pode ser superior a 255 caracteres.

arquivo   string  opcional  

Municipais => Certidão de Valor Venal – Prefeitura

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
inscricao_imovel   string   

Não pode ser superior a 255 caracteres.

observacoes   string  opcional  

Não pode ser superior a 500 caracteres.

arquivos   string[]   

Um array com o caminho dos arquivos enviados no endpoint de upload: link

Federais => Certidão do INSS - Previdência Social

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cnpj   string   

Deve ser 14 caracteres.

cei   string  opcional  

Não pode ser superior a 13 caracteres.

Federais => Certidão do SPU

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

tipo   string   

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   
numero_rip   string  opcional  

Obrigatório quando cpf, cnpj, e nome não estão presentes.

cpf   string  opcional  

Obrigatório quando numero_rip, cnpj, e nome não estão presentes.

cnpj   string  opcional  

Obrigatório quando numero_rip, cpf, e nome não estão presentes.

nome   string  opcional  

Obrigatório quando numero_rip, cpf, e cnpj não estão presentes.

Federais => Certidão Negativa Correcional (CGU-PJ, CEIS, CNEP e CEPIM)

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Estaduais => Certidão Negativa de Débitos Ambientais

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/extra-informations

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

rg   string  opcional  
rg_data_expedicao   string  opcional  

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

rg_uf_expedicao   string  opcional  
Deve ser um destes:
  • AC
  • AL
  • AP
  • AM
  • BA
  • CE
  • DF
  • ES
  • GO
  • MA
  • MT
  • MS
  • MG
  • PA
  • PB
  • PR
  • PE
  • PI
  • RJ
  • RN
  • RS
  • RO
  • RR
  • SC
  • SP
  • SE
  • TO
  • NS
nascimento   string  opcional  

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

motivo_solicitacao   string  opcional  
arquivos   string[]   

Um array com o caminho dos arquivos enviados no endpoint de upload: link

Federais => Certidão para Entidades Supervisionadas

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cnpj   string   

Deve ser 14 caracteres.

Registro de Imóveis => Certificado de Cadastro do Imóvel Rural - CCIR

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
natureza_juridica   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica.

.

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
natureza_juridica   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica.

.

POST /services/{serviceId}/categories/{serviceCategoryId}/extra-informations

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
codigo_imovel   string   

Deve ser 13 caracteres.

natureza_juridica   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica.

.

Federais => CGU - Certidão Negativa Correcional (EPAD e CGU-PAD)

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Federais => CNJ - Improbidade Administrativa e Inelegibilidade

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Federais => Consulta - Cadastro Técnico Federal do IBAMA

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Federais => Consulta SICAF (Sistema de Cadastramento Unificado de Fornecedores)

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Estaduais => CRDA - Certidão Negativa de Débitos Tributários – PGE

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

inscricao_estadual   string  opcional  

Não pode ser superior a 255 caracteres.

endereco   string  opcional  

Não pode ser superior a 255 caracteres.

Estaduais => Extrato de Débitos Estadual

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

inscricao_estadual   string   

Não pode ser superior a 255 caracteres.

Municipais => Extrato de Débitos Municipal – Prefeitura

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
inscricao_imovel   string   

Não pode ser superior a 255 caracteres.

Federais => FGTS - Certidão Negativa do FGTS

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cnpj   string   

Deve ser 14 caracteres.

cei   string  opcional  

Não pode ser superior a 13 caracteres.

Federais => IBAMA - Certidão de Embargos

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Federais => IBAMA - Certidão Negativa de Débitos

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

Estaduais => Junta Comercial - Certidão da Empresa

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

tipo   string   

POST /services/{serviceId}/categories/{serviceCategoryId}/extra-informations

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

tipo   string   
cnpj   string   

Deve ser 14 caracteres.

razao_social   string  opcional  
numero_ato   string  opcional  
pedido_origem_id   integer  opcional  

tipo_especificacao   string  opcional  

Obrigatório quando tipo é igual a especifica. não pode ser superior a 255 caracteres.

.

Estaduais => MDA / SEAD / Declaração de Aptidão Ao PRONAF (DAP)

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Estaduais => MPE - Certidão de Inquérito Civil

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

Estaduais => MPE - Certidão de Inquérito Criminal

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

Federais => MPF - Certidão Negativa

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Estaduais => MPT - Certidão Negativa de Feitos

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

Federais => MT - Certidão de Cumprimento da Cota Legal de PcD's

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Federais => MT - Certidão de Débitos

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Federais => MT - Recibo de Entrega da Rais

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

tipo   string   
Deve ser um destes:
  • cei-cno
  • caepf
  • cnpj

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   
Deve ser um destes:
  • cei-cno
  • caepf
  • cnpj

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   
Deve ser um destes:
  • cei-cno
  • caepf
  • cnpj
cei_cno   string  opcional  

Obrigatório quando tipo é igual a cei-cno.

.
caepf   string  opcional  

Obrigatório quando tipo é igual a caepf.

.
cnpj   string  opcional  

Obrigatório quando tipo é igual a cnpj.

.
crea   string   
ano_base   integer   

Deve ser entre 1900 e 2025.

Federais => Receita Federal - Certidão de Tributos Federais e Dívida da União de Imóvel Rural (ITR)

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cib   string   

Deve ser 8 caracteres.

Federais => Receita Federal - Certidão Negativa de Débitos Relativos Aos Tributos Federais e à Divida Ativa da União (CNDTNIDA)

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nascimento   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

.

Municipais => SEFAZ - Certidão de IPTU

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
inscricao_imovel   string   

Não pode ser superior a 255 caracteres.

complemento   string  opcional  

Não pode ser superior a 250 caracteres.

Estaduais => SEFAZ - Certidão Negativa de Débitos Tributários Estaduais (CND Estadual)

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

rg   string  opcional  
orgao_emissor   string  opcional  

Municipais => SEFAZ - Certidão Negativa de Débitos Tributários Municipais (CND Municipal)

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

mae   string  opcional  

Não pode ser superior a 255 caracteres.

nascimento   string  opcional  

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

inscricao_municipal   string  opcional  

Não pode ser superior a 255 caracteres. não pode ser superior a 255 caracteres.

inscricao_mercantil   string  opcional  

Obrigatório quando url_uf é igual a PE. não pode ser superior a 255 caracteres.

.
inscricao_cadastral   string  opcional  

Obrigatório quando url_cidade é igual a santana-de-parnaiba. não pode ser superior a 255 caracteres.

.
observacoes   string  opcional  

Não pode ser superior a 2500 caracteres.

Federais => STF - Certidão Distribuidor

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

mae   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. não pode ser superior a 255 caracteres.

.
nascimento   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

.
pai   string  opcional  

Não pode ser superior a 255 caracteres.

rg   string  opcional  
orgao_emissor   string  opcional  
nacionalidade   string  opcional  
estado_civil   string  opcional  

Federais => STJ - Certidão Negativa

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

mae   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. não pode ser superior a 255 caracteres.

.
nascimento   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

.
rg   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica.

.
orgao_emissor   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica.

.
nacionalidade   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica.

.
estado_civil   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica.

.

Federais => STM - Certidão Negativa de Ações Criminais

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cpf   string   

Deve ser 11 caracteres.

nome   string   

Não pode ser superior a 255 caracteres.

nascimento   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

mae   string   

Federais => TCU - Certidão Negativa de Contas Julgadas Irregulares

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

tipo   string   

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

tipo   string   

Federais => TCU - Certidão Negativa de Processo

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

Federais => TCU - Consulta Situação de Pessoa Jurídica

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cnpj   string   

Deve ser 14 caracteres.

Estaduais => TJ - Certidão de Distribuição Estadual

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

instancia   string   

Não pode ser superior a 255 caracteres.

modelo   string   

Não pode ser superior a 255 caracteres.

POST /services/{serviceId}/categories/{serviceCategoryId}/extra-informations

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

instancia   string   

Não pode ser superior a 255 caracteres.

modelo   string   

Não pode ser superior a 255 caracteres.

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

nome   string  opcional  
pai   string  opcional  

Não pode ser superior a 255 caracteres.

mae   string  opcional  

Não pode ser superior a 255 caracteres.

nascimento   string  opcional  

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

rg   string  opcional  

Não pode ser superior a 20 caracteres.

endereco   string  opcional  

Não pode ser superior a 500 caracteres.

naturalidade   string  opcional  

Não pode ser superior a 500 caracteres.

nacionalidade   string  opcional  

Não pode ser superior a 255 caracteres.

estado_civil   string  opcional  

Não pode ser superior a 255 caracteres.

instancia   string   

Não pode ser superior a 255 caracteres.

modelo   string   

Não pode ser superior a 255 caracteres.

comarca   string  opcional  

Não pode ser superior a 255 caracteres.

representante_legal   string  opcional  

Não pode ser superior a 255 caracteres.

orgao_expedidor_rg   string  opcional  

Não pode ser superior a 255 caracteres.

arquivos   string[]   

Um array com o caminho dos arquivos enviados no endpoint de upload: link

Federais => TRF - Certidão de Distribuição da Justiça Federal

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
regiao   string   
Deve ser um destes:
  • 1_regiao
  • 2_regiao
  • 3_regiao
  • 4_regiao
  • 5_regiao
  • 6_regiao

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
regiao   string   
Deve ser um destes:
  • 1_regiao
  • 2_regiao
  • 3_regiao
  • 4_regiao
  • 5_regiao
  • 6_regiao

POST /services/{serviceId}/categories/{serviceCategoryId}/extra-informations

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
regiao   string   
Deve ser um destes:
  • 1_regiao
  • 2_regiao
  • 3_regiao
  • 4_regiao
  • 5_regiao
  • 6_regiao

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

regiao   string   
Deve ser um destes:
  • 1_regiao
  • 2_regiao
  • 3_regiao
  • 4_regiao
  • 5_regiao
  • 6_regiao
orgao   string  opcional  

Obrigatório quando regiao é igual a 1_regiao, 3_regiao, ou 6_regiao.

.
tipo   string  opcional  

Obrigatório quando regiao é igual a 1_regiao, 3_regiao, 4_regiao, 5_regiao, ou 6_regiao.

.

Estaduais => Tribunal de Contas Estadual

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

Estaduais => TRT - Certidão de Ações Trabalhistas (CEAT)

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

regiao   string   

Não pode ser superior a 255 caracteres.

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

regiao   string   

Não pode ser superior a 255 caracteres.

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

regiao   string   

Não pode ser superior a 255 caracteres.

modelo   string  opcional  

Não pode ser superior a 255 caracteres.

Federais => TSE - Certidão de Quitação Eleitoral

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

nome   string   

Não pode ser superior a 255 caracteres.

pai   string  opcional  

Não pode ser superior a 255 caracteres.

mae   string  opcional  

Não pode ser superior a 255 caracteres.

nascimento   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

documento   string   

Deve ter pelo menos 11 caracteres. não pode ser superior a 12 caracteres.

Federais => TST - Certidão Negativa de Débitos Trabalhistas (CNDT)

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Bens Imóveis => Consulta Certificado de Cadastro do Imóvel Rural (CCIR)

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

Pessoas/Empresas => Consulta de Dados Cadastrais

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cpf   string   

Deve ser 11 caracteres.

nome   string   

Não pode ser superior a 255 caracteres.

Bens Imóveis => Pesquisa Cadastro Ambiental Rural (CAR)

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

car   string   

Deve atender a regex /\^[a-zA-Z][a-zA-Z]([a-zA-Z0-9]{39})\$/.

Bens Imóveis => Pesquisa de Bens

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string  opcional  

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   array  opcional  

As urls dos cartórios. Disponíveis podem ser obtidos em link

tipo   string   

POST /services/{serviceId}/categories/{serviceCategoryId}/extra-informations

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string  opcional  

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string[]   
tipo   string   
preferencia   string  opcional  
Deve ser um destes:
  • Informar somente imóveis que seja proprietário
  • Informar também imóveis já transferidos
data_base   string  opcional  

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

Pessoas/Empresas => Pesquisa de Casamento

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

conjuge1   string   

Não pode ser superior a 255 caracteres.

conjuge2   string   

Não pode ser superior a 255 caracteres.

casamento   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

cpf_algum_conjuges   string   

Deve ser 11 caracteres.

Débitos/Pendências => Pesquisa de Dívida Ativa - Procuradoria Geral do Estado

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

tipo   string   

POST /services/{serviceId}/categories/{serviceCategoryId}/extra-informations

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

tipo   string   
inscricao   string   

Pessoas/Empresas => Pesquisa de Empresa em Cartórios de Pessoa Jurídica

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

Bens Imóveis => Pesquisa de Escritura

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

Pessoas/Empresas => Pesquisa de Escritura de Divórcio

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cpf   string   

Deve ser 11 caracteres.

nome   string   

Não pode ser superior a 255 caracteres.

Pessoas/Empresas => Pesquisa de Indicadores de Atividade

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cnpj   string   

Deve ser 14 caracteres.

Bens Imóveis => Pesquisa de Inventário

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

Pessoas/Empresas => Pesquisa de KYC e Compliance

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cpf   string   

Deve ser 11 caracteres.

nome   string   

Não pode ser superior a 255 caracteres.

Débitos/Pendências => Pesquisa de Lista de Devedores PGFN

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

Pessoas/Empresas => Pesquisa de Nascimento

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cpf   string   

Deve ser 11 caracteres.

nome   string   

Não pode ser superior a 255 caracteres.

nascimento   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

mae   string   

Não pode ser superior a 255 caracteres.

pai   string  opcional  

Não pode ser superior a 255 caracteres.

Pessoas/Empresas => Pesquisa de Óbito

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   
Deve ser um destes:
  • simples
  • expandida
  • completa

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cpf   string   
tipo   string   
Deve ser um destes:
  • simples
  • expandida
  • completa

Pessoas/Empresas => Pesquisa de Participação Societária

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cpf   string   

Deve ser 11 caracteres.

nome   string   

Não pode ser superior a 255 caracteres.

nascimento   string  opcional  

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

Débitos/Pendências => Pesquisa de Processos Judiciais

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string  opcional  

Obrigatório quando numero_processo não está presente.

Deve ser um destes:
  • fisica
  • juridica
numero_processo   string  opcional  

Obrigatório quando tipo_pessoa não está presente. não pode ser superior a 50 caracteres.

cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string  opcional  

Obrigatório quando tipo_pessoa é igual a present. não pode ser superior a 255 caracteres.

.
pedido_origem_id   integer  opcional  

Pessoas/Empresas => Pesquisa de Procuração

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

Bens Móveis => Pesquisa de Propriedade de Aeronave

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

Bens Móveis => Pesquisa de Propriedade de Veículo

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nome   string   

Não pode ser superior a 255 caracteres.

Débitos/Pendências => Pesquisa de Protesto

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Bens Móveis => Pesquisa de Veículos

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   
Deve ser um destes:
  • leilao
  • pesquisa-completa
  • gravame

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   
Deve ser um destes:
  • leilao
  • pesquisa-completa
  • gravame
placa   string   

Pessoas/Empresas => Pesquisa em Juntas Comerciais

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

cnpj   string   
razao_social   string   

Não pode ser superior a 500 caracteres.

Pessoas/Empresas => Pesquisa SERASA

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.

Pessoas/Empresas => Receita Federal - CPF | CNPJ

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   
Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser 11 caracteres.

.
cnpj   string  opcional  

Obrigatório quando tipo_pessoa é igual a juridica. deve ser 14 caracteres.

.
nascimento   string  opcional  

Obrigatório quando tipo_pessoa é igual a fisica. deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

.

Pessoas/Empresas => SINTEGRA - Consulta Pública Ao Cadastro de Contribuinte do Governo

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   object   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   object   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string[]   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

cnpj   string   

Deve ser 14 caracteres.

Diligências => Acompanhamentos

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
tipo_processo   string   
Deve ser um destes:
  • digital
  • fisico
numero_processo   string  opcional  
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

Diligências => Ata Notarial

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

arquivos   string[]   

Diligências => Consultas

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
tipo_processo   string   
Deve ser um destes:
  • digital
  • fisico
numero_processo   string  opcional  
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

Diligências => Cópias

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
numero_processo   string  opcional  
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

Diligências => Guias

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
tipo_processo   string   
Deve ser um destes:
  • digital
  • fisico
numero_processo   string  opcional  
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

Diligências => Outras

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

arquivos   string[]   

Diligências => Prévia de Custas para Registros

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

descritivo_documento   string  opcional  

Diligências => Protocolos

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
tipo_processo   string   
Deve ser um destes:
  • digital
  • fisico
numero_processo   string  opcional  
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

Diligências => Registro de Imóveis

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

descritivo_documento   string  opcional  

Diligências => Requerimentos

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
tipo_processo   string   
Deve ser um destes:
  • digital
  • fisico
numero_processo   string  opcional  
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

Diligências => Retirada de Documentos

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
numero_processo   string  opcional  
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

Diligências => Serviços de Despachantes

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /services/{serviceId}/categories/{serviceCategoryId}/extras-prices-shipping-info

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

local_servico   string   
mensagem   string  opcional  

Não pode ser superior a 500 caracteres.

Inteligência artificial => Extração de Dados

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

arquivo   string   

Caminho do arquivo enviado no endpoint de upload: link

modelo_ia_id   integer   

O modelo de extração de dados desejado. Disponíveis podem ser obtidos em link

Registros => Ata Notarial - Lavratura em Tabelionato de Notas

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_servico   string   
Deve ser um destes:
  • diligencia-presencial-do-tabeliao
  • ja-possuo-as-evidencias

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

local_servico   string  opcional  

Obrigatório quando tipo_servico é igual a diligencia-presencial-do-tabeliao. não pode ser superior a 500 caracteres.

.
mensagem   string   

Não pode ser superior a 500 caracteres.

tipo_servico   string   
Deve ser um destes:
  • diligencia-presencial-do-tabeliao
  • ja-possuo-as-evidencias
arquivos   string[]   

Registros => RGI - Registro em Cartório de Imóveis

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

arquivos   object[]   

Um array com os arquivos

data_titulo   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d.

livro   string  opcional  

Não pode ser superior a 5 caracteres.

pagina   string  opcional  

Não pode ser superior a 3 caracteres.

assinantes   object[]  opcional  
partes   array  opcional  

Obrigatório quando tipo é igual a escritura-publica. Quando informado deve existir ao menos 1 outorgante e 1 outorgado.

.
tipo   string   
arquivos[].caminho_arquivo   string   

O caminho do arquivos enviado no endpoint de upload: link.

arquivos[].vai_registro   boolean   

Indica se o arquivo deve ser registrado.

arquivos[].requer_assinatura   boolean   

Indica se o arquivo requer assinatura.

assinantes[].cpf   string   
assinantes[].email   string   

Deve ser um endereço de e-mail válido.

assinantes[].nome   string   

Não pode ser superior a 255 caracteres.

partes[].documento   string   
partes[].email   string   

Deve ser um endereço de e-mail válido.

partes[].nome   string   

Não pode ser superior a 255 caracteres.

partes[].tipo   string   
Deve ser um destes:
  • outorgante
  • outorgado

Registros => RTD - Registro em Cartório de Títulos e Documentos

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

url_uf   string   

A url da unidade federativa. Disponíveis podem ser obtidos em link Ex: SP

url_cidade   string   

A url da cidade. Disponíveis podem ser obtidos em link Ex: SAO_PAULO

url_cartorio   string   

A url do cartório. Disponíveis podem ser obtidos em link Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

arquivos   object[]   

Um array com os arquivos

assinantes   object[]  opcional  

Quando informado deve conter ao menos 1 item.

arquivos[].caminho_arquivo   string   

O caminho do arquivos enviado no endpoint de upload: link.

arquivos[].vai_registro   boolean   

Indica se o arquivo deve ser registrado.

arquivos[].requer_assinatura   boolean   

Indica se o arquivo requer assinatura.

assinantes[].cpf   string   

Somente números.

assinantes[].email   string   

Deve ser um endereço de e-mail válido.

assinantes[].nome   string   

Não pode ser superior a 255 caracteres.

Coletar assinaturas e certificados => Assinaturas para Documentos

POST /services/{serviceId}/categories/{serviceCategoryId}/available-formats

tipo   string   

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   
arquivos   string[]   
assinantes   string   

Deve ter pelo menos 1 caracter.

assinantes[].cpf   string   
assinantes[].email   string   

Deve ser um endereço de e-mail válido.

assinantes[].nome   string   

Não pode ser superior a 255 caracteres.

Coletar assinaturas e certificados => Certificado Digital

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

cpf   string   

Deve ser 11 caracteres.

nome   string   

Não pode ser superior a 255 caracteres.

nascimento   string   

Deve ser uma data válida. Deve ser uma data válida no formato Y-m-d. deve ser uma data anterior ou igual a hoje.

tipo   string   
Deve ser um destes:
  • presencial
  • telepresencial
endereco   string  opcional  

Obrigatório quando tipo é igual a presencial. não pode ser superior a 255 caracteres.

.
email   string   

Deve ser um endereço de e-mail válido. não pode ser superior a 255 caracteres.

telefone   string   

Não pode ser superior a 15 caracteres.

Atualizar Documentos => Certidão de Casamento

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

arquivo   string   

Caminho do arquivo enviado no endpoint de upload: link

Atualizar Documentos => Certidão de Imóvel

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

arquivo   string   

Caminho do arquivo enviado no endpoint de upload: link

Atualizar Documentos => Certidão de Nascimento

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

arquivo   string   

Caminho do arquivo enviado no endpoint de upload: link

Atualizar Documentos => Certidão de Óbito

POST /services/{serviceId}/categories/{serviceCategoryId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

arquivo   string   

Caminho do arquivo enviado no endpoint de upload: link

Exemplos

Extração de dados

Abaixo encontra-se um resumo com os passos para utilizar a extração de dados através da API:


1) Obter um token através do endpoint de login

O primeiro passo é obter um token que será usado nas próximas requisições.

O token é necessário para identificar o usuário que está fazendo a requisição para API e é necessário em praticamente todos os endpoints da API.


Mais informações sobre a obtenção do token podem ser encontradas no link

2) Obter o ID do modelo que será utilizado

Um modelo de extração de dados define as informações que serão extraídas do documento enviado.

Para identificar o modelo que será usado na extração é utilizado o ID do modelo.

O ID do modelo pode ser obtido chamando o endpoint de listagem de modelos, link

Caso você ainda não possua um modelo cadastrado, é possível criá-lo pela interface da aplicação, no app.cbrdoc.com.br ou através da API.


Mais informações sobre a criação do modelo pela API podem ser encontradas no link

3) Fazer o upload dos arquivos que deseja a extração de dados

Antes de efetuar a compra você vai enviar os arquivos que deseja extrair os dados.

Você pode enviar um ou múltiplos arquivos de uma vez. Guarde os caminhos retornados na reposta da chamada, eles serão usados para fechar a compra.


Mais informações sobre o envio dos arquivos podem ser encontradas no link

4) Fechar a compra

O próximo passo é efetivamente fechar a compra.

Como está detalhado na documentação da compra, no link, o campo detailed_service_data de cada objeto do array de orders varia conforme o serviço utilizado. Para facilitar a compreensão, abaixo é fornecido um exemplo de payload para uma compra do serviço de extração de dados. 


// endpoint => POST https://api2.cbrdoc.com.br/purchases
{
    "name": "Nome do meu carrinho de compras",
    "groups_ids": [],
    "post_payment": false, // Fixo false se sua conta é pós paga através de contrato
    "orders": [
        {
            "name": "Minha certidão de nascimento", // Nome deste item do carrinho
            "detailed_service_data": {
                "modelo_ia_id": 999, // O ID do modelo obtido no passo 2
                "arquivo": "1234/yKAwE5FKrHTi5VtF1Zt5hOvG8MtRD4pxrNWrMrCC.pdf", // Caminho do arquivo obtido no passo 3
                "formato": "email" // fixo
            },
            "service_id": 96, // fixo
            "service_category_id": 24 // fixo
        }
        // caso deseje inserir mais itens no seu carrinho, você pode adicionar mais objetos no array de "orders"
    ]
}

O retorno será nesse formato: 

{
    "name": "Nome do meu carrinho de compras",
    ...outros dados da compra,
    "orders": [
        {
            "id": 12345, //ID interno usado na API, usado nos endpoints,
            "backoffice_code": 2089414, // código de identificação do item da compra apresentado na interface e usado para comunicação com o atendimento,
            "name": "Minha certidão de nascimento",
            ...outros dados do item da compra
        }
    ]
}

Para acompanhar o andamento do seu pedido basta fazer uma chamada para o endpoint de visualização de item de compra, detalhes no link. Se o status estiver finished os dados extraídos estarão disponíveis em explorer_item.ai_data.questions. 

// endpoint => GET https://api2.cbrdoc.com.br/orders/12345?append[]=explorer_item.ai_data

Retorno:
{
    "status": "finished",
    "explorer_item": {
        "ai_data": {
            "questions": [
                {
                    "question": "Pergunta 1 do meu modelo",
                    "label_show_user": "Pergunta 1",
                    "order": 0,
                    "formatted_response": "Resposta da pergunta 1"
                },
                {
                    "question": "Pergunta 2 do meu modelo",
                    "label_show_user": "Pergunta 2",
                    "order": 1,
                    "formatted_response": "Resposta da pergunta 2"
                }
            ]
        }
    },
    ...outros dados do item da compra
}

Também é possível configurar um webhook que é chamado sempre que um item de compra sofrer alteração de status. Para isso o endpoint no seu servidor precisa ser público e deve ser enviado para nossa equipe a URL que deverá ser chamada. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima.

RTD - Registro em Cartório de Títulos e Documentos

Abaixo encontra-se um resumo com os passos para utilizar o RTD - Registro em Cartório de Títulos e Documentos através da API:

*Disponível apenas para clientes pós pagos com contrato

1) Obter um token através do endpoint de login

O primeiro passo é obter um token que será usado nas próximas requisições.

O token é necessário para identificar o usuário que está fazendo a requisição para API e é necessário em praticamente todos os endpoints da API.


Mais informações sobre a obtenção do token podem ser encontradas no link

2) Fazer o upload dos arquivos que são necessários para o registro

Antes de efetuar a compra você vai enviar os arquivos que são necessários para o registro.

Você pode enviar um ou múltiplos arquivos de uma vez. Guarde os caminhos retornados na reposta da chamada, eles serão usados para fechar a compra.


Mais informações sobre o envio dos arquivos podem ser encontradas no link

4) Fechar a compra

O próximo passo é efetivamente fechar a compra.

Como está detalhado na documentação da compra, no link, o campo detailed_service_data de cada objeto do array de orders varia conforme o serviço utilizado. Para facilitar a compreensão, abaixo é fornecido um exemplo de payload para uma compra do serviço de RTD - Registro em Cartório de Títulos e Documentos. 


// endpoint => POST https://api2.cbrdoc.com.br/purchases
{
    "name": "Nome do meu carrinho de compras",
    "groups_ids": [],
    "post_payment": false, // Fixo false se sua conta é pós paga através de contrato
    "orders": [
        {
            // esse item é um exemplo de fluxo sem assinaturas
            "name": "Meu registro sem assinaturas", // Nome deste item do carrinho
            "detailed_service_data": {
                "url_uf": "AL",
                "url_cidade": "ARAPIRACA",
                "url_cartorio": "alagoas-servicos-do-1-oficio-registro-de-imoveis-centro-arapiraca",
                "formato": "email", // fixo
                 "arquivos": [ // é possível enviar múltiplos arquivos e definir quais vão para registro e quais são apenas complementares
                    {
                        "caminho_arquivo": "18146/LUyoPV1Rd1Qrz1Hmu1WkEfFzQFomdYHi0TLru0Zs.pdf", // Caminho do arquivo obtido no passo 2
                        "requer_assinatura": true,
                        "vai_registro": true
                    },
                    {
                        "caminho_arquivo": "18146/wlJc3bXHjoBnjysfCAN3zpDQVQJXKCCVP7OnpuYn.pdf", // Caminho do arquivo obtido no passo 2
                        "requer_assinatura": false,
                        "vai_registro": false
                    }
                ]
            },
            "service_id": 102, // fixo para esse serviço
            "service_category_id": 25 // fixo para registros
        },
        {
            // esse item é um exemplo de fluxo com assinaturas
            "name": "Meu registro com assinaturas", // Nome deste item do carrinho
            "detailed_service_data": {
                "url_uf": "AL",
                "url_cidade": "ARAPIRACA",
                "url_cartorio": "alagoas-servicos-do-1-oficio-registro-de-imoveis-centro-arapiraca",
                "formato": "email", // fixo
                "assinantes": [
                    {
                        "cpf": "59151167794",
                        "email": "emaildapessoaquevaiassinar@teste.com",
                        "nome": "Nome da pessoa que vai assinar"
                    }
                    // caso deseje mais assinantes basta adicionar novos objetos no mesmo formato dentro do array "assinantes"
                ]
                "arquivos": [ // é possível enviar múltiplos arquivos e definir quais vão para registro e quais são apenas complementares
                    {
                        "caminho_arquivo": "18146/LUyoPV1Rd1Qrz1Hmu1WkEfFzQFomdYHi0TLru0Zs.pdf", // Caminho do arquivo obtido no passo 2
                        "requer_assinatura": true,
                        "vai_registro": true
                    }
                ]
            },
            "service_id": 102, // fixo
            "service_category_id": 25 // fixo para registros
        }
        // caso deseje inserir mais itens no seu carrinho, você pode adicionar mais objetos no array de "orders". Podem ser de outros serviços.
    ]
}

O retorno será nesse formato: 

{
    "name": "Nome do meu carrinho de compras",
    ...outros dados da compra,
    "orders": [
        {
            "id": 12345, //ID interno usado na API, usado nos endpoints
            "backoffice_code": 2089414, // código de identificação do item da compra apresentado na interface e usado para comunicação com o atendimento
            "name": "Meu registro sem assinaturas",
            ...outros dados do item da compra
        },
        {
            "id": 12346, //ID interno usado na API, usado nos endpoints
            "backoffice_code": 2089415, // código de identificação do item da compra apresentado na interface e usado para comunicação com o atendimento
            "name": "Meu registro com assinaturas",
            ...outros dados do item da compra
        }
    ]
}

Para acompanhar o andamento do seu pedido basta fazer uma chamada para o endpoint de visualização de item de compra, detalhes no link. 

// endpoint => GET https://api2.cbrdoc.com.br/orders/12345

Retorno:
{
    "status": "finished",
    ...outros dados do item da compra
}

Também é possível configurar um webhook que é chamado sempre que um item de compra sofrer alteração de status. Para isso o endpoint no seu servidor precisa ser público e deve ser enviado para nossa equipe a URL que deverá ser chamada. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima.

RGI - Registro em Cartório de Imóveis

Abaixo encontra-se um resumo com os passos para utilizar o RGI - Registro em Cartório de Imóveis através da API:

*Disponível apenas para clientes pós pagos com contrato

1) Obter um token através do endpoint de login

O primeiro passo é obter um token que será usado nas próximas requisições.

O token é necessário para identificar o usuário que está fazendo a requisição para API e é necessário em praticamente todos os endpoints da API.


Mais informações sobre a obtenção do token podem ser encontradas no link

2) Fazer o upload dos arquivos que são necessários para o registro

Antes de efetuar a compra você vai enviar os arquivos que são necessários para o registro.

Você pode enviar um ou múltiplos arquivos de uma vez. Guarde os caminhos retornados na reposta da chamada, eles serão usados para fechar a compra.


Mais informações sobre o envio dos arquivos podem ser encontradas no link

4) Fechar a compra

O próximo passo é efetivamente fechar a compra.

Como está detalhado na documentação da compra, no link, o campo detailed_service_data de cada objeto do array de orders varia conforme o serviço utilizado.

Alguns campos possuem valores dinâmicos e os valores disponíveis devem ser consultados no endpoint de informações extras link. Um exemplo, é o campo tipo. Chamando o endpoint de informações extras: POST https://api2.cbrdoc.com.br/services/104/categories/25/extra-informations você vai receber um array com as informações extras deste serviço, algo nesse formato: 


{
    "tipos": [
        {
            "name": "Escritura pública",
            "url": "escritura-publica"
        },
        {
            "name": "Instrumento particular",
            "url": "instrumento-particular"
        },
        {
            "name": "Instrumento particular com força de Escritura Pública",
            "url": "instrumento-particular-com-forca-de-escritura-publica"
        },
        {
            "name": "Ordens Judiciais e Administrativas",
            "url": "ordens-judiciais-e-administrativas"
        },
        {
            "name": "Instrumento Particular de Cancelamento de Garantias",
            "url": "instrumento-particular-de-cancelamento-de-garantias"
        },
        {
            "name": "Requerimento averbação",
            "url": "requerimento-averbacao"
        },
        {
            "name": "Parcelamento do Solo/Loteamento",
            "url": "parcelamento-do-solo-loteamento"
        },
        {
            "name": "Incorporação/Especificação",
            "url": "incorporacao-especificacao"
        },
        {
            "name": "Retificação administrativa",
            "url": "retificacao-administrativa"
        },
        {
            "name": "Usucapião Extrajudicial e Judicial",
            "url": "usucapiao-extrajudicial-e-judicial"
        },
        {
            "name": "Reurb",
            "url": "reurb"
        }
    ]
}

Para facilitar a compreensão, abaixo é fornecido um exemplo de payload para uma compra do serviço de RGI - Registro em Cartório de Imóveis. 


// endpoint => POST https://api2.cbrdoc.com.br/purchases
{
    "name": "Nome do meu carrinho de compras",
    "groups_ids": [],
    "post_payment": false, // Fixo false se sua conta é pós paga através de contrato
    "orders": [
        {
            // esse item é um exemplo do tipo escritura
            "name": "Meu registro de escritura", // Nome deste item do carrinho
            "detailed_service_data": {
                "tipo": "escritura-publica",
                "livro": "1",
                "pagina": "2",
                "data_titulo": "2025-01-08",
                "url_uf": "AP",
                "url_cidade": "MACAPA",
                "url_cartorio": "2-registro-de-imoveis-trem-macapa",
                "formato": "email",
                "arquivos": [ // é possível enviar múltiplos arquivos e definir quais vão para registro e quais são apenas complementares
                    {
                        "caminho_arquivo": "18146/LUyoPV1Rd1Qrz1Hmu1WkEfFzQFomdYHi0TLru0Zs.pdf", // Caminho do arquivo obtido no passo 2
                        "requer_assinatura": true,
                        "vai_registro": true
                    },
                    {
                        "caminho_arquivo": "18146/wlJc3bXHjoBnjysfCAN3zpDQVQJXKCCVP7OnpuYn.pdf", // Caminho do arquivo obtido no passo 2
                        "requer_assinatura": false,
                        "vai_registro": false
                    }
                ]
                "partes": [ // necessário apenas em escrituras públicas
                    {
                        "nome": "Nome do outorgante",
                        "documento": "57408174800",
                        "email": "emailoutorgante@teste.com",
                        "tipo": "outorgante" // obrigatório ao menos 1 para o tipo escritura
                    },
                    {
                        "nome": "Nome do outorgado",
                        "documento": "22787854000100",
                        "email": "emailoutorgado@teste.com",
                        "tipo": "outorgado" // obrigatório ao menos 1 para o tipo escritura
                    }
                ],
                "assinantes": [ // necessário apenas em fluxos com assinatura
                    {
                        "cpf": "57408174800",
                        "email": "emailpessoavaiassinar@teste.com",
                        "nome": "Nome da pessoa que vai assinar"
                    },
                    {
                        "cpf": "95530405274",
                        "email": "emailpessoavaiassinar2@teste.com",
                        "nome": "Nome da pessoa que vai assinar 2"
                    }
                    // caso deseje mais assinantes basta adicionar novos objetos no mesmo formato dentro do array "assinantes"
                ]
            },
            "service_id": 104, // fixo para esse serviço
            "service_category_id": 25 // fixo para registros
        },
        {
            // esse item é um exemplo de instrumento particular
            "name": "Meu registro de instrumento particular", // Nome deste item do carrinho
            "detailed_service_data": {
                "tipo": "instrumento-particular",
                "livro": "2",
                "pagina": "3",
                "data_titulo": "2025-01-01",
                "url_uf": "CE",
                "url_cidade": "ACARAPE",
                "url_cartorio": "cartorio-de-notas-centro-acarape",
                "formato": "email",
                "arquivos": [ // é possível enviar múltiplos arquivos e definir quais vão para registro e quais são apenas complementares
                    {
                        "caminho_arquivo": "18146/LUyoPV1Rd1Qrz1Hmu1WkEfFzQFomdYHi0TLru0Zs.pdf", // Caminho do arquivo obtido no passo 2
                        "requer_assinatura": true,
                        "vai_registro": true
                    }
                ]
            },
            "service_id": 104, // fixo
            "service_category_id": 25 // fixo para registros
        }
        // caso deseje inserir mais itens no seu carrinho, você pode adicionar mais objetos no array de "orders". Podem ser de outros serviços.
    ]
}

O retorno será nesse formato: 

{
    "name": "Nome do meu carrinho de compras",
    ...outros dados da compra,
    "orders": [
        {
            "id": 12345, //ID interno usado na API, usado nos endpoints
            "backoffice_code": 2089414, // código de identificação do item da compra apresentado na interface e usado para comunicação com o atendimento
            "name": "Meu registro de escritura",
            ...outros dados do item da compra
        },
        {
            "id": 12346, //ID interno usado na API, usado nos endpoints
            "backoffice_code": 2089415, // código de identificação do item da compra apresentado na interface e usado para comunicação com o atendimento
            "name": "Meu registro de instrumento particular",
            ...outros dados do item da compra
        }
    ]
}

Para acompanhar o andamento do seu pedido basta fazer uma chamada para o endpoint de visualização de item de compra, detalhes no link. 

// endpoint => GET https://api2.cbrdoc.com.br/orders/12345

Retorno:
{
    "status": "finished",
    ...outros dados do item da compra
}

Também é possível configurar um webhook que é chamado sempre que um item de compra sofrer alteração de status. Para isso o endpoint no seu servidor precisa ser público e deve ser enviado para nossa equipe a URL que deverá ser chamada. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima.

Pesquisa de bens

Abaixo encontra-se um resumo com os passos para utilizar serviço de pesquisa de bens através da API:


1) Obter um token através do endpoint de login

O primeiro passo é obter um token que será usado nas próximas requisições.

O token é necessário para identificar o usuário que está fazendo a requisição para API e é necessário em praticamente todos os endpoints da API.


Mais informações sobre a obtenção do token podem ser encontradas no link

2) Fechar a compra

O próximo passo é efetivamente fechar a compra.

Como está detalhado na documentação da compra, no link, o campo detailed_service_data de cada objeto do array de orders varia conforme o serviço utilizado. Os campos de pesquisa de bens podem ser vistos em link.

Alguns campos possuem valores dinâmicos e os valores disponíveis devem ser consultados no endpoint de informações extras link. Um exemplo, é o campo tipo. Chamando o endpoint de informações extras: POST https://api2.cbrdoc.com.br/services/9/categories/14/extra-informations você vai receber um array com as informações extras deste serviço, algo nesse formato: 

    
    {
        "tipos": [
            "completa",
            "simpels
        ]
    }

Para facilitar a compreensão, abaixo é fornecido um exemplo de payload para uma compra do serviço de pesquisa de bens: 


// endpoint => POST https://api2.cbrdoc.com.br/purchases
{
    "name": "Nome do meu carrinho de compras",
    "groups_ids": [],
    "post_payment": false, // Fixo false se sua conta é pós paga através de contrato
    "orders": [
        {
            "name": "Nome da minha pesquisa de bens - CPF 589.3841.866-002",
            "auto_purchase_certificate_from_result_positive": false,
            "auto_purchase_certificate_from_result_negative": false,
            "detailed_service_data": {
                "cpf": "58984186600",
                "nome": "João da Silva",
                "preferencia": "Informar somente imóveis que seja proprietário", // Opções: Informar somente imóveis que seja proprietário ou Informar também imóveis já transferidos
                "data_base": "2000-10-10",
                "formato": "email",
                "tipo": "completa",
                "tipo_pessoa": "fisica",
                "url_uf": "PR",
                "url_cidade": "ALMIRANTE_TAMANDARE",
                "url_cartorio": [
                    "servico-de-registro-de-imoveis-centro-almirante-tamandare"
                ]
            },
            "service_id": 9,
            "service_category_id": 14
        }
        // caso deseje inserir mais itens no seu carrinho, você pode adicionar mais objetos no array de "orders". Podem ser de outros serviços.
    ]
}

O retorno será nesse formato: 

{
    "name": "Nome do meu carrinho de compras",
    ...outros dados da compra,
    "orders": [
        {
            "id": 12345, //ID interno usado na API, usado nos endpoints
            "backoffice_code": 2089414, // código de identificação do item da compra apresentado na interface e usado para comunicação com o atendimento
            "name": "Nome da minha pesquisa de bens - CPF 589.3841.866-002",
            ...outros dados do item da compra
        }
    ]
}

Para acompanhar o andamento do seu pedido basta fazer uma chamada para o endpoint de visualização de item de compra, detalhes no link. 

// endpoint => GET https://api2.cbrdoc.com.br/orders/12345

Retorno:
{
    "status": "finished",
    ...outros dados do item da compra
}

Também é possível configurar um webhook que é chamado sempre que um item de compra sofrer alteração de status. Para isso o endpoint no seu servidor precisa ser público e deve ser enviado para nossa equipe a URL que deverá ser chamada. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima.

Certidão de junta comercial

Abaixo encontra-se um resumo com os passos para utilizar serviço de certidão de junta comercial através da API:


1) Obter um token através do endpoint de login

O primeiro passo é obter um token que será usado nas próximas requisições.

O token é necessário para identificar o usuário que está fazendo a requisição para API e é necessário em praticamente todos os endpoints da API.


Mais informações sobre a obtenção do token podem ser encontradas no link

2) Fechar a compra

O próximo passo é efetivamente fechar a compra.

Como está detalhado na documentação da compra, no link, o campo detailed_service_data de cada objeto do array de orders varia conforme o serviço utilizado. Os campos de certidão de junta comercial podem ser vistos em link.

Alguns campos possuem valores dinâmicos e os valores disponíveis devem ser consultados no endpoint de informações extras link. Um exemplo, é o campo tipo. Chamando o endpoint de informações extras: POST https://api2.cbrdoc.com.br/services/14/categories/9/extra-informations você vai receber um array com as informações extras deste serviço, algo nesse formato: 

    
    {
        "tipos": [
            "simples",
            "inteiroteor"
        ]
    }

Para facilitar a compreensão, abaixo é fornecido um exemplo de payload para uma compra do serviço de certidão de junta comercial: 


// endpoint => POST https://api2.cbrdoc.com.br/purchases
{
    "name": "Nome do meu carrinho de compras",
    "groups_ids": [],
    "post_payment": false, // Fixo false se sua conta é pós paga através de contrato
    "orders": [
        {
            "name": "Nome da minha certidão de junta comercial - CNPJ 73.438.512/0001-08",
            "auto_purchase_certificate_from_result_positive": false,
            "auto_purchase_certificate_from_result_negative": false,
            "detailed_service_data": {
                "cnpj": "73438512000108",
                "razao_social": "Acme Inc.", // opcional
                "tipo": "simples",
                "url_uf": "PR",
                "formato": "email"
            },
            "service_id": 14,
            "service_category_id": 9
        }
        // caso deseje inserir mais itens no seu carrinho, você pode adicionar mais objetos no array de "orders". Podem ser de outros serviços.
    ]
}

O retorno será nesse formato: 

{
    "name": "Nome do meu carrinho de compras",
    ...outros dados da compra,
    "orders": [
        {
            "id": 12345, //ID interno usado na API, usado nos endpoints
            "backoffice_code": 2089414, // código de identificação do item da compra apresentado na interface e usado para comunicação com o atendimento
            "name": "Nome da minha certidão de junta comercial - CNPJ 73.438.512/0001-08",
            ...outros dados do item da compra
        }
    ]
}

Para acompanhar o andamento do seu pedido basta fazer uma chamada para o endpoint de visualização de item de compra, detalhes no link. 

// endpoint => GET https://api2.cbrdoc.com.br/orders/12345

Retorno:
{
    "status": "finished",
    ...outros dados do item da compra
}

Também é possível configurar um webhook que é chamado sempre que um item de compra sofrer alteração de status. Para isso o endpoint no seu servidor precisa ser público e deve ser enviado para nossa equipe a URL que deverá ser chamada. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima.

Certidão de prévia de matrícula

Abaixo encontra-se um resumo com os passos para utilizar serviço de certidão de prévia de matrícula através da API:


1) Obter um token através do endpoint de login

O primeiro passo é obter um token que será usado nas próximas requisições.

O token é necessário para identificar o usuário que está fazendo a requisição para API e é necessário em praticamente todos os endpoints da API.


Mais informações sobre a obtenção do token podem ser encontradas no link

2) Fechar a compra

O próximo passo é efetivamente fechar a compra.

Como está detalhado na documentação da compra, no link, o campo detailed_service_data de cada objeto do array de orders varia conforme o serviço utilizado. Os campos de certidão de prévia de matrícula podem ser vistos em link.

Para facilitar a compreensão, abaixo é fornecido um exemplo de payload para uma compra do serviço de certidão de prévia de matrícula: 


// endpoint => POST https://api2.cbrdoc.com.br/purchases
{
    "name": "Minha compra",
    "groups_ids": [],
    "post_payment": false, // Fixo false se sua conta é pós paga através de contrato
    "orders": [
        {
            "name": "Minha prévia de matrícula - Matrícula 1234",
            "auto_purchase_certificate_from_result_positive": false,
            "auto_purchase_certificate_from_result_negative": false,
            "detailed_service_data": {
                "matricula": "1234",
                "formato": "email",
                "url_uf": "PR",
                "url_cidade": "ALMIRANTE_TAMANDARE",
                "url_cartorio": "servico-de-registro-de-imoveis-centro-almirante-tamandare"
            },
            "service_id": 55,
            "service_category_id": 2
        }
    ]
}

O retorno será nesse formato: 

{
    "name": "Nome do meu carrinho de compras",
    ...outros dados da compra,
    "orders": [
        {
            "id": 12345, //ID interno usado na API, usado nos endpoints
            "backoffice_code": 2089414, // código de identificação do item da compra apresentado na interface e usado para comunicação com o atendimento
            "name": "Minha prévia de matrícula - Matrícula 1234",
            ...outros dados do item da compra
        }
    ]
}

Para acompanhar o andamento do seu pedido basta fazer uma chamada para o endpoint de visualização de item de compra, detalhes no link. 

// endpoint => GET https://api2.cbrdoc.com.br/orders/12345

Retorno:
{
    "status": "finished",
    ...outros dados do item da compra
}

Também é possível configurar um webhook que é chamado sempre que um item de compra sofrer alteração de status. Para isso o endpoint no seu servidor precisa ser público e deve ser enviado para nossa equipe a URL que deverá ser chamada. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima.

SEFAZ - Certidão Negativa de Débitos Tributários Estaduais (CND Estadual)

Abaixo encontra-se um resumo com os passos para utilizar serviço de SEFAZ - Certidão Negativa de Débitos Tributários Estaduais (CND Estadual) através da API:


1) Obter um token através do endpoint de login

O primeiro passo é obter um token que será usado nas próximas requisições.

O token é necessário para identificar o usuário que está fazendo a requisição para API e é necessário em praticamente todos os endpoints da API.


Mais informações sobre a obtenção do token podem ser encontradas no link

2) Fechar a compra

O próximo passo é efetivamente fechar a compra.

Como está detalhado na documentação da compra, no link, o campo detailed_service_data de cada objeto do array de orders varia conforme o serviço utilizado. Os campos de SEFAZ - Certidão Negativa de Débitos Tributários Estaduais (CND Estadual) podem ser vistos em link.

Para facilitar a compreensão, abaixo é fornecido um exemplo de payload para uma compra do serviço de SEFAZ - Certidão Negativa de Débitos Tributários Estaduais (CND Estadual): 


// endpoint => POST https://api2.cbrdoc.com.br/purchases
{
    "name": "Nome do meu carrinho de compras",
    "groups_ids": [],
    "post_payment": false, // Fixo false se sua conta é pós paga através de contrato
    "orders": [
        {
            "name": "Nome da minha certidão - Sefaz CND Estadual - CNPJ 73.438.512/0001-08",
            "auto_purchase_certificate_from_result_positive": false,
            "auto_purchase_certificate_from_result_negative": false,
            "detailed_service_data": {
                "tipo_pessoa": "juridica",
                "cnpj": "73438512000108",
                "nome": "Acme Inc.",
                "url_uf": "PR",
                "formato": "email"
            },
            "service_id": 22,
            "service_category_id": 9
        }
        // caso deseje inserir mais itens no seu carrinho, você pode adicionar mais objetos no array de "orders". Podem ser de outros serviços.
    ]
}

O retorno será nesse formato: 

{
    "name": "Nome do meu carrinho de compras",
    ...outros dados da compra,
    "orders": [
        {
            "id": 12345, //ID interno usado na API, usado nos endpoints
            "backoffice_code": 2089414, // código de identificação do item da compra apresentado na interface e usado para comunicação com o atendimento
            "name": "Nome da minha SEFAZ - Certidão Negativa de Débitos Tributários Estaduais (CND Estadual) - CNPJ 73.438.512/0001-08",
            ...outros dados do item da compra
        }
    ]
}

Para acompanhar o andamento do seu pedido basta fazer uma chamada para o endpoint de visualização de item de compra, detalhes no link. 

// endpoint => GET https://api2.cbrdoc.com.br/orders/12345

Retorno:
{
    "status": "finished",
    ...outros dados do item da compra
}

Também é possível configurar um webhook que é chamado sempre que um item de compra sofrer alteração de status. Para isso o endpoint no seu servidor precisa ser público e deve ser enviado para nossa equipe a URL que deverá ser chamada. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima.